Telgoo5 APIs

UpgradeToFamilyPlan

This API is used to create a prepaid/postpaid subscriber in Telgoo5. This enables you to create a subscriber with a new number or a Port In.

End Point

https://www.vcareapi.com/vcareOssApi/UpgradeToFamilyPlan/

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.

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.

Parent

PARENT MDN

Numeric

1234567890

Conditional

This has to be the same MDN which was returned in Devicelook up API of the ESN/SIM.

Should be 10 digit mobile number.

CHANGE PLAN ID

string

1320

Required

This is ID returned in another API response called "GetPlanService". This is returned in api response tag = planid.

ADD EXISTING MDN

string

Y/N

Required

if you want to add existing mdn value must be Y otherwise N

Y/N

EXISTING MDN

MDN

Numeric

1234567890

Conditional

This has to be the same MDN which was returned in Devicelook up API of the ESN/SIM.

Should be 10 digit mobile number.

ADD NEW CHILD

string

Y/N

Required

if you want to add new child value must be Y otherwise N

Y/N

ADDNEWCHILD

ENROLLMENT ID	string	AN12345	Not In Use	The enrollment id is returned in the CheckServiceAvailability call and you are required to pass the same enrollment id for the enrollment you are attempting	Alphanumeric
FIRSTNAME	string	John	Required	This is the first name of the applicant.	OnlyEnglish alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name the space should be cut off.
MIDDLENAME	string	A	Optional	This is the middle name of the subscriber.
LASTNAME	string	Doe	Required	This is the last name of the applicant.
AlternativeContact	Numeric	1234567890	Optional	10 digit alternate contact number of the applicant.	no hyphen allowed
ALTERNATIVE EMAIL	string	noemail@gmail.com	Optional	Email address standard form is validated if any value is passed.
ADDRESS1	string	123 Main St	Required	This is the service address line 1 of the applicant. Address line 1 is not validated for Prepaid/Postpaid order.
ADDRESS2	string	Apt 1	Optional	This is the service address line 2 of the applicant.
CITY	string	Houston	Required	This is the service address city of the applicant.	Should allow only letters, hyphen and space.
STATE	string	TX	Required	This is the service address state of the applicant.	State should be standard abbreviated form.
ZIPCODE	string	73001	Required	This is the service address zipcode of the applicant.	Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
PLANID	string	1320	Required	This is ID returned in another API response called "GetPlanService". This is returned in api response tag = planid , when in request TYPE=NONLIFELINE.
DEVICE ID	Numeric		Optional	If IMEI # doesnt exist in database, it will add as a new inventory. If already exist, it will assign to the AgentID passed with this request.
SALES CHANNEL	string		Optional
PHONE TYPE	string	4G, 3G	Optional	If no value passed, it will consider as 3G as default.
UICCID	Numeric		Optional	If value passed as 4G in Phone Type, this field becomes required.
ESN/SIM	string	8901260713156280780	Required	This is the same ESN/SIM which was passed in devicelookup API. This is Optional to be passed if the status is passed as pending and Enrollment type is shipment	Can be alpha numeric. Max length = 25
MDN	Numeric	1234567890	Conditional	This has to be the same MDN which was returned in Devicelook up API of the ESN/SIM. If the SIM/ESN status was Not provisioned then it could be left blank and the Sim/ESN will be activated real time. When Activation_type = PORTIN, this is the PORTIN MDN.	Should be 10 digit mobile number.
CARRIER	string	TMB	Required	This is the carrier id and is returned in the Devicelookup API in the <carrier> parameter
COMPANY ID	Numeric	28	Required	A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany.
ORDER TYPE	string	28	Optional		SHIP OR H2H

AGENTID

string

John Doe

Required

This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.

AGENTPASSWORD

string

JohnDoe

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>
<UPGRADETOFAMILYPLAN>
  <PARENT_MDN></PARENT_MDN>
  <CHANGEPLANID></CHANGEPLANID>
   <ADDEXISTIGCHILD>
	<ADDEXISTIGMDN></ADDEXISTIGMDN>
	<EXISTIGMDN>
		<MDN></MDN>
		<MDN></MDN>
		<MDN></MDN>
	</EXISTIGMDN>
 </ADDEXISTIGCHILD>

