Telgoo5 APIs

QueryDevice

This API is used to get the QueryDevice details.

End Point	https://www.vcareapi.com/vcareOssApi/QueryDevice/
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		Numeric	358823054577013	Required	A unique IMEI.
COMPANY ID		Numeric	1	Required	A unique company id assigned to the MVNO.
CARRIER		string	TMB	Required	This accepts Carrier abbreviation configured for a carrier in Telgoo5.
TAC		string	1	Optional
MODEL		string	1	Optional
NAME		string	John	Optional
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 not 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-16"?>
<VcareOssApi xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns="http://www.oss.vcarecorporation.com/oss">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
    <REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
  <QUERYDEVICE>	 
	<IMEI></IMEI>
	<COMPANY_ID></COMPANY_ID>
	<CARRIER></CARRIER>
	<TAC></TAC>
	<MODEL></MODEL>
	<NAME></NAME>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
  </QUERYDEVICE>
</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.
169	Company ID is required.	Please provide company ID.
170	Carrier ID is required.	Please provide a Carrier ID.
493	IMEI should not be blank.	Provide correct IMEI. IMEI should not be blank.
751	Custom message.	This is dynamic message.

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>
    <QueryDevice>
        <statusCode>00</statusCode>
		<description>SUCCESS</description>
		<errorDescription>SUCCESS</errorDescription>
		<IMEI></IMEI>
		<MODEL></MODEL>
		<MARKETINGNAME></MARKETINGNAME>
		<MANUFACTURER></MANUFACTURER>
		<TAC></TAC>
		<NAME></NAME>
		<BAND12COMPATIBLE></BAND12COMPATIBLE>
		<VOLTECOMPATIBLE></VOLTECOMPATIBLE>
		<WIFICOMPATIBLE></WIFICOMPATIBLE>
		<NETWORKCOMPATIBLE></NETWORKCOMPATIBLE>
		<NETWORKTECHNOLOGY></NETWORKTECHNOLOGY>
		<TMOBILEAPPROVED></TMOBILEAPPROVED>
		<DUALBANDWIFI></DUALBANDWIFI>
		<IMS></IMS>
		<IPV6></IPV6>
		<PASSPOINT></PASSPOINT>
		<ROAMINGIMS></ROAMINGIMS>
		<VOLTEEMERGENCYCALLING></VOLTEEMERGENCYCALLING>
		<WIFICALLINGVERSION></WIFICALLINGVERSION>
		<GPRS></GPRS>
		<HSDPA></HSDPA>
		<HSPA></HSPA>
		<VOLTE></VOLTE>
		<VOWIFI></VOWIFI>
		<WIFI></WIFI>
		<BANDS></BANDS>
		<ESIM></ESIM>
		<REMOTESIMUNLOCK></REMOTESIMUNLOCK>
		<SIMSIZE></SIMSIZE>
		<SIMSLOTS></SIMSLOTS>
		<WLAN></WLAN>
		<LTE></LTE>
		<LTEADVANCED></LTEADVANCED>
		<LTECATEGORY></LTECATEGORY>
		<UMTS></UMTS>
		<CHIPSETMODEL></CHIPSETMODEL>
		<CHIPSETNAME></CHIPSETNAME>
		<CHIPSETVENDOR></CHIPSETVENDOR>
		<DEVICETYPE></DEVICETYPE>
		<OSNAME></OSNAME>
		<PRIMARYHARDWARETYPE></PRIMARYHARDWARETYPE>
		<YEARRELEASED></YEARRELEASED>
		<TECHNOLOGYONTHEDEVICE></TECHNOLOGYONTHEDEVICE>
	</QueryDevice>
</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>
<QueryDevice>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</QueryDevice>
</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>
<QueryDevice>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</QueryDevice>
</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>
<QueryDevice>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</QueryDevice>
</VcareOssApi>

Error Description: Company ID is required.

How to Resolve?: Please provide company ID.

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>
<QueryDevice>
	<statusCode>170</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier ID is required.</errorDescription>
</QueryDevice>
</VcareOssApi>

Error Description: Carrier ID is required.

How to Resolve?: Please provide a Carrier 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>
<QueryDevice>
	<statusCode>493</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI should not be blank.</errorDescription>
</QueryDevice>
</VcareOssApi>

Error Description: IMEI should not be blank.

How to Resolve?: Provide correct IMEI. IMEI should not 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>
<QueryDevice>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</QueryDevice>
</VcareOssApi>

Error Description: Custom message.

How to Resolve?: This is dynamic message.

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