Validate Byod

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

End Point https://www.vcareapi.com/vcareOssApi/ValidateByod/
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 TYPE string CDMA Required Device type are CDMA, GSM
  • CDMA : ESN validate with carrier for TAL,VER,SPR.
  • GSM : For other carrier get device validate in inventory.
CARRIER string TMB Required This is the carrier id and is returned in the Devicelookup API in the <carrier> parameter  
COMPANY ID Numeric 28 Required A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany.
ESN string 8901260713156280780 Conditional if CDMA then ESN is required. This is the ESN which you would like to enquire about. Before assigning an ESN to an applicant, agent will need to verify if the ESN is assigned to him or not in the inventory Can be numeric. Max length = 25
  • CDMA then BYOD validate with carrier for TAL,VER,SPR.
IMEI string 355276482290779 Conditional if GSM then IMEI is required. This is the IMEI/Device ID which needs to be assigned to the applicant. Before the assignment agent will need to verify if the IMEI/Device ID is assigned to him or not in the inventory Can be alpha numeric. Max length = 25
  • GSM then device validate in inventory.
CHECK INVENTORY string N Optional This determines the check in inventory flag. '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 This is the source where the API. This could be API, TABLET, IVR, WEBSITE, POS, CUSTOMERPORTAL etc. API, TABLET, IVR, WEBSITE, POS, CUSTOMERPORTAL
Sample Request XML
<?xml version="1.0" encoding="utf-8"?>
<VCAREOSSAPI xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"  xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<CREDENTIALS>
	<VENDORID></VENDORID>
	<USERNAME></USERNAME>
	<PASSWORD></PASSWORD>
	<PIN></PIN>
	<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<VALIDATEBYOD>
	<DEVICETYPE></DEVICETYPE>
	<CARRIER></CARRIER>
	<COMPANYID></COMPANYID>
	<ESN></ESN>
	<IMEI></IMEI>
	<CHECKINVENTORY></CHECKINVENTORY>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</VALIDATEBYOD>
</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.
41 Carrier is invalid. Please provide valid Carrier.
130 Invalid Company ID. Please provide valid company id.
169 Company ID is required. Please provide company ID.
194 ESN should not be blank. Please provide ESN. ESN cannot be left blank.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
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.
493 IMEI should not be blank. Provide correct IMEI. IMEI should not be blank.
673 Device type should be CDMA OR GSM. Provide correct Device type. Device type should be CDMA or GSM.
674 Device type should not be blank. Provide a valid Device type. Device type should not be blank.
675 ESN exists in inventory, cannot be used for BYOD. ESN exists in inventory. It can not be used for BYOD.
676 Device exists in inventory, cannot be used for BYOD. Device exists in inventory. It can not be used for BYOD.
677 Error from carrier. Try again. Error is coming from carrier.
751 Custom message. This is dynamic message.
800 ESN exists in inventory, cannot be used for BYOD. ESN status in inventory is Free. ESN exists in inventory, cannot be used for BYOD. ESN status in inventory is Free.
801 Device exists in inventory, cannot be used for BYOD. Device status in inventory is Free. Device exists in inventory. It can not be used for BYOD. Device status in inventory is Free.
Sample Response XML
Carrier :SPR


<?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>111111111</referenceNumber>
    </credentials>
    <ValidateByod>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <esn></esn>
        <availabilitytypecode></availabilitytypecode>
        <manufacturername></manufacturername>
        <validationmessage></validationmessage>
        <modelname></modelname>
        <modelnumber></modelnumber>
        <freqmode></freqmode>
        <equipmentfreqtypecode></equipmentfreqtypecode>
        <esnmeidhex></esnmeidhex>
        <devicetype></devicetype>
        <activationstatus></activationstatus>
        <devicefedmetind></devicefedmetind>
        <pocswapind></pocswapind>
        <esn2></esn2>
        <macid></macid>
        <iccid></iccid>
        <imsi></imsi>
        <uiccsku></uiccsku>
        <uiccavailabilitycode></uiccavailabilitycode>
        <uiccnotavailablereasoncode></uiccnotavailablereasoncode>
        <uicccompatibility></uicccompatibility>
        <uicctype></uicctype>
    </ValidateByod>
