Telgoo5 APIs

GetPlansList

This XML API returns the list of the available plans for the changeplan on customer's account

End Point	https://www.vcareapi.com/vcareOssApi/GetPlansList/
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	The state in which subscriber belongs to	State should be standard abbreviated form.
ACCOUNTTYPE		string	GA	Optional	Type determines the type of plan to be returned. If type is 'GA' then it will return the lifeline plans available on the supplied state and zip code. If type is 'NL' then it will return the list of all the prepaid plans available on the zip code. Traditional Plans are the plans which are similar to the NL/GA 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: ′GA′ ′NL′
ISTRIBAL		string	Y	Optional	This determines if the plan which needs to be returned should be Tribal or Non tribal plans	Y OR N
SERVICE TYPE		string	LIFELINE, EBB and COMBO	Required	This determines the type of service type. Service type should be LIFELINE,EBB and COMBO.	Default value LIFELINE
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE
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.

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>Vcarecorporation</VENDORID>
<USERNAME>Vcarecorporation</USERNAME>
<PASSWORD>Vcarecorporation</PASSWORD>
<PIN>Vcarecorporation</PIN>
<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
  <GETPLANSLIST>
	<STATE>OK</STATE>
	<ACCOUNTTYPE>GA</ACCOUNTTYPE>
	<ISTRIBAL></ISTRIBAL>
	<SERVICETYPE></SERVICETYPE>
	<AGENTID>Zeeshan Ahmed</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
 </GETPLANSLIST>
</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.
118	State is required.	State cannot be blank. You should enter a valid State.
119	Invalid Format! Only characters are allowed in State.	Please provide a valid Format in State.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
404	Plan ID should be of same State.	Plan id should be of same state
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.

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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <GetPlansList>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <plans>
            <planid></planid>
            <planamount></planamount>
            <bill_to_customer></bill_to_customer>
            <planname></planname>
            <plan_description></plan_description>
            <service_allowed></service_allowed>
            <plan_code></plan_code>
            <carrier_list>
                <carrier></carrier>
            </carrier_list>
            <planIStribal></planIStribal>
            <wcct_additional_amt></wcct_additional_amt>
            <plan_type></plan_type>
            <service_type></service_type>
            <talk></talk>
            <text></text>
            <data></data>
            <service_name></service_name>
            <service_amt></service_amt>
            <service_allow></service_allow>
            <activation_fee></activation_fee>
			<is_unlimited_plan>Y</is_unlimited_plan>
			<data_unlimited>Y</data_unlimited>
			<text_unlimited>N</text_unlimited>
			<minute_unlimited>N</minute_unlimited>
        </plans>
         <plans>
            <planid></planid>
            <planamount></planamount>
            <bill_to_customer></bill_to_customer>
            <planname></planname>
            <plan_description></plan_description>
            <service_allowed></service_allowed>
            <plan_code></plan_code>
            <carrier_list>
                <carrier></carrier>
            </carrier_list>
            <planIStribal></planIStribal>
            <wcct_additional_amt></wcct_additional_amt>
            <plan_type></plan_type>
            <service_type></service_type>
            <talk></talk>
            <text></text>
            <data></data>
            <service_name></service_name>
            <service_amt></service_amt>
            <service_allow></service_allow>
            <activation_fee></activation_fee>
			<is_unlimited_plan>Y</is_unlimited_plan>
			<data_unlimited>Y</data_unlimited>
			<text_unlimited>N</text_unlimited>
			<minute_unlimited>N</minute_unlimited>
        </plans>
    </GetPlansList>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared seperately.

</plantype>GA meanes lifeline plan and NL means nonlifeline /prepaid plan

<planIStribal>Y means the plan is for tribal customers N means it is for non tribal customers.

<wcct_additional_amt>This is not applicable for you. It can be ignored

<service_type> This is the NLAD service type of the plan

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>
	<GetPlansList>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetPlansList>
</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>
	<GetPlansList>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetPlansList>
</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>
	<GetPlansList>
	<statusCode>118</statusCode>
	<description>FAIL</description>
	<errorDescription>State is required.</errorDescription>
</GetPlansList>
</VcareOssApi>

Error Description: State is required.

How to Resolve?: State cannot be blank. You should enter a valid State.

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>
	<GetPlansList>
	<statusCode>119</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Format! Only characters are allowed in State.</errorDescription>
</GetPlansList>
</VcareOssApi>

Error Description: Invalid Format! Only characters are allowed in State.

How to Resolve?: Please provide a valid Format in State.

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>
	<GetPlansList>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetPlansList>
</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>
	<GetPlansList>
	<statusCode>404</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan ID should be of same State.</errorDescription>
</GetPlansList>
</VcareOssApi>

Error Description: Plan ID should be of same State.

How to Resolve?: Plan id should be of same state

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>
	<GetPlansList>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetPlansList>
</VcareOssApi>

Error Description: Invalid Source.

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