Telgoo5 APIs

Device Inquiry | Validate Device

This API can be used to validate a CDMA device on carrier.

End Point	https://www.vcareapi.com/vcareOssApi/DeviceInquiry/
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	Reference number is required to be passed with each transaction.
ESN		string	2701256280780	Required	This is the ESN you would like to validate on carrier. This will validate ESNs for Sprint, Verizon and Telispire.	Can be alpha numeric. Max length = 25
AGENT ID		string	John Doe	Required	This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.	For WEBSITE source AGENT ID is optional
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.
SOURCE		string	API	Optional	This is the source where the API. This could be API, TABLET, IVR, WEBSITE etc.	For WEBSITE source AGENT ID is optional

Sample Request XML

<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<DEVICEINQUIRY>
	<ESN></ESN>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</DEVICEINQUIRY>
</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.
169	Company ID is required.	Please provide company ID.
194	ESN should not be blank.	Please provide ESN. ESN cannot be left blank.
260	ESN/SIM not found in our inventory.	Please provide either provisioned ESN or not provisioned ESN of Status as free
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
449	Carrier should not be blank.	Carrier can not be blank. You should enter a valid Carrier.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.

Sample Response XML

Sample response 1 : Sprint

<?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>1111111111</referenceNumber>
    </credentials>
    <DeviceInquiry>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <esn></esn>
        <availabilitytypecode></availabilitytypecode>
        <manufacturername></manufacturername>
        <validationmessage></validationmessage>
        <modelname></modelname>
        <modelnumber></modelnumber>
        <freqmode></freqmode>
        <equipmentfreqtypecode></equipmentfreqtypecode>
        <esnmeidhex></esnmeidhex>
        <devicetype></devicetype>
        <activationstatus></activationstatus>
        <devicefedmetind></devicefedmetind>
        <pocswapind></pocswapind>
        <esn2></esn2>
        <macid></macid>
        <iccid></iccid>
        <imsi></imsi>
        <uiccsku></uiccsku>
        <uiccavailabilitycode></uiccavailabilitycode>
        <uiccnotavailablereasoncode></uiccnotavailablereasoncode>
        <uicccompatibility></uicccompatibility>
        <uicctype></uicctype>
    </DeviceInquiry>
</VcareOssApi>


Sample response 2 : Telispire (Verizon)


<?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>1111111111</referenceNumber>
    </credentials>
    <DeviceInquiry>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <esn></esn>
		<deviceId></deviceId>
		<isValid></isValid>
		<isInDMD></isInDMD>
		<isPIBLock></isPIBLock>
		<isLostOrStolen></isLostOrStolen>
		<make></make>
		<model></model>
		<returnCode></returnCode>
		<returnMessage></returnMessage>
    </DeviceInquiry>
</VcareOssApi>

Sample response 3 : Incase if you happen to pass an ESN/SIM in the ESN field and carrier is any other then Sprint,Verizon and Telipsire (Verizon).


<?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>1111111111</referenceNumber>
    </credentials>
    <DeviceInquiry>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <makemodel>
				<model_id></model_id>
				<make></make>
				<model></model>
				<NetworkType></NetworkType>
				<FCC_ID></FCC_ID>
				<HAC></HAC>
				<WiFi></WiFi>
				<Data></Data>
				<OS></OS>
				<voice_only></voice_only>
				<hotspot_capable></hotspot_capable>
				<mrating></mrating>
				<trating></trating>
				<SKU></SKU>
				<color></color>
				<phone_scoop></phone_scoop>
				<video_player></video_player>
				<bluetooth></bluetooth>
				<camera></camera>
				<data_comp></data_comp>
				<mp_three></mp_three>
				<free_bonus_pack></free_bonus_pack>
			</makemodel>
    </DeviceInquiry>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared seperately.

<esn> This is the same ESN which was passed in the request.

API

<carrier> This is the carrier to which the given ESN belongs to.

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>
<DeviceInquiry>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</DeviceInquiry>
</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>
<DeviceInquiry>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</DeviceInquiry>
</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>
<DeviceInquiry>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</DeviceInquiry>
</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>
<DeviceInquiry>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</DeviceInquiry>
</VcareOssApi>

Error Description: Company ID is required.

How to Resolve?: Please provide company 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>
<DeviceInquiry>
	<statusCode>194</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN should not be blank.</errorDescription>
</DeviceInquiry>
</VcareOssApi>

Error Description: ESN should not be blank.

How to Resolve?: Please provide ESN. ESN cannot be left 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>
<DeviceInquiry>
	<statusCode>260</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN/SIM not found in our inventory.</errorDescription>
</DeviceInquiry>
</VcareOssApi>

Error Description: ESN/SIM not found in our inventory.

How to Resolve?: Please provide either provisioned ESN or not provisioned ESN of Status as free

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>
<DeviceInquiry>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</DeviceInquiry>
</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>
<DeviceInquiry>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</DeviceInquiry>
</VcareOssApi>

Error Description: Carrier should not be blank.

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

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