Telgoo5 APIs

Check Service Availability

This XML API is used to check if the specific Zip Code is added as a serviceable area in Telgoo5. If an specific Zip Code is not added a serviceable area, partner can add using Telgoo5 or contact their account manager for assistance.

End Point	https://www.vcareapi.com/vcareOssApi/CheckServiceAvailability/
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.
ENROLLMENT TYPE		string	LIFELINE	Required	This determines if the customer being signed up will be a lifeline customer or a prepaid customer.	This can be either of the following: LIFELINE NONLIFELINE
ZIP CODE		Numeric	21215	Required	This is the Zip Code for the service address of the customer	Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
COMPANY ID		Numeric	21215	Required	Company Id can be obtained using GetCompany API.
IS ENROLLMENT		characters	Y	Optional	This needs to be passed as Y only in case you will be signing up the customer. If you pass it as Y in the response you will get the Enrollment Id which will be used in the other APIs for customer sign up.	Y OR N
IS WEB PARTNER		characters	Y	Optional	Value Y in the parameter determines the prefix for the enrollment ID to be generated. If it is passed as Y then the Enrollment Id will be generated with the prefix SU.	Y OR N
SOURCE		string	API	Optional	Source of the order/application/API call	Expected Value:API, TABLET, IVR, WEBSITE, CSR
AGENT ID		string	John Doe	Required	This is the Telgoo5 user id for the Agent/Employee who is sending the API request.
AGENT PASSWORD		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.

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>
<CHECKSERVICEAVAILABILITY>
	<ENROLLMENTTYPE></ENROLLMENTTYPE>
	<ZIPCODE></ZIPCODE>
	<COMPANYID></COMPANYID>
	<ISENROLLMENT></ISENROLLMENT>
	<ISWEBPARTNER></ISWEBPARTNER>
	<SOURCE></SOURCE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
</CHECKSERVICEAVAILABILITY>
</VCAREOSS>
</VCAREOSSAPI>

List of all the status codes will be shared seperately. <ssndigits> this is the number of digits of the social security number which will be required to do an enrollment in the given state. If it is 4 the last 4 digits of SSN are required and if it is 9 then the complete SSN is required. <is_tribal> if it is Y then it means that the given Zip Code is on tribal lands else if it is N then it is non tribal.

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
13	Password is invalid.	Provide a valid Password.
15	Zip code is invalid.	Please enter valid zip code.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
79	Invalid enrollment type.	Please provide valid enrollment type: LIFELINE or NONLIFELINE.
113	Zip Code is required.	Zip code cannot be blank. You should enter a valid Zip code.
114	Zip Code is not correct.	Please provide correct zip code.
130	Invalid Company ID.	Please provide valid company id.
169	Company ID is required.	Please provide company ID.
227	Employee ID is required.	Please provide an Employee ID.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
466	Enrollment type should not be blank.	Enrollment type can not be blank. You should enter a valid Enrollment type.
593	We are not able to verify availability in your area zipcode.	Enter another ZIP code as the provided ZIP code is not available.

Sample Response 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>
        <referenceNumber>123456789</referenceNumber>
    </credentials>
    <CheckServiceAvailability>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <ssndigits>4</ssndigits>
        <city>BALTIMORE</city>
        <state>MD</state>
        <is_tribal>N</is_tribal>
        <zipcode>21215</zipcode>
        <nladskip>N</nladskip>
        <enrollmentId>A235404</enrollmentId>
    </CheckServiceAvailability>
</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>
<CheckServiceAvailability>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</CheckServiceAvailability>
</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>
<CheckServiceAvailability>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Zip code is invalid.

How to Resolve?: Please enter valid zip code.

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>
<CheckServiceAvailability>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</CheckServiceAvailability>
</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>
<CheckServiceAvailability>
	<statusCode>79</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid enrollment type.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Invalid enrollment type.

How to Resolve?: Please provide valid enrollment type: LIFELINE or NONLIFELINE.

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>
<CheckServiceAvailability>
	<statusCode>113</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip Code is required.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Zip Code is required.

How to Resolve?: Zip code cannot be blank. You should enter a valid 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>
<CheckServiceAvailability>
	<statusCode>114</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip Code is not correct.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Zip Code is not correct.

How to Resolve?: Please provide correct zip code.

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

Error Description: Invalid Company ID.

How to Resolve?: Please provide valid company 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>
<CheckServiceAvailability>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Company ID is required.

How to Resolve?: Please provide company ID.

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>
<CheckServiceAvailability>
	<statusCode>227</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee ID is required.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Employee ID is required.

How to Resolve?: Please provide an Employee 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>
<CheckServiceAvailability>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID 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>
<CheckServiceAvailability>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Invalid Source.

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

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>
<CheckServiceAvailability>
	<statusCode>466</statusCode>
	<description>FAIL</description>
	<errorDescription>Enrollment type should not be blank.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: Enrollment type should not be blank.

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

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>
<CheckServiceAvailability>
	<statusCode>593</statusCode>
	<description>FAIL</description>
	<errorDescription>We are not able to verify availability in your area zipcode.</errorDescription>
</CheckServiceAvailability>
</VcareOssApi>

Error Description: We are not able to verify availability in your area zipcode.

How to Resolve?: Enter another ZIP code as the provided ZIP code is not available.

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