<ADDNEWCHILD>
	<ADDCHILD></ADDCHILD>
	<CHILD>
		<ENROLLMENTID></ENROLLMENTID>
		<FIRSTNAME></FIRSTNAME>
		<MIDDLENAME></MIDDLENAME>
		<LASTNAME></LASTNAME>
		<ALTERNATIVECONTACTNUMBER></ALTERNATIVECONTACTNUMBER>
		<EMAIL></EMAIL>
		<ADDRESS1></ADDRESS1>
		<ADDRESS2></ADDRESS2>
		<CITY></CITY>
		<STATE></STATE>
		<ZIP></ZIP>
		<PLANID></PLANID>
		<DEVICEID></DEVICEID>
		<SALESCHANNEL></SALESCHANNEL>
		<PHONETYPE></PHONETYPE>
		<UICCID></UICCID>
		<ESN></ESN>
		<MDN></MDN>
		<CARRIER></CARRIER>
		<COMPANY_ID></COMPANY_ID>
		<ORDERTYPE></ORDERTYPE>
	</CHILD>
	<CHILD>
		<ENROLLMENTID></ENROLLMENTID>
		<FIRSTNAME></FIRSTNAME>
		<MIDDLENAME></MIDDLENAME>
		<LASTNAME></LASTNAME>
		<ALTERNATIVECONTACTNUMBER></ALTERNATIVECONTACTNUMBER>
		<EMAIL></EMAIL>
		<ADDRESS1></ADDRESS1>
		<ADDRESS2></ADDRESS2>
		<CITY></CITY>
		<STATE></STATE>
		<ZIP></ZIP>
		<PLANID></PLANID>
		<DEVICEID></DEVICEID>
		<SALESCHANNEL></SALESCHANNEL>
		<PHONETYPE></PHONETYPE>
		<UICCID></UICCID>
		<ESN></ESN>
		<MDN></MDN>
		<CARRIER></CARRIER>
		<COMPANY_ID></COMPANY_ID>
		<ORDERTYPE></ORDERTYPE>
	</CHILD>

</ADDNEWCHILD>
<AGENTID></AGENTID>
<AGENTPASSWORD></AGENTPASSWORD>
<SOURCE></SOURCE>
</UPGRADETOFAMILYPLAN>
</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.
06	Please send a valid family plan id to Upgrade the parent account to family plan.	Valid family plan id is required for upgrade.
13	Password is invalid.	Provide a valid Password.
22	Plan not found.	Provide a valid plan available in system
41	Carrier is invalid.	Please provide valid Carrier.
43	Multiple input errors.	Please check description. This is providing multiple dynamic errors.
44	Input error.	Please check description. This is provided dynamic error.
55	Invalid agent login.	Please provide valid agent login.
83	ESN Already Used.	Please provide free ESN.
98	ESN not found in inventory.	Please provide valid value as ESN not found in inventory.
125	MDN should not be blank.	Please provide MDN. MDN cannot be left blank.
126	Invalid MDN.	Please provide valid MDN.
130	Invalid Company ID.	Please provide valid company id.
169	Company ID is required.	Please provide company ID.
194	ESN should not be blank.	Please provide ESN. ESN cannot be left blank.
206	Device ID cannot be blank.	Please provide valid value as Device ID cannot be blank.
321	Customer not found.	Customer is not found.
332	MDN not found in System.	MDN is not found in System.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
386	ESN is found in system as Bad status.	ESN is found in system as Bad status.
387	ESN is found in system as Removed status.	ESN is found in system as Removed status.
411	Device ID is not available in our system.	This Device ID is not available in system.
449	Carrier should not be blank.	Carrier can not be blank. You should enter a valid Carrier.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
462	UICCID should not be blank.	Enter a valid UICCID. UICCID should not be blank.
464	This ESN is Provisioned. Therefore MDN should not be blank.	This ESN is Provisioned. Therefore MDN should not be blank. MDN can not be blank. You should enter a valid MDN.
465	ESN is found in system as blank status.	Entered ESN is found in system as blank status.
467	ESN is already active on another customer.	Entered ESN is already active on another customer.
598	Please check that maximum enrollment lines are allowed only	Please check child family plan max line allow. It is managed from configuration.
638	The parent MDN is already attached with another customer.	Parent MDN is already attached with another customer. Please use another MDN.
641	Please send a valid family plan id to Upgrade the parent account to family plan.	Please send a valid family plan id to Upgrade the parent account to family plan.
645	Please enter value add existing MDN OR add child as Y.	Please enter value add existing MDN OR add child as Y.

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>
<UpgradeToFamilyPlan>
   <statusCode>00</statusCode>
   <description>SUCCESS</description>
   <errorDescription>SUCCESS</errorDescription>
   <existigmdn>
   <addexistigchild>
		<existigmdn><addnewchild>
	</addexistigchild>
   <child>
	   <status></status>
	   <esn></esn>
	   <enrollmentId></enrollmentId>
	   <customerid></customerid>
	   <ProvisionMsg></ProvisionMsg>
   </child>
   <child>
	   <status></status>
	   <esn></esn>
	   <enrollmentId></enrollmentId>
	   <customerid></customerid>
	   <ProvisionMsg></ProvisionMsg>
   </child>
   </addnewchild>