</VcareOssApi>


Carrier :TAL,VER


<?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>111111111</referenceNumber>
    </credentials>
    <ValidateByod>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <esn></esn>
		<deviceId></deviceId>
		<isValid></isValid>
		<isInDMD></isInDMD>
		<isPIBLock></isPIBLock>
		<isLostOrStolen></isLostOrStolen>
		<make></make>
		<model></model>
		<returnCode></returnCode>
		<returnMessage></returnMessage>
    </ValidateByod>
</VcareOssApi>

Other Carriers:


<?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>111111111</referenceNumber>
    </credentials>
    <ValidateByod>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        
    </ValidateByod>
</VcareOssApi>
SUCCESS

List of all the status codes will be shared seperately.

<esn> This is the same ESN/SIM which was passed in the request.

API

<carrier> This is the carrier to which the given ESN/SIM belongs to.

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>
<ValidateByod>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</ValidateByod>
</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>
<ValidateByod>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ValidateByod>
</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>
<ValidateByod>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ValidateByod>
</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>
<ValidateByod>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Carrier is invalid.
How to Resolve?: Please provide valid Carrier.
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>
<ValidateByod>
	<statusCode>130</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Company ID.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Invalid Company ID.
How to Resolve?: Please provide valid company 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>
<ValidateByod>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide company ID.
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>
<ValidateByod>
	<statusCode>194</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN should not be blank.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: ESN should not be blank.
How to Resolve?: Please provide ESN. ESN cannot be left 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>
<ValidateByod>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ValidateByod>
</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>
<ValidateByod>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</ValidateByod>
</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>
<ValidateByod>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ValidateByod>
</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>
<ValidateByod>
	<statusCode>493</statusCode>
	<description>FAIL</description>
	<errorDescription>IMEI should not be blank.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: IMEI should not be blank.
How to Resolve?: Provide correct IMEI. IMEI 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>
<ValidateByod>
	<statusCode>673</statusCode>
	<description>FAIL</description>
	<errorDescription>Device type should be CDMA OR GSM.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Device type should be CDMA OR GSM.
How to Resolve?: Provide correct Device type. Device type should be CDMA or GSM.
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>
<ValidateByod>
	<statusCode>674</statusCode>
	<description>FAIL</description>
	<errorDescription>Device type should not be blank.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Device type should not be blank.
How to Resolve?: Provide a valid Device type. Device type should not be blank.
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>
<ValidateByod>
	<statusCode>675</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN exists in inventory, cannot be used for BYOD.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: ESN exists in inventory, cannot be used for BYOD.
How to Resolve?: ESN exists in inventory. It can not be used for BYOD.
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>
<ValidateByod>
	<statusCode>676</statusCode>
	<description>FAIL</description>
	<errorDescription>Device exists in inventory, cannot be used for BYOD.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Device exists in inventory, cannot be used for BYOD.
How to Resolve?: Device exists in inventory. It can not be used for BYOD.
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>
<ValidateByod>
	<statusCode>677</statusCode>
	<description>FAIL</description>
	<errorDescription>Error from carrier.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Error from carrier.
How to Resolve?: Try again. Error is coming from carrier.
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>
<ValidateByod>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Custom message.
How to Resolve?: This is dynamic message.
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>
<ValidateByod>
	<statusCode>800</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN exists in inventory, cannot be used for BYOD. ESN status in inventory is Free.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: ESN exists in inventory, cannot be used for BYOD. ESN status in inventory is Free.
How to Resolve?: ESN exists in inventory, cannot be used for BYOD. ESN status in inventory is Free.
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>
<ValidateByod>
	<statusCode>801</statusCode>
	<description>FAIL</description>
	<errorDescription>Device exists in inventory, cannot be used for BYOD. Device status in inventory is Free.</errorDescription>
</ValidateByod>
</VcareOssApi>
Error Description: Device exists in inventory, cannot be used for BYOD. Device status in inventory is Free.
How to Resolve?: Device exists in inventory. It can not be used for BYOD. Device status in inventory is Free.

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