Telgoo5 APIs

CheckEligibilityNumbers

This XML API checks for the duplicate on the eligibility program number of the applicant. Below is the process how it works.

Same Program Code, Same Proof of eligibility numbers and same state = Vcare will return duplicate error "Duplicate Eligibility Number"
Same Program Code and Same Proof of eligibility numbers but different State = No error will be returned
Different Program Code, Same Proof of eligibility numbers, same state = No error will be return, Vcare will not consider this as duplicate since the program code has been changed
Same Program Code, Different Proof of eligibility numbers, same state = No error will be returned
Different Program Code, Same Proof of eligibility numbers, different state = No error will be return, Vcare will not consider this as duplicate since the program code has been changed
Same Program Code, Different Proof of eligibility numbers, different state = No error will be returned"

End Point	https://www.vcareapi.com/vcareOssApi/CheckEligibilityNumbers/
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.
PROGRAM CODE		string	Medic	Required	The NLAD program code under which the subscriber is eligible for Lifeline Program benefits.	These are returned in getProgramIncomeList XML API.
QUESTIONNAIRE		string	Proof of Eligibility numbers	Required	This is a static question. In this field you will always pass "Proof of Eligibility numbers".	It should be always be "Proof of Eligibility numbers".
ELIGIBILITYNUMBER		string	12345644s	Required	In this field you will always pass Numbers/Digits/ID of the qualifying eligibility program.	Alphanumeric
STATE		string	MO	Required	State for the service address.	State should be standard abbreviated form.
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>
  <CHECKELIGIBILITYNUMBERS>
   <PROGRAMCODE></PROGRAMCODE>
   <QUESTIONNAIRE></QUESTIONNAIRE>
   <ELIGIBILITYNUMBER></ELIGIBILITYNUMBER>
   <STATE>MO</STATE>
   <AGENTID></AGENTID>
   <AGENTPASSWORD></AGENTPASSWORD>
   <SOURCE>API</SOURCE>
   </CHECKELIGIBILITYNUMBERS>
 </VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
21	Invalid State.	Provide a valid State
44	Input error.	Please check description. This is provided dynamic error.
84	Invalid program code.	Please provide a valid program code.
223	Eligibility number not blank.	Please provide eligibility number.
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.
489	Duplicate Eligibility number.	Provide correct Eligibility number. Eligibility number is not existed in system.
767	Eligibility questionnaire should not be blank.	Provide a valid Eligibility questionnaire. Eligibility questionnaire should not be blank.

Sample Fail 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>Vcarecorporation</vendorId>
	<referenceNumber>11111</referenceNumber>
</credentials>
<CheckEligibilityNumbers>
	<statusCode>00</statusCode>
	<description>SUCCESS</description>
	<errorDescription>SUCCESS</errorDescription>
</CheckEligibilityNumbers>
</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>
<CheckEligibilityNumbers>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</CheckEligibilityNumbers>
</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>
<CheckEligibilityNumbers>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</CheckEligibilityNumbers>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

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>
<CheckEligibilityNumbers>
	<statusCode>21</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid State.</errorDescription>
</CheckEligibilityNumbers>
</VcareOssApi>

Error Description: Invalid State.

How to Resolve?: Provide a valid State

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

Error Description: Input error.

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

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>
<CheckEligibilityNumbers>
	<statusCode>84</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid program code.</errorDescription>
</CheckEligibilityNumbers>
</VcareOssApi>

Error Description: Invalid program code.

How to Resolve?: Please provide a valid program 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>
<CheckEligibilityNumbers>
	<statusCode>223</statusCode>
	<description>FAIL</description>
	<errorDescription>Eligibility number not blank.</errorDescription>
</CheckEligibilityNumbers>
</VcareOssApi>

Error Description: Eligibility number not blank.

How to Resolve?: Please provide eligibility number.

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

Error Description: Agent ID cannot be blank.

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

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

Error Description: Invalid Source.

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

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>
<CheckEligibilityNumbers>
	<statusCode>489</statusCode>
	<description>FAIL</description>
	<errorDescription>Duplicate Eligibility number.</errorDescription>
</CheckEligibilityNumbers>
</VcareOssApi>

Error Description: Duplicate Eligibility number.

How to Resolve?: Provide correct Eligibility number. Eligibility number is not existed in system.

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>
<CheckEligibilityNumbers>
	<statusCode>767</statusCode>
	<description>FAIL</description>
	<errorDescription>Eligibility questionnaire should not be blank.</errorDescription>
</CheckEligibilityNumbers>
</VcareOssApi>

Error Description: Eligibility questionnaire should not be blank.

How to Resolve?: Provide a valid Eligibility questionnaire. Eligibility questionnaire should not be blank.

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