Telgoo5 APIs

ChangePlan

This XML API is used to change the plan on the existing subscriber's account

End Point	https://www.vcareapi.com/vcareOssApi/ChangePlan/
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.
REFERENCE NUMBER		string	123456789	Required	Auto generated unique reference number is required to be passed with each transaction.
CUSTOMERID		Numebric	123456	Required	Auto generated customer account number. This is returned in GetCustomerInfo
PLANID		Numebric	1315	Conditional	This is returned in getplanlist API. This is the plan id to which you want to change the customer's plan	Plan Code or Plan ID either of them is required. Priority PlanID
PLAN CODE		string	123	Conditional	This is Plan Code returned in another API response called "GetPlanService". This is returned in api response tag = plan_code , when in request TYPE=NONLIFELINE.	Plan Code or Plan ID either of them is required. Priority PlanID
CHANGETYPE		string	IMMEDIATE	Required	IMMEDIATE = This will change the plan instantly. ONEXPIRY = This will change the plan when the existing service plan expires.	IMMEDIATE or ONEXPIRY
KEEP ORIGINAL EXPIRY		Char	Y	Optional	Must be Y/N	If IMMEDIATE then Value is Optional.
PRORATED PLAN PRICE		Char	Y	Optional	Must be Y/N	If IMMEDIATE then Value is Optional.
ADVANCE BILLING MONTH		Number	2	Optional	Number of advance billing month determines the number of times the plan needs to be stacked. If Config "Advance Plan Purchase (Plan Change/Plan Rnew)" is Y then AdvanceBilling month is accepted.	2
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE,POS
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></VENDORID>
<USERNAME></USERNAME>
<PASSWORD></PASSWORD>
<PIN></PIN>
<REFERENCENUMBER></REFERENCENUMBER>
 </CREDENTIALS>
<VCAREOSS>
<CHANGEPLAN>
	<CUSTOMERID></CUSTOMERID>
	<PLANID></PLANID>
	<PLANCODE></PLANCODE>
	<CHANGETYPE></CHANGETYPE>
	<KEEPORIGINALEXPIRY></KEEPORIGINALEXPIRY>
	<PRORATEDPLANPRICE></PRORATEDPLANPRICE>
	<ADVANCEBILLINGMONTH></ADVANCEBILLINGMONTH>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</CHANGEPLAN>
</VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
01	Error Received from Carrier.	Please try again with valid data.
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
25	Customer ID is invalid.	Provide a valid Customer ID.
203	Invalid PlanID.	Provide a valid PlanID.
226	Customer ID is required.	Please provide Customer ID.
321	Customer not found.	Customer is not found.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
374	Change Type should not be blank.	Please provide Change Type as it cannot be blank.
377	Change Type is not valid.	Please provide a valid Change Type.
403	Plan ID is not LIVE.	This plan id is not live in system.
404	Plan ID should be of same State.	Plan id should be of same state
405	Customer Account Type not matched.	Customer Account Type is different and not matched.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
589	Tribal customer plan could not be changed from tribal to non tribal.	Tribal customer plan could not be changed from tribal to non tribal.
590	Tribal customer plan could not be changed from non tribal to tribal.	Tribal customer plan could not be changed from non tribal to tribal.
662	Keep original expiry should be Y OR N.	Provide correct Keep original expiry. Keep original expiry should be Y or N.
663	Prorated plan price should be Y OR N.	Provide correct Prorated plan price. Prorated plan price should be Y or N.

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>
    <ChangePlan>
        <statusCode></statusCode>
        <description></description>
        <errorDescription></errorDescription>
        <ChangePlan>
</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>
<ChangePlan>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Error Received from Carrier.

How to Resolve?: Please try again with valid data.

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>
<ChangePlan>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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>
<ChangePlan>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

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>
<ChangePlan>
	<statusCode>22</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan not found.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Plan not found.

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

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>
<ChangePlan>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Customer ID is invalid.

How to Resolve?: Provide a valid Customer ID.

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>
<ChangePlan>
	<statusCode>203</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid PlanID.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Invalid PlanID.

How to Resolve?: Provide a valid PlanID.

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>
<ChangePlan>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Customer ID is required.

How to Resolve?: Please provide Customer ID.

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>
<ChangePlan>
	<statusCode>321</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer not found.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Customer not found.

How to Resolve?: Customer is not found.

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>
<ChangePlan>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

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

Sample Fail Response: 10

<?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>
<ChangePlan>
	<statusCode>374</statusCode>
	<description>FAIL</description>
	<errorDescription>Change Type  should not be blank.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Change Type should not be blank.

How to Resolve?: Please provide Change Type as it cannot be blank.

Sample Fail Response: 11

<?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>
<ChangePlan>
	<statusCode>377</statusCode>
	<description>FAIL</description>
	<errorDescription>Change Type is not valid.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Change Type is not valid.

How to Resolve?: Please provide a valid Change Type.

Sample Fail Response: 12

<?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>
<ChangePlan>
	<statusCode>403</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan ID is not LIVE.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Plan ID is not LIVE.

How to Resolve?: This plan id is not live in system.

Sample Fail Response: 13

<?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>
<ChangePlan>
	<statusCode>404</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan ID should be of same State.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Plan ID should be of same State.

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

Sample Fail Response: 14

<?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>
<ChangePlan>
	<statusCode>405</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer Account Type not matched.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Customer Account Type not matched.

How to Resolve?: Customer Account Type is different and not matched.

Sample Fail Response: 15

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

Error Description: Invalid Source.

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

Sample Fail Response: 16

<?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>
<ChangePlan>
	<statusCode>589</statusCode>
	<description>FAIL</description>
	<errorDescription>Tribal customer plan could not be changed from tribal to non tribal.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Tribal customer plan could not be changed from tribal to non tribal.

How to Resolve?: Tribal customer plan could not be changed from tribal to non tribal.

Sample Fail Response: 17

<?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>
<ChangePlan>
	<statusCode>590</statusCode>
	<description>FAIL</description>
	<errorDescription>Tribal customer plan could not be changed from non tribal to tribal.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Tribal customer plan could not be changed from non tribal to tribal.

How to Resolve?: Tribal customer plan could not be changed from non tribal to tribal.

Sample Fail Response: 18

<?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>
<ChangePlan>
	<statusCode>662</statusCode>
	<description>FAIL</description>
	<errorDescription>Keep original expiry should be Y OR N.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Keep original expiry should be Y OR N.

How to Resolve?: Provide correct Keep original expiry. Keep original expiry should be Y or N.

Sample Fail Response: 19

<?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>
<ChangePlan>
	<statusCode>663</statusCode>
	<description>FAIL</description>
	<errorDescription>Prorated plan price should be Y OR N.</errorDescription>
</ChangePlan>
</VcareOssApi>

Error Description: Prorated plan price should be Y OR N.

How to Resolve?: Provide correct Prorated plan price. Prorated plan price should be Y or N.

All the status codes are listed under the status code sections. Please click here to go to the status code.