CreateCustomerDataPlan

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/CreateCustomerDataPlan/
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.
FIRSTNAME string John Required This is the first name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
MIDDLENAME string A Optional This is the middle name of the subscriber. Only English alphabet letters, space, apostrophe, Accent Grave ("`"), period and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
LASTNAME string Doe Required This is the last name of the applicant. Only English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.Max length - 50 symbols.Space characters at the start or end of the name should be cut off.
CUSTOMER PASSWORD string R3fsf4@567 Required 10 digit alternate contact number of the applicant. The customer password have to be number, letter, following special character -_%$#*,.;=<>?:{}|+)(&^@!~ and 4 to 8 characters.
EMAIL string noemail@gmail.com Required Email address standard form is validated if any value is passed.  
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 Should be approved ESN/MDN/IMEI
Can be alpha numeric. Max length = 25
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.
PLAN ID string 1320 Required This is ID returned.
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>
<CREATECUSTOMERDATAPLAN>
	<FIRSTNAME></FIRSTNAME>
	<MIDDLENAME></MIDDLENAME>
	<LASTNAME></LASTNAME>
	<CUSTOMERPASSWORD></CUSTOMERPASSWORD>
	<EMAIL></EMAIL>
	<SIM></SIM>
	<ZIP></ZIP>
	<PLANID></PLANID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<AGENTID></AGENTID>
	<SOURCE></SOURCE>
</CREATECUSTOMERDATAPLAN>
</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.
05 OSP Carrier should not be blank. Provide OSP Carrier.
13 Password is invalid. Provide a valid Password.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
19 Service is not available for this Zip Code. No service for the provided Zip Code. Please enter the right Zip code.
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.
169 Company ID is required. Please provide company ID.
194 ESN should not be blank. Please provide ESN. ESN cannot be left blank.
351 ESN must be greater than 8 and less than 26 characters. Please provide a valid ESN and it must be greater than 8 and less than 26 characters.
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>
    <CreateCustomerDataPlan>
		<statusCode></statusCode>
		<description></description>
		<errorDescription></errorDescription>
		<enroll_id></enroll_id>
		<customer_id></customer_id>
		<ActivateSubscriberStatus></ActivateSubscriberStatus>
		<ActivateSubscriberDescription></ActivateSubscriberDescription>
		<telephone_number></telephone_number>
    </CreateCustomerDataPlan>
</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>
 <CreateCustomerDataPlan>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
 </CreateCustomerDataPlan>
</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>
 <CreateCustomerDataPlan>
	<statusCode>05</statusCode>
	<description>FAIL</description>
	<errorDescription>OSP Carrier should not be blank.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: OSP Carrier should not be blank.
How to Resolve?: Provide OSP Carrier.
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>
 <CreateCustomerDataPlan>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
 </CreateCustomerDataPlan>
</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>
 <CreateCustomerDataPlan>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
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>
 <CreateCustomerDataPlan>
	<statusCode>19</statusCode>
	<description>FAIL</description>
	<errorDescription>Service is not available for this Zip Code.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: Service is not available for this Zip Code.
How to Resolve?: No service for the provided Zip Code. Please enter the right Zip code.
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>
 <CreateCustomerDataPlan>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: Carrier is invalid.
How to Resolve?: Please provide valid Carrier.
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>
 <CreateCustomerDataPlan>
	<statusCode>43</statusCode>
	<description>FAIL</description>
	<errorDescription>Multiple input errors.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: Multiple input errors.
How to Resolve?: Please check description. This is providing multiple dynamic errors.
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>
 <CreateCustomerDataPlan>
	<statusCode>44</statusCode>
	<description>FAIL</description>
	<errorDescription>Input error.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: Input error.
How to Resolve?: Please check description. This is provided dynamic error.
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>
 <CreateCustomerDataPlan>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide company ID.
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>
 <CreateCustomerDataPlan>
	<statusCode>194</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN should not be blank.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: ESN should not be blank.
How to Resolve?: Please provide ESN. ESN cannot be left 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>
 <CreateCustomerDataPlan>
	<statusCode>351</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN must be greater than 8 and less than 26 characters.</errorDescription>
 </CreateCustomerDataPlan>
</VcareOssApi>
Error Description: ESN must be greater than 8 and less than 26 characters.
How to Resolve?: Please provide a valid ESN and it must be greater than 8 and less than 26 characters.

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