AddAndAssignNonActivate

This XML API is used add the SIM/ESN stock in the inventory. This API also assigns the inventory to the agents without activating it. This inventory is activated at the time of customer creation

End Point https://www.vcareapi.com/vcareOssApi/AddAndAssignNonActivate/
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 1 Required This can be obtained using GetCompany API  
ESN / SIM String 8901123654789654123 Required This is the SIM/ESN which needs to be added and assigned to the agent in the inventory  
BOX NUMBER String 6464646 Required This is the box number in which the inventory have been packed  
PURCHASE ORDER # String PO123698 Required This is the purchase order number cannot be duplicate for different batches of the inventory
TRACKING NUMBER String Required This is the tracking number of the Inventory being shipped to the Agent chain. Max 30 digits
SELLING PRICE Decimal 5.00 Optional Selling Price - This is the price at which the inventory will be sold out. If no value passed, it will be considered as free. Please pass decimal value.
WHOLESALE PRICE Decimal 3.00 Optional Wholesale price - This is the price at which the inventory was bought from the vendor/wholeseller Please pass decimal value.
MODEL ID Numeric 12 Required This can be obtained using the GetMakeModel API  
UICCID String 8901123654789654123 Conditional This is required in case of CDMA 4G.  
TIN String 254Xcv497 Optional This is the Tax Identification number  
SKU String PO123698SK Optional This is the SKU (stock keeping Unit) number You are able to pass duplicate SKU provided Agend ID passed with this reqquest has been permitted for the same in Telgoo5.
MSL / PUK String 123456 Conditional Required where Carrier Code = TMB or SPR.  
NOTES String This is a test SIM Optinal This is the notes field Max 1000 characters.
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.  
CARRIER CODE String TMB Required Available carrier list can be otained using GetCompanyCarrier API Carrier Code configured in Telgoo5 only
PUK2 String 654123 Optional This is the PUK2 in case you are loading the SIM inventory  
AGENT TYPE String Retailer Required This is the agent chain 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 chain you are assigning the inventory to Agent Chain login only
SIM CARD String Y Required Y will mark this inventory as a Sim card in the inventor. N will considered as CDMA. Y or N
PLANTYPEID Numeric 654123 Conditional This is the PLANTYPEID in case you are loading the CDMA device 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, POS, 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>
	<ADDANDASSIGNNONACTIVATE>
		<COMPANYID></COMPANYID>
		<ESN></ESN>
		<BOX></BOX>
		<PO></PO>
		<UPS></UPS>
		<SPRICE></SPRICE>
		<WPRICE></WPRICE>
		<MODELID></MODELID>
		<UICCID></UICCID>
		<TIN></TIN>
		<SKU></SKU>
		<MSL></MSL>
		<NOTES></NOTES>
		<VENDOR></VENDOR>
		<CARRIER></CARRIER>
		<PUK2></PUK2>
		<AGENTTYPE></AGENTTYPE>
		<AGENTVALUE></AGENTVALUE>
		<SIMCARD></SIMCARD>
		<PLANTYPEID></PLANTYPEID>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</ADDANDASSIGNNONACTIVATE>
 </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.
338 UPS Tracking is required. Please provide UPS Tracking as it is required.
340 UPS Tracking cannot be duplicate value. Please provide UPS Tracking as given found duplicate.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
468 Activation fee type should positive value. Activation fee type can not be a negative value. Activation fee type should positive value.
532 MSL is required. MSL is mandatory.
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.
751 Custom message. This is dynamic 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>
       <AddAndAssignNonActivate>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <lastInventoryId>1123654790</lastInventoryId>
    </AddAndAssignNonActivate>
</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>
<AddAndAssignNonActivate>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddAndAssignNonActivate>
</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>
<AddAndAssignNonActivate>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AddAndAssignNonActivate>
</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>
<AddAndAssignNonActivate>
	<statusCode>338</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking is required.</errorDescription>
</AddAndAssignNonActivate>
</VcareOssApi>
Error Description: UPS Tracking is required.
How to Resolve?: Please provide UPS Tracking as it is required.
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>
<AddAndAssignNonActivate>
	<statusCode>340</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking cannot be duplicate value.</errorDescription>
</AddAndAssignNonActivate>
</VcareOssApi>
Error Description: UPS Tracking cannot be duplicate value.
How to Resolve?: Please provide UPS Tracking as given found duplicate.
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>
<AddAndAssignNonActivate>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</AddAndAssignNonActivate>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot 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>
<AddAndAssignNonActivate>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</AddAndAssignNonActivate>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<AddAndAssignNonActivate>
	<statusCode>468</statusCode>
	<description>FAIL</description>
	<errorDescription>Activation fee type should positive value.</errorDescription>
</AddAndAssignNonActivate>
</VcareOssApi>
Error Description: Activation fee type should positive value.
How to Resolve?: Activation fee type can not be a negative value. Activation fee type should positive 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>
<AddAndAssignNonActivate>
	<statusCode>532</statusCode>
	<description>FAIL</description>
	<errorDescription>MSL is required.</errorDescription>
</AddAndAssignNonActivate>
</VcareOssApi>
Error Description: MSL is required.
How to Resolve?: MSL is mandatory.
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>
<AddAndAssignNonActivate>
	<statusCode>605</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID Inactive.</errorDescription>
</AddAndAssignNonActivate>
</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: 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>
<AddAndAssignNonActivate>
	<statusCode>606</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID not found.</errorDescription>
</AddAndAssignNonActivate>
</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: 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>
<AddAndAssignNonActivate>
	<statusCode>607</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID is required.</errorDescription>
</AddAndAssignNonActivate>
</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: 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>
<AddAndAssignNonActivate>
	<statusCode>608</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Plan Type ID.</errorDescription>
</AddAndAssignNonActivate>
</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.
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>
<AddAndAssignNonActivate>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</AddAndAssignNonActivate>
</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.