</UpgradeToFamilyPlan>
</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>
<UpgradeToFamilyPlan>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</UpgradeToFamilyPlan>
</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>
<UpgradeToFamilyPlan>
	<statusCode>06</statusCode>
	<description>FAIL</description>
	<errorDescription>Please send a valid family plan id to Upgrade the parent account to family plan.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Please send a valid family plan id to Upgrade the parent account to family plan.

How to Resolve?: Valid family plan id is required for upgrade.

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

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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>
<UpgradeToFamilyPlan>
	<statusCode>22</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan not found.</errorDescription>
</UpgradeToFamilyPlan>
</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>
<UpgradeToFamilyPlan>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Carrier is invalid.

How to Resolve?: Please provide valid Carrier.

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>
<UpgradeToFamilyPlan>
	<statusCode>43</statusCode>
	<description>FAIL</description>
	<errorDescription>Multiple input errors.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Multiple input errors.

How to Resolve?: Please check description. This is providing multiple dynamic errors.

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>
<UpgradeToFamilyPlan>
	<statusCode>44</statusCode>
	<description>FAIL</description>
	<errorDescription>Input error.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Input error.

How to Resolve?: Please check description. This is provided dynamic error.

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>
<UpgradeToFamilyPlan>
	<statusCode>55</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid agent login.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Invalid agent login.

How to Resolve?: Please provide valid agent login.

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>
<UpgradeToFamilyPlan>
	<statusCode>83</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN Already Used.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN Already Used.

How to Resolve?: Please provide free ESN.

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>
<UpgradeToFamilyPlan>
	<statusCode>98</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN not found in inventory.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN not found in inventory.

How to Resolve?: Please provide valid value as ESN not found in inventory.

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>
<UpgradeToFamilyPlan>
	<statusCode>125</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should not be blank.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: MDN should not be blank.

How to Resolve?: Please provide MDN. MDN cannot be left blank.

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>
<UpgradeToFamilyPlan>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Invalid MDN.

How to Resolve?: Please provide valid MDN.

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>
<UpgradeToFamilyPlan>
	<statusCode>130</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Company ID.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Invalid Company ID.

How to Resolve?: Please provide valid company id.

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>
<UpgradeToFamilyPlan>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Company ID is required.

How to Resolve?: Please provide company ID.

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>
<UpgradeToFamilyPlan>
	<statusCode>194</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN should not be blank.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN should not be blank.

