Telgoo5 APIs

GetInventoryInfo

This XML API is used to get Inventory Info

End Point	https://www.vcareapi.com/vcareOssApi/GetInventoryInfo/
Field	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.
IMEI		string	8901123654789654123	Conditional	This is required if value for ESN or MDN is not passed	Max Char=25
ESN		string	8901123654789654123	Conditional	This is required if value for IMEI or MDN is not passed	Max Char=25
MDN		Number	10 digits only	Conditional	This is required if value for ESN or IMEI is not passed	Only number are expected exactly 10 digits. ;
LINE INQUIRY		Char	Y	Optional	This option determines if the line inquiry should happen or not. Line inquiry is the real time carrier inquiry to get the balance and other carrier details.	Expected Values Y or N. Y determines that the line inquiry should happen and N determines that the line inquiry should not happen
SOURCE		string	API	Optional	Source of the order/application	Expected Value:API, TABLET, IVR, WEBSITE
AGENTID		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.

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>
	<GETINVENTORYINFO>
	  <ESN></ESN>
	  <MDN></MDN>
	 <IMEI></IMEI>
	 <SOURCE></SOURCE>
	 <LINEINQUIRY></LINEINQUIRY>
	 <AGENTID></AGENTID>
	 <AGENTPASSWORD></AGENTPASSWORD>
	</GETINVENTORYINFO>
</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.
126	Invalid MDN.	Please provide valid MDN.
260	ESN/SIM not found in our inventory.	Please provide either provisioned ESN or not provisioned ESN of Status as free
332	MDN not found in System.	MDN is not found in System.
347	Device ID not valid.	Please provide a valid Device ID.
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.
356	Agent ID cannot be blank.	Please provide Agent ID as it cannot be blank.
367	MDN should be 10 digits.	Please provide a valid MDN and it should be 10 digits.
457	Invalid Source.	Please provide a valid Source. Given value is invalid for Source.
494	IMEI not found in inventory.	Provide correct IMEI. IMEI is not available in inventory.
495	IMEI must be greater than 8 and less than 20 characters.	Provide correct IMEI which must be greater than 8 and less than 20 characters.
535	ESN OR MDN OR IMEI is required.	Choose among ESN or MDN or IMEI. ESN or MDN or IMEI is required.
539	Line inquiry should be Y OR N.	Provide correct Line inquiry. Line inquiry should be Y or N.
546	We get Multiple record for this ESN/SIM. Please Enter MEIDHEX and MEIDDEC of this ESN/SIM.	Please Provide MEIDHEX and MEIDDEC of this ESN/SIM.

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>11111111111</referenceNumber>
</credentials>
<GetInventoryInfo>
<statusCode>00</statusCode>
<description>SUCCESS</description>
<errorDescription>SUCCESS</errorDescription>
<inventoryDetail>
    <esnSim></esnSim>
    <mdn></mdn>
    <msl></msl>
    <boxNumber></boxNumber>
    <boxID></boxID>
    <model></model>
    <PONumber></PONumber>
    <sellingPrice></sellingPrice>
    <wholesalecost></wholesalecost>
    <carrier></carrier>
    <uploadedDate></uploadedDate>
    <finalStatus></finalStatus>
    <status></status>
    <master></master>
    <distributor></distributor>
    <retailer></retailer>
    <employee></employee>
</inventoryDetail>
<provisioningDetail>
    <esnSim></esnSim>
    <mdn></mdn>
    <msl></msl>
    <msid></msid>
    <provisionDate></provisionDate>
    <planId></planId>
    <zip></zip>
    <provstatus></provstatus>
</provisioningDetail>
<customerDetail>
    <esnSim></esnSim>
    <mdn></mdn>
    <enrollID></enrollID>
    <custID></custID>
    <name></name>
    <handoverDate></handoverDate>
    <state></state>
    <accountStatus></accountStatus>
    <statusDate></statusDate>
