InventoryReassign

This XML API is used to reassign ESN/SIM/IMEI from one agent to another

End Point https://www.vcareapi.com/vcareOssApi/InventoryReassign/
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 Auto generated unique reference number is required to be passed with each transaction.
REASSIGN TYPE string ESN OR DEVICE OR CDMA Required This determines the inventory type which you want to reassing ESN for SIM/ESN reassignment.DEVICE for IMEI/Device id reassignment
DEVICEID ESN string 890132161236545698 Required Mention ESN/SIM if REASSIGNTYPE is ESN and if it is DEVICE then mention IMEI/Device id  
ASSIGN TO Agent string testretailer Required Login id of the agent chain you would like to reassign the inventory to.  
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 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>
<INVENTORYREASSIGN>
	<REASSIGNTYPE></REASSIGNTYPE>
	<DEVICEID_ESN></DEVICEID_ESN>
	<ASSIGNTO></ASSIGNTO>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</INVENTORYREASSIGN>
</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.
292 Error. Error found. Please try again.
308 Device ID cannot be blank. Please provide Device ID.
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.
349 ESN cannot be blank. Please provide ESN as it cannot be blank.
350 ESN not valid. Please provide a valid ESN.
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.
354 Reassign Type should not be blank. Please provide Reassign Type as it cannot be blank.
355 Reassign Type not valid. Please provide a valid Reassign Type.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
359 Reassign Type should not be blank. Please provide Reassign Type as it cannot be blank.
360 CDMA cannot be blank. Please provide CDMA as it cannot be blank.
361 CDMA ID not valid. Please provide a valid CDMA.
362 CDMA ID must be greater than 8 and less than 26 characters. Please provide a valid CDMA and it must be greater than 8 and less than 26 characters.
366 Assign to cannot be blank. Please provide Assign to as it cannot be blank.
378 Assign to is not valid. Please provide a valid Assign to.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
534 Assign to should be an Active User. Provide an Active user for Assign to field.
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>11111111</referenceNumber>
    </credentials>
   <InventoryReassign>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </InventoryReassign>
</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>
<InventoryReassign>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</InventoryReassign>
</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>
<InventoryReassign>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</InventoryReassign>
</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>
<InventoryReassign>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</InventoryReassign>
</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>
<InventoryReassign>
	<statusCode>292</statusCode>
	<description>FAIL</description>
	<errorDescription>Error.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Error.
How to Resolve?: Error found. Please try again.
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>
<InventoryReassign>
	<statusCode>308</statusCode>
	<description>FAIL</description>
	<errorDescription>Device  ID cannot be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Device ID cannot be blank.
How to Resolve?: Please provide Device ID.
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>
<InventoryReassign>
	<statusCode>348</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID must be greater than 8 and less than 26 characters.</errorDescription>
</InventoryReassign>
</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: 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>
<InventoryReassign>
	<statusCode>349</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN cannot be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: ESN cannot be blank.
How to Resolve?: Please provide ESN 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>
<InventoryReassign>
	<statusCode>350</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN not valid.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: ESN not valid.
How to Resolve?: Please provide a valid ESN.
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>
<InventoryReassign>
	<statusCode>351</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN must be greater than 8 and less than 26 characters.</errorDescription>
</InventoryReassign>
</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: 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>
<InventoryReassign>
	<statusCode>354</statusCode>
	<description>FAIL</description>
	<errorDescription>Reassign Type should not be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Reassign Type should not be blank.
How to Resolve?: Please provide Reassign Type as it cannot be blank.
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>
<InventoryReassign>
	<statusCode>355</statusCode>
	<description>FAIL</description>
	<errorDescription>Reassign Type not valid.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Reassign Type not valid.
How to Resolve?: Please provide a valid Reassign Type.
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>
<InventoryReassign>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<InventoryReassign>
	<statusCode>359</statusCode>
	<description>FAIL</description>
	<errorDescription>Reassign Type should not be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Reassign Type should not be blank.
How to Resolve?: Please provide Reassign Type as it cannot 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>
<InventoryReassign>
	<statusCode>360</statusCode>
	<description>FAIL</description>
	<errorDescription>CDMA cannot be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: CDMA cannot be blank.
How to Resolve?: Please provide CDMA as it cannot be blank.
Sample Fail Response: 15
<?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>
<InventoryReassign>
	<statusCode>361</statusCode>
	<description>FAIL</description>
	<errorDescription>CDMA ID not valid.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: CDMA ID not valid.
How to Resolve?: Please provide a valid CDMA.
Sample Fail Response: 16
<?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>
<InventoryReassign>
	<statusCode>362</statusCode>
	<description>FAIL</description>
	<errorDescription>CDMA ID must be greater than 8 and less than 26 characters.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: CDMA ID must be greater than 8 and less than 26 characters.
How to Resolve?: Please provide a valid CDMA and it must be greater than 8 and less than 26 characters.
Sample Fail Response: 17
<?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>
<InventoryReassign>
	<statusCode>366</statusCode>
	<description>FAIL</description>
	<errorDescription>Assign to cannot be blank.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Assign to cannot be blank.
How to Resolve?: Please provide Assign to as it cannot be blank.
Sample Fail Response: 18
<?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>
<InventoryReassign>
	<statusCode>378</statusCode>
	<description>FAIL</description>
	<errorDescription>Assign to is not valid.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Assign to is not valid.
How to Resolve?: Please provide a valid Assign to.
Sample Fail Response: 19
<?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>
<InventoryReassign>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
Sample Fail Response: 20
<?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>
<InventoryReassign>
	<statusCode>534</statusCode>
	<description>FAIL</description>
	<errorDescription>Assign to should be an Active User.</errorDescription>
</InventoryReassign>
</VcareOssApi>
Error Description: Assign to should be an Active User.
How to Resolve?: Provide an Active user for Assign to field.

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