Telgoo5 APIs

GetCarrierCode

This XML API returns the list of the available carrier code and plan code for the provides carrier.

End Point	https://www.vcareapi.com/vcareOssApi/GetCarrierCode/
Field (Short Description)	Value/Tag Name	Format	Field Example	Type	Notes	Validation rules
VENDOR ID		string	Vcarecorporation	Required	A unique Vendor ID is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
USER NAME		string	Vcarecorporation	Required	A unique User name is associated with the MVNO/OSS partner. This is used for authorization purpose and can be obtained by contacting your account manager.
PASSWORD		string	Vcarecorporation	Required	This is a random string which is generated by Vcare and is tied to the MVNO/OSS user name. This is specifically used for authentication purpose and can be obtained by contacting your account manager.
PIN		string	123456789	Required	This is generated by Vcare to provide an additional layer of security in the Interim API. This is used for authentication purpose and can be obtained by contacting your account manager.
REFERENCENUMBER		string	123456789	Required	Auto generated unique reference number is required to be passed with each transaction.
STATE		string	MD	Required	Plans in Telgoo5 is configured by state. This is the state for the plan you would like to check.	State should be standard abbreviated form.
TYPE		string	LIFELINE	Required	Type determines the type of plan to be returned. If type is 'LIFELINE' then it will return the lifeline plans available on the supplied state and zip code. If type is 'NONLIFELINE' then it will return the list of all the prepaid plans available on the zip code. and if type is 'TRADITIONAL' then it will return the list of all the traditional plans available on the zip code. Traditional Plans are the plans which are similar to the NONLIFELINE/PREPAID plans these plans are used to switch the lifeline customer to nonlifeline status in case they no longer qualify for the lifeline services.	This can be either of the following: LIFELINE NONLIFELINE TRADITIONAL
CARRIER		string	TMB	Optional	This is the carrier id and is returned in the Devicelookup API in the <carrier> parameter
TRIBAL		string	Y	Optional	This checks the service availibility. When TYPE = NONLIFELINE, you may pass N.	Values that could be passed in this parameter are 'Y' and 'N'.
AGENTID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENTPASSWORD		string	John Doe	Conditional	This is the password for the Agent Id mentioned above. This is configuration level field. If you have set the permissions for the Agent Id for the requirement of the password in API transactions then you will need to pass the Agent Password in all the XML API transaction, else if you have set the permissions to password not required then you don't need to pass the Agent Password in the XML API.
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE

Sample Request XML

<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<GETCARRIERCODE>
	<STATE></STATE>
	<TYPE></TYPE>
	<TRIBAL></TRIBAL>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</GETCARRIERCODE>
</VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
22	Plan not found.	Provide a valid plan available in system
41	Carrier is invalid.	Please provide valid Carrier.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
517	State Code is required.	Provide correct State Code. A valid State code is required.
730	Type should not be blank.	Type can not be blank. You should enter a valid Type.
731	Type should be lifeline OR nonlifeline OR traditional.	Provide a correct Type. Type should be lifeline or nonlifeline or traditional.

Sample Response

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    <credentials>
        <vendorId>Vcarecorporation</vendorId>
        <referenceNumber>432342332423</referenceNumber>
    </credentials>
    <GetCarrierCode>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
		<planDetail>
			<planName></planName>
			<planID></planID>
			<planPrice></planPrice>
			<talk></talk>
			<text></text>
			<data></data>
			<carrier_code></carrier_code>
			<carrier></carrier>
			<PlanServiceType></PlanServiceType>
		</planDetail>
		<planDetail>
			<planName></planName>
			<planID></planID>
			<planPrice></planPrice>
			<talk></talk>
			<text></text>
			<data></data>
			<carrier_code></carrier_code>
			<carrier></carrier>
			<PlanServiceType></PlanServiceType>
		</planDetail>
    </GetCarrierCode>
</VcareOssApi>

SUCCESS

Sample Fail Response: 1

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

Sample Fail Response: 2

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

Sample Fail Response: 3

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>22</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan not found.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Plan not found.

How to Resolve?: Provide a valid plan available in system

Sample Fail Response: 4

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Carrier is invalid.

How to Resolve?: Please provide valid Carrier.

Sample Fail Response: 5

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

Sample Fail Response: 6

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

Sample Fail Response: 7

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>517</statusCode>
	<description>FAIL</description>
	<errorDescription>State Code is required.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: State Code is required.

How to Resolve?: Provide correct State Code. A valid State code is required.

Sample Fail Response: 8

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>730</statusCode>
	<description>FAIL</description>
	<errorDescription>Type should not be blank.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Type should not be blank.

How to Resolve?: Type can not be blank. You should enter a valid Type.

Sample Fail Response: 9

<?xml version="1.0" encoding="utf-8"?>
<VcareOssApi xmlns="http://www.oss.vcarecorporation.com/oss" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<credentials>
	<vendorId>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<GetCarrierCode>
	<statusCode>731</statusCode>
	<description>FAIL</description>
	<errorDescription>Type should be lifeline OR nonlifeline OR traditional.</errorDescription>
</GetCarrierCode>
</VcareOssApi>

Error Description: Type should be lifeline OR nonlifeline OR traditional.

How to Resolve?: Provide a correct Type. Type should be lifeline or nonlifeline or traditional.