</customerDetail>
<assignmentDetail>
    <esnSim></esnSim>
    <mdn></mdn>
    <source></source>
    <boxNumbe></boxNumbe>
    <boxId></boxId>
    <assignedDate></assignedDate>
    <toMaster></toMaster>
    <toDistributor></toDistributor>
    <toRetailer></toRetailer>
    <toEmployee></toEmployee>
    <assignedBy>System</assignedBy>
</assignmentDetail>
<lineInquiry>
    <esnSim></esnSim>
    <mdn></mdn>
    <carrierStatus></carrierStatus>
    <ocsLiveStatus></ocsLiveStatus>
    <ocsExpiredDate></ocsExpiredDate>
    <activationDate> </activationDate>
    <planCode></planCode>
    <description></description>
</lineInquiry>
</GetInventoryInfo>
</VcareOssApi>

SUCCESS

Sample Fail Response: $cnt1

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

Error Description: Password is invalid.

How to Resolve?: Provide a valid Password.

Sample Fail Response: $cnt2

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

Error Description: Vendor not found. Wrong credentials.

How to Resolve?: Please enter valid vendor credentials.

Sample Fail Response: $cnt3

<?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>
<GetInventoryInfo>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: Invalid MDN.

How to Resolve?: Please provide valid MDN.

Sample Fail Response: $cnt4

<?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>
<GetInventoryInfo>
	<statusCode>260</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN/SIM not found in our inventory.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: ESN/SIM not found in our inventory.

How to Resolve?: Please provide either provisioned ESN or not provisioned ESN of Status as free

Sample Fail Response: $cnt5

<?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>
<GetInventoryInfo>
	<statusCode>332</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN not found in System.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: MDN not found in System.

How to Resolve?: MDN is not found in System.

Sample Fail Response: $cnt6

<?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>
<GetInventoryInfo>
	<statusCode>347</statusCode>
	<description>FAIL</description>
	<errorDescription>Device ID not valid.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: Device ID not valid.

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

Sample Fail Response: $cnt7

<?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>
<GetInventoryInfo>
	<statusCode>351</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN must be greater than 8 and less than 26 characters.</errorDescription>
</GetInventoryInfo>
</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: $cnt8

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

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

Sample Fail Response: $cnt9

<?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>
<GetInventoryInfo>
	<statusCode>367</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should be 10 digits.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: MDN should be 10 digits.

How to Resolve?: Please provide a valid MDN and it should be 10 digits.

Sample Fail Response: $cnt10

<?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>
<GetInventoryInfo>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

Sample Fail Response: $cnt11

<?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>
<GetInventoryInfo>
	<statusCode>494</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI not found in inventory.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: IMEI not found in inventory.

How to Resolve?: Provide correct IMEI. IMEI is not available in inventory.

Sample Fail Response: $cnt12

<?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>
<GetInventoryInfo>
	<statusCode>495</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI must be greater than 8 and less than 20 characters.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: IMEI must be greater than 8 and less than 20 characters.

How to Resolve?: Provide correct IMEI which must be greater than 8 and less than 20 characters.

Sample Fail Response: $cnt13

<?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>
<GetInventoryInfo>
	<statusCode>535</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN OR MDN OR IMEI is required.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: ESN OR MDN OR IMEI is required.

How to Resolve?: Choose among ESN or MDN or IMEI. ESN or MDN or IMEI is required.

Sample Fail Response: $cnt14

<?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>
<GetInventoryInfo>
	<statusCode>539</statusCode>
	<description>FAIL</description>
	<errorDescription>Line inquiry should be Y OR N.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: Line inquiry should be Y OR N.

How to Resolve?: Provide correct Line inquiry. Line inquiry should be Y or N.

Sample Fail Response: $cnt15

<?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>
<GetInventoryInfo>
	<statusCode>546</statusCode>
	<description>FAIL</description>
	<errorDescription>We get Multiple record for this ESN/SIM. Please Enter MEIDHEX and MEIDDEC of this ESN/SIM.</errorDescription>
</GetInventoryInfo>
</VcareOssApi>

Error Description: We get Multiple record for this ESN/SIM. Please Enter MEIDHEX and MEIDDEC of this ESN/SIM.

How to Resolve?: Please Provide MEIDHEX and MEIDDEC of this ESN/SIM.

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