AddAndActivate

This XML API is used add the SIM/ESN stock in the inventory. This API also assigns the inventory to the agents and also activates the inventory on the specified plan at the carrier level.

End Point https://www.vcareapi.com/vcareOssApi/AddAndActivate/
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.
COMPANY ID Numeric 31 Required This can be obtained using GetCompany API  
ESN / SIM String 8901123654789654123 Required This is the SIM/ESN which needs to be added and provisioned in the inventory  
UICCID String 8901123654789654123 Conditional This is required in case of CDMA 4G.  
SIM CARD String Y Required If the value you are passing in the ESN field is a SIM CARD, you need to pass Y. Y or N
CARRIER String TMB Required Available carrier code list can be otained using GetCompanyCarrier API  
MODEL ID Numeric 12 Required This can be obtained using the GetMakeModel API  
NOTES String This is a test SIM Optional This is the notes field Max 1000 characters
SELLING PRICE Decimal 5.00 Optional This is the price that will need to be paid by subscriber being assigned with this ESN/SIM. If it needs to be free, you my pass empty Please pass decimal value.
WHOLESALE PRICE Decimal 3.00 Optional This is the price at which the inventory was bought from the vendor/wholeseller Please pass decimal value.
BOX NUMBER String 6464646 Required This is the box number in which the inventory have been packed Max 25 digits
MSL / PUK1 Numeric 123456 Conditional Required in case of TMB, SPRINT.  
PUK2 Numeric 654123 Optional This is the PUK2 in case you are loading the SIM inventory  
PURCHASE ORDER # String PO123698 Required This is the purchase order number cannot be duplicate for different batches of the inventory
VENDOR ID String Vcare Required This is the vendor/wholeseller from whom the inventory was purchased. Available vendor id list can be otained using GetVendorAndShipperID API  
SKU String PO123698SK Required This is the SKU number. You are able to pass a duplicate value provided AGENT ID being passed has permissions to be add inventory to an existing SKU.
TIN String 254Xcv497 Optional This is the Tax Identification number  
TRACKING NUMBER String 36454543545 Required This is the tracking number for the shipment in which in this inventory is being sent to the agent. Max 30 digits
ZIP CODE String 21215 Required This is the zip code on which the ESN/SIM will be activated 5 digits allowed
PLAN ID String 1315 Required This is the plan id on which the ESN/SIM will be activated at the carrier level. The plan id can be obtained from GetPlanService API  
AGENT TYPE String Retailer Required This is the chain level of 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  
PLANTYPEID Numeric 654123 Conditional This is the PLANTYPEID in case you are loading the CDMA 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.
BYOD String Y Optional BYOD Value Y or N
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>
 <ADDANDACTIVATE>
	<COMPANYID></COMPANYID>
	<ESN></ESN>
	<UICCID></UICCID>
	<SIMCARD></SIMCARD>
	<CARRIER></CARRIER>
	<MODELID></MODELID>
	<NOTES></NOTES>
	<SPRICE></SPRICE>
	<WPRICE></WPRICE>
	<ACTFEE></ACTFEE>
	<BOX></BOX>
	<MSL></MSL>
	<PUK2></PUK2>
	<PO></PO>
	<UPS></UPS>
	<VENDOR></VENDOR>
	<SKU></SKU>
	<TIN></TIN>
	<ZIPCODE></ZIPCODE>
	<PLANID></PLANID>
	<AGENTTYPE></AGENTTYPE>
	<AGENTVALUE></AGENTVALUE>
	<PLANTYPEID></PLANTYPEID>
	<BYOD></BYOD>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
  </ADDANDACTIVATE>
 </VCAREOSS>
</VCAREOSSAPI>
List of status code and description.
Status Code Description
00 SUCCESS
13 Password is invalid.
16 Vendor not found. Wrong credentials.
22 Plan not found.
41 Carrier is invalid.
203 Invalid PlanID.
338 UPS Tracking is required.
340 UPS Tracking cannot be duplicate value.
356 Agent ID cannot be blank.
457 Invalid Source.
468 Activation fee type should positive value.
532 MSL is required.
605 Plan Type ID Inactive.
606 Plan Type ID not found.
607 Plan Type ID is required.
608 Invalid Plan Type ID.
614 The plan type ID which you are passing does not have the plan id included on which you want to activate the ESN.
751 Custom message.
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>
    <AddAndActivate>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <response_error></response_error>
        <response>SUCCESSFULLY ACTIVATED</response>
       <mdn></mdn>
	 </AddAndActivate>
</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>
<AddAndActivate>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Password is invalid.
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>
<AddAndActivate>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Vendor not found. Wrong 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>
<AddAndActivate>
	<statusCode>22</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan not found.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Plan not found.
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>
<AddAndActivate>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Carrier is invalid.
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>
<AddAndActivate>
	<statusCode>203</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid PlanID.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Invalid PlanID.
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>
<AddAndActivate>
	<statusCode>338</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking is required.</errorDescription>
</AddAndActivate>
</VcareOssApi>
UPS Tracking 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>
<AddAndActivate>
	<statusCode>340</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking cannot be duplicate value.</errorDescription>
</AddAndActivate>
</VcareOssApi>
UPS Tracking cannot be duplicate value.
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>
<AddAndActivate>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Agent ID cannot be blank.
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>
<AddAndActivate>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Invalid Source.
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>
<AddAndActivate>
	<statusCode>468</statusCode>
	<description>FAIL</description>
	<errorDescription>Activation fee type should positive value.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Activation fee type should positive value.
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>
<AddAndActivate>
	<statusCode>532</statusCode>
	<description>FAIL</description>
	<errorDescription>MSL is required.</errorDescription>
</AddAndActivate>
</VcareOssApi>
MSL is required.
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>
<AddAndActivate>
	<statusCode>605</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID Inactive.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Plan Type ID Inactive.
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>
<AddAndActivate>
	<statusCode>606</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID not found.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Plan Type ID not found.
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>
<AddAndActivate>
	<statusCode>607</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID is required.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Plan Type ID is required.
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>
<AddAndActivate>
	<statusCode>608</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Plan Type ID.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Invalid Plan Type ID.
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>
<AddAndActivate>
	<statusCode>614</statusCode>
	<description>FAIL</description>
	<errorDescription>The plan type ID which you are passing does not have the plan id included on which you want to activate the ESN.</errorDescription>
</AddAndActivate>
</VcareOssApi>
The plan type ID which you are passing does not have the plan id included on which you want to activate the ESN.
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>
<AddAndActivate>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</AddAndActivate>
</VcareOssApi>
Custom message.

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