Telgoo5 APIs

DeviceLookup

This XML API returns the status of the SIM/ESN, if the given SIM/ESN is assigned to the Master agent/Distributor/Retailer of the agent who is making the API call or it is assigned to the agent itself or not. If the SIM/ESN is not assigned to the agent or its master/distributor/retailer then the API call will fail. The API also returns the status of the SIM/ESN along with the Model and the selling price of the SIM/ESN where applicable

End Point	https://www.vcareapi.com/vcareOssApi/DeviceLookup/
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 / SIM		string	8901260713156280780	Required	This is the SIM/ESN which you would like to enquire about. Before assigning an ESN/sIM to an applicant, agent will need to verify if the SIM/ESN is assigned to him or not in the inventory	Can be alpha numeric. Max length = 25
GET DEVICE DETAILS		string	Y OR N	Optional	If Need to show device details field must be value Y
AGENT ID		string	John Doe	Optional	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="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>
<DEVICELOOKUP>
	<ESN></ESN>
	<GETDEVICEDETAILS></GETDEVICEDETAILS>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</DEVICELOOKUP>
</VCAREOSS>
</VCAREOSSAPI>

List of status code, description and resolution.
Status Code	Description	How to Resolve?
00	SUCCESS	SUCCESS
04	ESN does not exist in system.	Provide a valid ESN that exists in the system.
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
54	Device look-up not found.	Please provide valid Device look-up. Device look-up is not found.
67	ESN is not assigned to given agent.	Please provide ESN assigned to given agent.
194	ESN should not be blank.	Please provide ESN. ESN cannot be left blank.
351	ESN must be greater than 8 and less than 26 characters.	Please provide a valid ESN and it must be greater than 8 and less than 26 characters.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
385	ESN/SIM is attached with the customer.	ESN/SIM is attached with the customer.
386	ESN is found in system as Bad status.	ESN is found in system as Bad status.
387	ESN is found in system as Removed status.	ESN is found in system as Removed status.
388	ESN is not assigned to given agent OR Master/Distributor/Retailer.	Please assign ESN to given agent OR Master/Distributor/Retailer.
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>
    <DeviceLookup>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <LookupData>
            <esn></esn>
            <uiccid></uiccid>
			<mdn></mdn>
            <status></status>
            <carrier></carrier>
            <model_id></model_id>
            <model_name></model_name>
            <selling_price></selling_price>
            <carrier_code></carrier_code>
        </LookupData>
    </DeviceLookup>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared separately.

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

<mdn>If the ESN/SIM is preactivated we also return the MDN which is associated with the ESN/SIM. If the ESN/SIM is not preactivated then this field shall be blank.

<status> This can have two possible values. 'Provision Success' this means that the ESN/SIM is preactivated and you will be required to pass the same mdn and esn which is returned in this API in the createcustomer too.'Not Provisioned' this means that the ESN/SIM is non-active and will be activated at the time createcustomer, you will only need to pass the correct SIM/ESN and it will be activated on the plan which you send in the createcustomer

API

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

<model> This is the make and model of the ESN/SIM it will be returned where applicable.

<sellingprice>This is the selling price of the SIM/ESN

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>
	<DeviceLookup>
	<statusCode>04</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN does not exist in system.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN does not exist in system.

How to Resolve?: Provide a valid ESN that exists in the system.

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>
	<DeviceLookup>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</DeviceLookup>
</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>
	<DeviceLookup>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</DeviceLookup>
</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>
	<DeviceLookup>
	<statusCode>54</statusCode>
	<description>FAIL</description>
	<errorDescription>Device look-up not found.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: Device look-up not found.

How to Resolve?: Please provide valid Device look-up. Device look-up is not found.

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>
	<DeviceLookup>
	<statusCode>67</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is not assigned to given agent.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN is not assigned to given agent.

How to Resolve?: Please provide ESN assigned to given agent.

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>
	<DeviceLookup>
	<statusCode>194</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN should not be blank.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN should not be blank.

How to Resolve?: Please provide ESN. ESN cannot be left 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>
	<DeviceLookup>
	<statusCode>351</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN must be greater than 8 and less than 26 characters.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN must be greater than 8 and less than 26 characters.

How to Resolve?: Please provide a valid ESN and it must be greater than 8 and less than 26 characters.

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

Error Description: Agent ID cannot be blank.

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

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>
	<DeviceLookup>
	<statusCode>385</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN/SIM is attached with the customer.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN/SIM is attached with the customer.

How to Resolve?: ESN/SIM is attached with the customer.

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>
	<DeviceLookup>
	<statusCode>386</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is found in system as Bad status.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN is found in system as Bad status.

How to Resolve?: ESN is found in system as Bad status.

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>
	<DeviceLookup>
	<statusCode>387</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is found in system as Removed status.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN is found in system as Removed status.

How to Resolve?: ESN is found in system as Removed status.

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>
	<DeviceLookup>
	<statusCode>388</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN is not assigned to given agent OR Master/Distributor/Retailer.</errorDescription>
</DeviceLookup>
</VcareOssApi>

Error Description: ESN is not assigned to given agent OR Master/Distributor/Retailer.

How to Resolve?: Please assign ESN to given agent OR Master/Distributor/Retailer.

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