Get Request Phone Price

This XML API is used to get request phone price details.

End Point https://www.vcareapi.com/vcareOssApi/GetRequestPhonePrice/
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.
REFERENCENUMBER string 123456789 Required Auto generated unique reference number is required to be passed with each transaction.
PHONE PLAN string DATA_PLAN Required This is the phone plan. DATA_PLAN or REGULAR
AGENTID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.  
AGENTPASSWORD 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>
<GETREQUESTPHONEPRICE>
	<PHONEPLAN></PHONEPLAN>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</GETREQUESTPHONEPRICE>
</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.
795 Please provide phone plan. Phone plan should be DATA_PLAN or REGULAR Please provide a valid phone plan. Phone plan should be DATA_PLAN or REGULAR
Sample Response
<?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>Dev-Vcare</vendorId>
        <referenceNumber>4323423432423</referenceNumber>
    </credentials>
    <GetRequestPhonePrice>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
		<paid_equip_phone_model_agent>
			<phonerequestid></phonerequestid>
			<name></name>
			<amount></amount>
		</paid_equip_phone_model_agent>
		<paid_equip_phone_model_agent>
			<phonepriceid></phonepriceid>
			<name></name>
			<amount></amount>
		</paid_equip_phone_model_agent>
    </GetRequestPhonePrice>
</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>
<GetRequestPhonePrice>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetRequestPhonePrice>
</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>
<GetRequestPhonePrice>
	<statusCode>795</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide phone plan. Phone plan should be DATA_PLAN or REGULAR</errorDescription>
</GetRequestPhonePrice>
</VcareOssApi>
Error Description: Please provide phone plan. Phone plan should be DATA_PLAN or REGULAR
How to Resolve?: Please provide a valid phone plan. Phone plan should be DATA_PLAN or REGULAR

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