Telgoo5 APIs

DeviceStatusChange

This XML API is used to change the status of Device in the inventory

End Point	https://www.vcareapi.com/vcareOssApi/DeviceStatusChange/
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.
DEVICEID		string	3521390500041234	Required	Device ID for which you need to change the status	Can be alpha numeric. Max length = 25
STATUS		string	BAD	Required	This is the new status to which the current status will be updated to	FREE, USED, BAD,REMOVED
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>
<DEVICESTATUSCHANGE>
	<DEVICEID></DEVICEID>
	<AGENTACCOUNT></AGENTACCOUNT>
	<STATUS></STATUS>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</DEVICESTATUSCHANGE>
</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.
206	Device ID cannot be blank.	Please provide valid value as Device ID cannot be blank.
348	Device ID must be greater than 8 and less than 26 characters.	Please provide a valid Device ID 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.
411	Device ID is not available in our system.	This Device ID is not available in system.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
585	Device status should be FREE, USED, BAD, REMOVED.	Choose anyone among FREE or USED or BAD or REMOVED for Device Status.
586	Device status required.	Provide a Device status. Device status is mandatory.

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>1111111111</referenceNumber>
    </credentials>
   <DeviceStatusChange>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </DeviceStatusChange>
</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>
<DeviceStatusChange>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</DeviceStatusChange>
</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>
<DeviceStatusChange>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</DeviceStatusChange>
</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>
<DeviceStatusChange>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</DeviceStatusChange>
</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>
<DeviceStatusChange>
	<statusCode>206</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID cannot be blank.</errorDescription>
</DeviceStatusChange>
</VcareOssApi>

Error Description: Device ID cannot be blank.

How to Resolve?: Please provide valid value as Device ID cannot be blank.

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>
<DeviceStatusChange>
	<statusCode>348</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID must be greater than 8 and less than 26 characters.</errorDescription>
</DeviceStatusChange>
</VcareOssApi>

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

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

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>
<DeviceStatusChange>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</DeviceStatusChange>
</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>
<DeviceStatusChange>
	<statusCode>411</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID is not available in our system.</errorDescription>
</DeviceStatusChange>
</VcareOssApi>

Error Description: Device ID is not available in our system.

How to Resolve?: This Device ID is not available 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>
<DeviceStatusChange>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</DeviceStatusChange>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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>
<DeviceStatusChange>
	<statusCode>585</statusCode>
	<description>FAIL</description>
	<errorDescription>Device status should be FREE, USED, BAD, REMOVED.</errorDescription>
</DeviceStatusChange>
</VcareOssApi>

Error Description: Device status should be FREE, USED, BAD, REMOVED.

How to Resolve?: Choose anyone among FREE or USED or BAD or REMOVED for Device Status.

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>
<DeviceStatusChange>
	<statusCode>586</statusCode>
	<description>FAIL</description>
	<errorDescription>Device status required.</errorDescription>
</DeviceStatusChange>
</VcareOssApi>

Error Description: Device status required.

How to Resolve?: Provide a Device status. Device status is mandatory.

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