IMEILookup

This XML API returns the status of the IMEI/GSM device, if the given IMEI/GSM device 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 IMEI/GSM device 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 IMEI/GSM device along with the Model and the selling price of the IMEI/GSM device wherever applicable

End Point https://www.vcareapi.com/vcareOssApi/IMEILookup/
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.
REFERENCENUMBER string 123456789 Required Auto generated unique reference number is required to be passed with each transaction.
IMEI string 355276482290779 Required This is the IMEI/Device ID which needs to be assigned to the applicant. Before the assignment agent will need to verify if the IMEI/Device ID is assigned to him or not in the inventory Can be alpha numeric. Max length = 25
GETIMEIDETAILS string Y/N Optional When we pass "Y" in GETIMEIDETAILS tag then it will return the detailed information for the IMEI/Device ID in response
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>
  <IMEILOOKUP>
   <IMEI></IMEI>
   <GETIMEIDETAILS></GETIMEIDETAILS>
   <AGENTID></AGENTID>
   <AGENTPASSWORD></AGENTPASSWORD>
   <SOURCE>API</SOURCE>
   </IMEILOOKUP>
 </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.
55 Invalid agent login. Please provide valid agent login.
88 IMEI Invalid. Please provide valid IMEI.
91 IMEI is not assigned to given agent. Please provide IMEI assigned to the given agent.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
406 Device does not exist in system. Device does not exist in system.
407 Device is not assigned to given agent OR Master/Distributor/Retailer. Device is not assigned to the agent you have given.
408 Device attached with the enrollment ID. Device is assigned to different customer.
409 Device is found in system as Bad status. Device id has BAD as status in database.
410 Device is found in system as Removed status. Device id has Removed as status in database.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
493 IMEI should not be blank. Provide correct IMEI. IMEI should not be blank.
495 IMEI must be greater than 8 and less than 20 characters. Provide correct IMEI which must be greater than 8 and less than 20 characters.
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></vendorId>
        <referenceNumber></referenceNumber>
    </credentials>
    <IMEILookup>
	<statusCode>00</statusCode>
	<description>SUCCESS</description>
	<errorDescription>IMEI Free to be used.</errorDescription>
	<model_id></model_id>
	<model_name></model_name>
	<selling_price></selling_price>
    </IMEILookup>
</VcareOssApi>

SUCCESS

List of all the status codes will be shared separately.

<model> This is the make and model of the ESN/SIM it will be returned wherever 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>
	<IMEILookup>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</IMEILookup>
</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>
	<IMEILookup>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</IMEILookup>
</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>
	<IMEILookup>
	<statusCode>55</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid agent login.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Invalid agent login.
How to Resolve?: Please provide valid agent login.
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>
	<IMEILookup>
	<statusCode>88</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI Invalid.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: IMEI Invalid.
How to Resolve?: Please provide valid IMEI.
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>
	<IMEILookup>
	<statusCode>91</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI is not assigned to given agent.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: IMEI is not assigned to given agent.
How to Resolve?: Please provide IMEI assigned to the 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>
	<IMEILookup>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</IMEILookup>
</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>
	<IMEILookup>
	<statusCode>406</statusCode>
	<description>FAIL</description>
	<errorDescription>Device does not exist in system.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Device does not exist in system.
How to Resolve?: Device does not exist in system.
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>
	<IMEILookup>
	<statusCode>407</statusCode>
	<description>FAIL</description>
	<errorDescription>Device is not assigned to given agent OR Master/Distributor/Retailer.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Device is not assigned to given agent OR Master/Distributor/Retailer.
How to Resolve?: Device is not assigned to the agent you have given.
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>
	<IMEILookup>
	<statusCode>408</statusCode>
	<description>FAIL</description>
	<errorDescription>Device attached with the enrollment ID.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Device attached with the enrollment ID.
How to Resolve?: Device is assigned to different 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>
	<IMEILookup>
	<statusCode>409</statusCode>
	<description>FAIL</description>
	<errorDescription>Device is found in system as Bad status.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Device is found in system as Bad status.
How to Resolve?: Device id has BAD as status in database.
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>
	<IMEILookup>
	<statusCode>410</statusCode>
	<description>FAIL</description>
	<errorDescription>Device is found in system as Removed status.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Device is found in system as Removed status.
How to Resolve?: Device id has Removed as status in database.
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>
	<IMEILookup>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
	<IMEILookup>
	<statusCode>493</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI should not be blank.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: IMEI should not be blank.
How to Resolve?: Provide correct IMEI. IMEI should not be blank.
Sample Fail Response: 14
<?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>
	<IMEILookup>
	<statusCode>495</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI must be greater than 8 and less than 20 characters.</errorDescription>
</IMEILookup>
</VcareOssApi>
Error Description: IMEI must be greater than 8 and less than 20 characters.
How to Resolve?: Provide correct IMEI which must be greater than 8 and less than 20 characters.

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