Telgoo5 APIs

ChangeAddress

This XML API is used to do the address validation in Melissa database

End Point	https://www.vcareapi.com/vcareOssApi/ChangeAddress/
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.
CUSTOMERID		Numebric	123456	Required	Auto generated number this is returned in Getcustomerinfo	numeric
CHANGE TYPE		string	serv	Required	change type must be among serv,ship or both
ADDRESS TYPE		char	P	Required	Address type must be among P=Permanent or T = Temporary	P or T
IS BYPASS NLAD		char	Y	Optional	is bypass nlad must be Y Or N	Y or N
ADDRESS1		string	123 Main St	Required	This is the service address line 1 of the applicant.	Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
ADDRESS2		string	Apt 1	Optional	This is the service address line 2 of the applicant.	Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
BILLADDPO1		string	PO BOX 1	Conditional	If your change type is SHIP and the mailing address is PO BOX then you need to pass PO BOX in this parameter
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		Numebric	73001	Required	This is the service address zip of the applicant.	Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
LIFE LINE		char	Y	Optional	If it is Relative then Y else N	Y or N
ADULT		char	Y	Conditional	This is the response to the IEH worksheet question. If an adult lives on the address Y or N	These are to be determined by ETC on the basis of IEH worksheet
PARENT		char	Y	Conditional	This is the response to the IEH worksheet question. If an adult lives on the address then who is it? If it is PARENT then Y else N	These are to be determined by ETC on the basis of IEH worksheet
RELATIVE		char	Y	Conditional	This is the response to the IEH worksheet question. If an adult lives on the address then who is it? If it is Relative then Y else N	These are to be determined by ETC on the basis of IEH worksheet
ROOMMATE		char	Y	Conditional	This is the response to the IEH worksheet question. If an adult lives on the address then who is it? If it is Roommate then Y else N	These are to be determined by ETC on the basis of IEH worksheet
SAMEADD		char	Y	Conditional	This is the response to the IEH worksheet question. If an adult lives on the address then who is it? If it is Roomate then Y else N	These are to be determined by ETC on the basis of IEH worksheet
OTHER		char	Y	Conditional	This is the response to the IEH worksheet question. If an adult lives on the address then who is it? If it is none of the PARENT,ROOMMATE or RELATIVE then OTHER should be Y	These are to be determined by ETC on the basis of IEH worksheet
SHARE		char	N	Conditional	If you share the income and expenses with the adult who lives with you then Y else N	These are to be determined by ETC on the basis of IEH worksheet
CERTIFI1		char	Y	Conditional	If IEH worksheet questions answers are compliant then you need to pass the responses to the IEH certification statement Y or N	These are to be determined by ETC on the basis of IEH worksheet
CERTIFI2		char	Y	Conditional	If IEH worksheet questions answers are compliant then you need to pass the responses to the IEH certification statement Y or N	These are to be determined by ETC on the basis of IEH worksheet
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE
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.

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>Vcarecorporation</VENDORID>
<USERNAME>Vcarecorporation</USERNAME>
<PASSWORD>Vcarecorporation</PASSWORD>
<PIN>Vcarecorporation</PIN>
<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
<CHANGEADDRESS>
	<CUSTOMERID>12345</CUSTOMERID>
	<CHANGETYPE>BOTH</CHANGETYPE>
	<IS_BYPASS_NLAD>Y</IS_BYPASS_NLAD>
	<ADDRESSTYPE></ADDRESSTYPE>
	<CITY>Baltimore</CITY>
	<STATE>MD</STATE>
	<ZIP>21215</ZIP>
	<ADDRESS1>123 Main St</ADDRESS1>
	<ADDRESS2>Apt 1</ADDRESS2>
	<BILLADDPO1></BILLADDPO1>
	<LIFELINE></LIFELINE>
	<ADULT>N</ADULT>
	<PARENT>N</PARENT>
	<RELATIVE>N</RELATIVE>
	<ROOMMATE>N</ROOMMATE>
	<SAMEADD></SAMEADD>
	<OTHER>N</OTHER>
	<SHARE>N</SHARE>
	<CERTIFI1>N</CERTIFI1>
	<CERTIFI2>N</CERTIFI2>
	<AGENTID>Zeeshan Ahmed</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
</CHANGEADDRESS>
</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.
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
25	Customer ID is invalid.	Provide a valid Customer ID.
226	Customer ID is required.	Please provide Customer 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.

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>Vcarecorporation</vendorId>
        <referenceNumber>11111</referenceNumber>
    </credentials>
 <GetCustomerInfo>
    <Changeaddress>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </Changeaddress>
</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>
<ChangeAddress>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</ChangeAddress>
</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>
<ChangeAddress>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ChangeAddress>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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>
<ChangeAddress>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ChangeAddress>
</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>
<ChangeAddress>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</ChangeAddress>
</VcareOssApi>

Error Description: Customer ID is invalid.

How to Resolve?: Provide a valid Customer ID.

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>
<ChangeAddress>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</ChangeAddress>
</VcareOssApi>

Error Description: Customer ID is required.

How to Resolve?: Please provide Customer ID.

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

Error Description: Agent ID cannot be blank.

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

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