getProgramIncomeList

This XML API returns the list of eligibility program available in the state and the income based guidelines. We ask for the Zip Code in the XML API and get the state on the basis of Zip Code to return the results.

End Point https://www.vcareapi.com/vcareOssApi/getProgramIncomeList/
Field 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.
REFERENCENUMBER string 123456789 Required Auto generated unique reference number is required to be passed with each transaction.
ZIPCODE 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.
SERVICE TYPE string LIFELINE, ACP and COMBO Required This determines the type of service type. Service type should be LIFELINE,ACP and COMBO. Default value LIFELINE
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
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>
<GETPROGRAMINCOMELIST>
	<ZIP></ZIP>
        <SERVICETYPE></SERVICETYPE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
  </GETPROGRAMINCOMELIST>
</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.
15 Zip code is invalid. Please enter valid zip code.
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.
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.
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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <getProgramIncomeList>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <incomeBaseInfo>
            <incomeBase>
                <personshousehold>1</personshousehold>
                <annualincome>16281</annualincome>
            </incomeBase>
            <incomeBase>
                <personshousehold>2</personshousehold>
                <annualincome>21924</annualincome>
            </incomeBase>
            <incomeBase>
                <personshousehold>3</personshousehold>
                <annualincome>27567</annualincome>
            </incomeBase>
            <incomeBase>
                <personshousehold>4</personshousehold>
                <annualincome>33210</annualincome>
            </incomeBase>
            <incomeBase>
                <personshousehold>Each additional Person</personshousehold>
                <annualincome>5643</annualincome>
            </incomeBase>
        </incomeBaseInfo>
        <programBaseInfo>
            <programBase>
                <programename>Food Distribution Program (FDPIR)</programename>
                <programetype>Federal Programs</programetype>
                <programecode>FDPIR</programecode>
                <nladcode>E10</nladcode>
                <isstatedb>N</isstatedb>
                <statedbonlineoffline></statedbonlineoffline>
            </programBase>
            <programBase>
                <programename>Medicaid (not Medicare)</programename>
                <programetype>Federal Programs</programetype>
                <programecode>Medic</programecode>
                <nladcode>E1</nladcode>
                <isstatedb>N</isstatedb>
                <statedbonlineoffline></statedbonlineoffline>
            </programBase>
            <programBase>
                <programename>Section 8 Federal Public Housing Assistance (FPHA)</programename>
                <programetype>Federal Programs</programetype>
                <programecode>FPHA</programecode>
                <nladcode>E4</nladcode>
                <isstatedb>N</isstatedb>
                <statedbonlineoffline></statedbonlineoffline>
            </programBase>
            <programBase>
                <programename>Supplemental Nutrition Assistance Program (SNAP)</programename>
                <programetype>Federal Programs</programetype>
                <programecode>SNAP</programecode>
                <nladcode>E2</nladcode>
                <isstatedb>N</isstatedb>
                <statedbonlineoffline></statedbonlineoffline>
            </programBase>
            <programBase>
                <programename>Supplemental Security Income (SSI)</programename>
                <programetype>Federal Programs</programetype>
                <programecode>SSI</programecode>
                <nladcode>E3</nladcode>
                <isstatedb>N</isstatedb>
                <statedbonlineoffline></statedbonlineoffline>
            </programBase>
            <programBase>
                <programename>Veterans Pension and Survivors Benefit Program</programename>
                <programetype>Federal Programs</programetype>
                <programecode>VPSBP</programecode>
                <nladcode>E15</nladcode>
                <isstatedb>N</isstatedb>
                <statedbonlineoffline></statedbonlineoffline>
            </programBase>
        </programBaseInfo>
        <incomeatbelow>135</incomeatbelow>
        <statereqcustinfo>NA</statereqcustinfo>
    </getProgramIncomeList>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared seperately.

<personshousehold> This is the number of people living in the household.

<annualincome> This is the maximum income which the household should have on the basis of the <personshousehold>.

<programename>This is the eligibility program name.

 <programetype>This is the eligibility program type if it is Federal program or state or tribal.

<programecode>This is the short code of the eligibility program used in Vcare.


<nladcode>This is the NLAD code of the eligibility program.

<isstatedb> This determines if the state has a state database or not. Y is for yes and N for No.

<statedbonlineoffline>This determines if the state has the ONLINE database or OFFLINE.

<incomeatbelow> This is the income base level if it is 135% or 150% of the federal poverty guidelines.
<statereqcustinfo> This returns if any other state specific information will be required  from the applicant to enroll. Like Tribal ID.

 

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>
	<getProgramIncomeList>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</getProgramIncomeList>
</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>
	<getProgramIncomeList>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</getProgramIncomeList>
</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>
	<getProgramIncomeList>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</getProgramIncomeList>
</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>
	<getProgramIncomeList>
	<statusCode>19</statusCode>
	<description>FAIL</description>
	<errorDescription>Service is not available for this Zip Code.</errorDescription>
</getProgramIncomeList>
</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: 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>
	<getProgramIncomeList>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</getProgramIncomeList>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot 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>
	<getProgramIncomeList>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</getProgramIncomeList>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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