How to Resolve?: Please provide ESN. ESN cannot be left blank.

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>
<UpgradeToFamilyPlan>
	<statusCode>206</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID cannot be blank.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Device ID cannot be blank.

How to Resolve?: Please provide valid value as Device ID cannot be blank.

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

Error Description: Customer not found.

How to Resolve?: Customer is not found.

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>
<UpgradeToFamilyPlan>
	<statusCode>332</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN not found in System.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: MDN not found in System.

How to Resolve?: MDN is not found in System.

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

Error Description: Agent ID cannot be blank.

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

Sample Fail Response: 20

<?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>
<UpgradeToFamilyPlan>
	<statusCode>386</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is found in system as Bad status.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN is found in system as Bad status.

How to Resolve?: ESN is found in system as Bad status.

Sample Fail Response: 21

<?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>
<UpgradeToFamilyPlan>
	<statusCode>387</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is found in system as Removed status.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN is found in system as Removed status.

How to Resolve?: ESN is found in system as Removed status.

Sample Fail Response: 22

<?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>
<UpgradeToFamilyPlan>
	<statusCode>411</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID is not available in our system.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Device ID is not available in our system.

How to Resolve?: This Device ID is not available in system.

Sample Fail Response: 23

<?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>
<UpgradeToFamilyPlan>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Carrier should not be blank.

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

Sample Fail Response: 24

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

Error Description: Invalid Source.

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

Sample Fail Response: 25

<?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>
<UpgradeToFamilyPlan>
	<statusCode>462</statusCode>
	<description>FAIL</description>
	<errorDescription>UICCID should not be blank.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: UICCID should not be blank.

How to Resolve?: Enter a valid UICCID. UICCID should not be blank.

Sample Fail Response: 26

<?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>
<UpgradeToFamilyPlan>
	<statusCode>464</statusCode>
	<description>FAIL</description>
	<errorDescription>This ESN is Provisioned. Therefore MDN should not be blank.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: This ESN is Provisioned. Therefore MDN should not be blank.

How to Resolve?: This ESN is Provisioned. Therefore MDN should not be blank. MDN can not be blank. You should enter a valid MDN.

Sample Fail Response: 27

<?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>
<UpgradeToFamilyPlan>
	<statusCode>465</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is found in system as blank status.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN is found in system as blank status.

How to Resolve?: Entered ESN is found in system as blank status.

Sample Fail Response: 28

<?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>
<UpgradeToFamilyPlan>
	<statusCode>467</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is already active on another customer.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: ESN is already active on another customer.

How to Resolve?: Entered ESN is already active on another customer.

Sample Fail Response: 29

<?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>
<UpgradeToFamilyPlan>
	<statusCode>598</statusCode>
	<description>FAIL</description>
	<errorDescription>Please check that maximum enrollment lines are allowed only</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Please check that maximum enrollment lines are allowed only

How to Resolve?: Please check child family plan max line allow. It is managed from configuration.

Sample Fail Response: 30

<?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>
<UpgradeToFamilyPlan>
	<statusCode>638</statusCode>
	<description>FAIL</description>
	<errorDescription>The parent MDN is already attached with another customer.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: The parent MDN is already attached with another customer.

How to Resolve?: Parent MDN is already attached with another customer. Please use another MDN.

Sample Fail Response: 31

<?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>
<UpgradeToFamilyPlan>
	<statusCode>641</statusCode>
	<description>FAIL</description>
	<errorDescription>Please send a valid family plan id to Upgrade the parent account to family plan.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Please send a valid family plan id to Upgrade the parent account to family plan.

How to Resolve?: Please send a valid family plan id to Upgrade the parent account to family plan.

Sample Fail Response: 32

<?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>
<UpgradeToFamilyPlan>
	<statusCode>645</statusCode>
	<description>FAIL</description>
	<errorDescription>Please enter value add existing MDN OR add child as Y.</errorDescription>
</UpgradeToFamilyPlan>
</VcareOssApi>

Error Description: Please enter value add existing MDN OR add child as Y.

How to Resolve?: Please enter value add existing MDN OR add child as Y.

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