Telgoo5 APIs

AddPreActivated

This API is used to add the SIM/ESN stock in the inventory which has already been activated at carrier outside Telgoo5. This API at the same time also assigns the inventory to the agent chain.

End Point	https://www.vcareapi.com/vcareOssApi/AddPreActivated/
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	Max 4 characters
ESN / SIM		string	8901123654789654123	Required	This is the SIM/ESN which needs to be added in the inventory
PURCHASE ORDER #		string	PO123698	Required	This is the purchase order number
MODEL ID		Numeric	12	Required	This can be obtained using the GetMakeModel API
BOX NUMBER		string	6464646	Required	This is the box number in which the inventory have been packed	Max 25 characters
SELLING PRICE		Decimal	5.50	Optional	This is the price for ESN/SIM that needs to be paid by the subscriber.	Please pass decimal value.
WHOLESALE COST		Decimal	3.52	Optional	This is the price at which the inventory was bought from the vendor/wholeseller	Please pass decimal value.
MDN		Numeric	10 digits only	Required	Telephone number associated with the SIM/ESN.	hyphen not allowed
UICCID		string	8901123654789654123	Conditional	This is required in case of CDMA 4G.
ZIP CODE		string	21215	Required	This is the zip code on which the ESN/SIM was activated	5 digits allowed
SKU		string	PO123698SK	Required	This is the SKU number. You are able to pass a duplicate SKU number provided, AGENT ID passed in the call has permission to add to an existing SKU.
PLAN ID		string	1315	Required	This is the plan id on which the ESN/SIM was activated. This ID can be obtained using another api called GetPlanService.
MSL / PUK		Numeric	56342	Conditional	This is the master subsidy lock number in case of ESN and PUK1 in case of SIM. Required in case TMB, SPRINT	Max 25 digits
TRACKING NUMBER		string	123456	Required	This is the tracking number
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
AGENT TYPE		string	Retailer	Required	This is the type of 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 you are assigning the inventory to
CARRIER CODE		string	TMB	Required	Available carrier code list can be otained using GetCompanyCarrier API
NOTES		string	This is a test SIM	Optional	This is the notes field	Max 1000 charaters
SIM CARD		string	Y	Required	Y or N
MSID		Numeric	56433454354566	Conditional	This is only applicate when CARRIER CODE = SPR
TIN		string	56433454354566	Optional
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.
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>
<ADDPREACTIVATED>
		<COMPANYID></COMPANYID>
		<ESN></ESN>
		<PO></PO>
		<MODELID></MODELID>
		<BOX></BOX>
		<SPRICE></SPRICE>
		<WPRICE></WPRICE>
		<MDN></MDN>
		<MDNASSIGNDATE></MDNASSIGNDATE>
		<UICCID></UICCID>
		<ZIPCODE></ZIPCODE>
		<SKU></SKU>
		<PLANID></PLANID>
		<MSL></MSL>
		<UPS></UPS>
		<VENDOR></VENDOR>
		<AGENTTYPE></AGENTTYPE>
		<CARRIER></CARRIER>
		<NOTES></NOTES>
		<AGENTVALUE></AGENTVALUE>
		<SIMCARD></SIMCARD>
		<MSID></MSID>
		<TIN></TIN>
		<PLANTYPEID></PLANTYPEID>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
    </ADDPREACTIVATED>
</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.
03	Plan type and Plan id mismatch. Please try another.	Plan type and plan id should match in the system.
13	Password is invalid.	Provide a valid Password.
16	Vendor not found. Wrong credentials.	Please enter valid vendor credentials.
225	Model ID is required.	Please provide Model ID.
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.
376	Model ID is not valid.	Please provide a valid Model ID.
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.

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>
       <AddPreActivated>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <lastInventoryId>1123654791</lastInventoryId>
    </AddPreActivated>
</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>
<AddPreActivated>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</AddPreActivated>
</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>
<AddPreActivated>
	<statusCode>03</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan type and Plan id mismatch. Please try another.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: Plan type and Plan id mismatch. Please try another.

How to Resolve?: Plan type and plan id should match in the system.

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>
<AddPreActivated>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

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>
<AddPreActivated>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

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>
<AddPreActivated>
	<statusCode>225</statusCode>
	<description>FAIL</description>
	<errorDescription>Model ID is required.</errorDescription>
</AddPreActivated>
</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>
<AddPreActivated>
	<statusCode>338</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking is required.</errorDescription>
</AddPreActivated>
</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>
<AddPreActivated>
	<statusCode>340</statusCode>
	<description>FAIL</description>
	<errorDescription>UPS Tracking cannot be duplicate value.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: UPS Tracking cannot be duplicate value.

How to Resolve?: Please provide UPS Tracking as given found duplicate.

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>
<AddPreActivated>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it 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>
<AddPreActivated>
	<statusCode>376</statusCode>
	<description>FAIL</description>
	<errorDescription>Model ID is not valid.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: Model ID is not valid.

How to Resolve?: Please provide a valid Model ID.

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>
<AddPreActivated>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</AddPreActivated>
</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>
<AddPreActivated>
	<statusCode>468</statusCode>
	<description>FAIL</description>
	<errorDescription>Activation fee type should positive value.</errorDescription>
</AddPreActivated>
</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: 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>
<AddPreActivated>
	<statusCode>532</statusCode>
	<description>FAIL</description>
	<errorDescription>MSL is required.</errorDescription>
</AddPreActivated>
</VcareOssApi>

Error Description: MSL is required.

How to Resolve?: MSL is mandatory.

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>
<AddPreActivated>
	<statusCode>605</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID Inactive.</errorDescription>
</AddPreActivated>
</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: 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>
<AddPreActivated>
	<statusCode>606</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID not found.</errorDescription>
</AddPreActivated>
</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: 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>
<AddPreActivated>
	<statusCode>607</statusCode>
	<description>FAIL</description>
	<errorDescription>Plan Type ID is required.</errorDescription>
</AddPreActivated>
</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: 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>
<AddPreActivated>
	<statusCode>608</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Plan Type ID.</errorDescription>
</AddPreActivated>
</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.