Telgoo5 APIs

StackPlanGetAndCancel

This XML API is used to get and Cancel Stack Plan.

End Point	https://www.vcareapi.com/vcareOssApi/StackPlanGetAndCancel/
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.
ACTION		string	CHECKREQUESTSTACK	Required	CHECKREQUESTSTACK = This will get Stack Plan. CANCELREQUESTSTACK = This will Cancel Stack Plan.	CHECKREQUESTSTACK or CANCELREQUESTSTACK
CUSTOMERID		Numeric	123	Required	This is the customer which is attached to the subscriber's account
REQUEST ID		Numeric	4562	Optional	Required if ACTION="CANCELREQUESTSTACK". This can be obtained using StackPlanGetAndCancel with ACTION="CHECKREQUESTSTACK" XML API.
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></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
	<STACKPLANGETANDCANCEL>
		<ACTION></ACTION>
		<CUSTOMERID></CUSTOMERID>
		<REQUESTID></REQUESTID>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</STACKPLANGETANDCANCEL>
</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.
25	Customer ID is invalid.	Provide a valid Customer ID.
214	Action should not be blank.	Please provide valid value as Action should not be blank.
321	Customer not found.	Customer is not found.
679	Action Type should be CHECKREQUESTSTACK OR CANCELREQUESTSTACK.	Provide correct Action Type. Action Type should be CHECKREQUESTSTACK or CANCELREQUESTSTACK.
680	There is no plan in change request stack.	There is no plan in change request stack.
681	There is no plan in cancel request stack.	There is no plan in cancel request stack.
682	Request ID should not be blank.	Provide a valid Request ID. Request ID should not be blank.

Sample Response

Action :: CHECKREQUESTSTACK

<?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>1111111</referenceNumber>
    </credentials>
    <StackPlanGetAndCancel>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <old_plan></old_plan>
        <new_plan></new_plan>
        <plan_effective_date></plan_effective_date>
        <plan_change_mode></plan_change_mode>
        <requestid></requestid>
    </StackPlanGetAndCancel>
</VcareOssApi>

Action :: CANCELREQUESTSTAC

<?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>1111111</referenceNumber>
    </credentials>
    <StackPlanGetAndCancel>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>Plan purchase request is cancelled.</errorDescription>
     </StackPlanGetAndCancel>
</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>
<StarzValidateCustomerPlan>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</StarzValidateCustomerPlan>
</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>
<StarzValidateCustomerPlan>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</StarzValidateCustomerPlan>
</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>
<StarzValidateCustomerPlan>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</StarzValidateCustomerPlan>
</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>
<StarzValidateCustomerPlan>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: Customer ID is invalid.

How to Resolve?: Provide a valid Customer ID.

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>
<StarzValidateCustomerPlan>
	<statusCode>214</statusCode>
	<description>FAIL</description>
	<errorDescription>Action should not be blank.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: Action should not be blank.

How to Resolve?: Please provide valid value as Action should not 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>
<StarzValidateCustomerPlan>
	<statusCode>321</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer not found.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: Customer not found.

How to Resolve?: Customer is not found.

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>
<StarzValidateCustomerPlan>
	<statusCode>679</statusCode>
	<description>FAIL</description>
	<errorDescription>Action Type should be CHECKREQUESTSTACK OR CANCELREQUESTSTACK.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: Action Type should be CHECKREQUESTSTACK OR CANCELREQUESTSTACK.

How to Resolve?: Provide correct Action Type. Action Type should be CHECKREQUESTSTACK or CANCELREQUESTSTACK.

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>
<StarzValidateCustomerPlan>
	<statusCode>680</statusCode>
	<description>FAIL</description>
	<errorDescription>There is no plan in change request stack.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: There is no plan in change request stack.

How to Resolve?: There is no plan in change request stack.

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>
<StarzValidateCustomerPlan>
	<statusCode>681</statusCode>
	<description>FAIL</description>
	<errorDescription>There is no plan in cancel request stack.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: There is no plan in cancel request stack.

How to Resolve?: There is no plan in cancel request stack.

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>
<StarzValidateCustomerPlan>
	<statusCode>682</statusCode>
	<description>FAIL</description>
	<errorDescription>Request ID should not be blank.</errorDescription>
</StarzValidateCustomerPlan>
</VcareOssApi>

Error Description: Request ID should not be blank.

How to Resolve?: Provide a valid Request ID. Request ID should not be blank.

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