AddDevice

This XML API is used add the GSM/IMEI stock in the inventory and assign it to the agents.

End Point https://www.vcareapi.com/vcareOssApi/AddDevice/
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.
DEVICE ID / IMEI # string 3521390500041234 Required This is the GSM Device/IMEI which needs to be added in the inventory  
CARRIER string TMB Required Available carrier list can be obtained using GetCompanyCarrier API  
NOTES string This is a test Device Optional This is the notes field Max 1000 charaters
COMPANY ID Numeric 1 Required This can be obtained using GetCompany API  
VENDOR ID string testvendor Required This is the vendor/wholeseller from whom the inventory was purchased. Available vendor id list can be otained using GetVendorAndShipperID API  
TRACKING NUMBER string 9565458569654520 Optional This is the tracking number of the box of the inventory which is being shipped to the agent  
MODEL ID Numeric 12 Required This can be obtained using the GetMakeModel API  
BOX NUMBER Numeric 6464646 Required This is the box number in which the inventory have been packed  
TIN string 254Xcv497 Optional This is the Tax Identification number  
SELLING PRICE Decimal 5.50 Optional This is the price subscriber needs to pay while purchasing this unit. Please pass decimal value.
WHOLESALE COST Decimal 3.65 Optional This is the price at which the inventory was bought from the vendor/wholeseller Please pass decimal value.
AGENT TYPE string Retailer Conditional This is the levelof the agent to which you are assigning the inventory MASTER,DISTRIBUTOR,RETAILER
ASSIGN TO AGENT string TestRetailer Required This is the Telgoo5 login Id of the agent you are assigning the inventory to  
PURCHASE ORDER # string PO123698 Required This is the purchase order number
PLANTYPEID Numeric 654123 Conditional This is the PLANTYPEID in case you are loading the GSM device in inventory. Available plantypeid list can be otained using GetPlanType API This is a required field if in System config>>Inventory>>Add Update/Assign Plan Type For Plan Filtering is marked as Y. If this is marked as N then this is not required.
AGENT ID string John Doe Required
This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
  
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  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>
  <ADDDEVICE>
	<DEVICEID></DEVICEID>
	<CARRIER></CARRIER>
	<NOTES></NOTES>
	<COMPANYID></COMPANYID>
	<VENDOR></VENDOR>
	<TRACKINGNUMBER></TRACKINGNUMBER>
	<MODELID></MODELID>
	<BOX></BOX>
	<TIN></TIN>
	<SELLPRICE></SELLPRICE>
	<WHOLESALEPRICE></WHOLESALEPRICE>
	<AGENTTYPE></AGENTTYPE>
	<AGENTVALUE></AGENTVALUE>
	<PO></PO>
	<PLANTYPEID></PLANTYPEID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
  </ADDDEVICE>
 </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.
225 Model ID is required. Please provide Model ID.
338 UPS Tracking is required. Please provide UPS Tracking as it is required.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
376 Model ID is not valid. Please provide a valid Model ID.
449 Carrier should not be blank. Carrier can not be blank. You should enter a valid Carrier.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
497 Vendor should not be blank. Provide a valid Vendor. Vendor should not be blank.
500 Agent type should not be blank. Provide a valid Agent type. Agent type should not be blank.
501 Invalid agent type. Please provide a valid agent type. Given value is invalid for agent type.
502 Agent value should not be blank. Provide a valid Agent value. Agent value should not be blank.
503 PO should not be blank. Provide a valid PO. PO should not be blank.
605 Plan Type ID Inactive. Please provide an active Plan Type ID. Given Plan Type ID is inactive.
606 Plan Type ID not found. Please provide a valid Plan Type. Given Plan Type is not available.
607 Plan Type ID is required. Please enter a Plan Type ID. Plan Type ID should not be blank.
608 Invalid Plan Type ID. Please provide a valid Plan Type ID. Given value is invalid for Plan Type ID.
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>Vcarecorporation</vendorId>
        <referenceNumber>11111</referenceNumber>
    </credentials>
       <AddDevice>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <lastInventoryId>11236549791</lastInventoryId>
    </AddDevice>
</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>
<AddDevice>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</AddDevice>
</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>
<AddDevice>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddDevice>
</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>
<AddDevice>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AddDevice>
</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>
<AddDevice>
	<statusCode>206</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID cannot be blank.</errorDescription>
</AddDevice>
</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>
<AddDevice>
	<statusCode>225</statusCode>
	<description>FAIL</description>
	<errorDescription>Model ID is required.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Model ID is required.
How to Resolve?: Please provide Model 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>
<AddDevice>
	<statusCode>338</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking is required.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: UPS Tracking is required.
How to Resolve?: Please provide UPS Tracking as it is required.
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>
<AddDevice>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID 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>
<AddDevice>
	<statusCode>376</statusCode>
	<description>FAIL</description>
	<errorDescription>Model ID is not valid.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Model ID is not valid.
How to Resolve?: Please provide a valid Model ID.
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>
<AddDevice>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Carrier should not be blank.
How to Resolve?: Carrier can not be blank. You should enter a valid Carrier.
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>
<AddDevice>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<AddDevice>
	<statusCode>497</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor should not be blank.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Vendor should not be blank.
How to Resolve?: Provide a valid Vendor. Vendor should not be blank.
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>
<AddDevice>
	<statusCode>500</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent type should not be blank.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Agent type should not be blank.
How to Resolve?: Provide a valid Agent type. Agent type should not 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>
<AddDevice>
	<statusCode>501</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid agent type.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Invalid agent type.
How to Resolve?: Please provide a valid agent type. Given value is invalid for agent type.
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>
<AddDevice>
	<statusCode>502</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent value should not be blank.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Agent value should not be blank.
How to Resolve?: Provide a valid Agent value. Agent value should not 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>
<AddDevice>
	<statusCode>503</statusCode>
	<description>FAIL</description>
	<errorDescription>PO should not be blank.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: PO should not be blank.
How to Resolve?: Provide a valid PO. PO should not be blank.
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>
<AddDevice>
	<statusCode>605</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID Inactive.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Plan Type ID Inactive.
How to Resolve?: Please provide an active Plan Type ID. Given Plan Type ID is inactive.
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>
<AddDevice>
	<statusCode>606</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID not found.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Plan Type ID not found.
How to Resolve?: Please provide a valid Plan Type. Given Plan Type is not available.
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>
<AddDevice>
	<statusCode>607</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID is required.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Plan Type ID is required.
How to Resolve?: Please enter a Plan Type ID. Plan Type ID should not be blank.
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>
<AddDevice>
	<statusCode>608</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Plan Type ID.</errorDescription>
</AddDevice>
</VcareOssApi>
Error Description: Invalid Plan Type ID.
How to Resolve?: Please provide a valid Plan Type ID. Given value is invalid for Plan Type ID.

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