AddUpdatePhoneRequest

This XML API is used to Add and Update Phone Request.

End Point https://www.vcareapi.com/vcareOssApi/AddUpdatePhoneRequest/
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.
ACTION string ADD,UPDATE Required Add or Update feature on the customer's account. ADD,UPDATE
PHONE REQUEST ID Numeric 123456 Conditional Auto generated phone request id. This can be obtained using another API called ViewPhoneRequest. Required if ACTION="UPDATE"
PHONE TYPE string FREE Conditional This is the phone type. Value should be FREE,PAID Required if ACTION="ADD"
PHONE PLAN string DATA_PLAN or REGULAR Conditional This is the phone plan. Required if ACTION="ADD" and PHONETYPE="PAID"
PHONE PRICE ID Numeric 1 Required This is the phone price ID. This can be obtained using another API called GetRequestPhonePrice. Required if ACTION="ADD" and PHONETYPE="PAID"
DELIVERY DATE date 2018-12-27 Conditional This is the delivery date Required if ACTION="ADD"
REQUESTED QUANTITY Numeric 2 Conditional This is the requested quantity. Required if ACTION="ADD"
CARRIER string TMB Conditional This is the carrier. Required if ACTION="ADD"
MAILING ADDRESS1 string 123 Main st Optional This is the mailing address of the registered. if you want to change shipment address. If empty default address take by our records. Required if ACTION="ADD". Should allow only letters, numbers, space and: hyphen ;forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
MAILING ADDRESS2 string Apt 1 Optional This is the mailing address of the registered. if you want to change shipment address. If empty default address take by our records. Required if ACTION="ADD". Should allow only letters, numbers, space and: hyphen ; forward slash Max length for the fields - 50 symbols. Cannot contain phrases "PO Box" or "P.O. Box".
MAILING STATE string CA Optional This is the state of the mailing address of the registered. if you want to change shipment address. If empty default address take by our records. Required if ACTION="ADD". State should be standard abbreviated form.
MAILING CITY string San Jose Optional This is the mailing city of the registered. if you want to change shipment address. If empty default address take by our records. Required if ACTION="ADD". Should allow only letters, hyphen and space.
MAILING ZIPCODE Numeric 90001 Optional This is the mailing Zipcode of the registered. if you want to change shipment address. If empty default address take by our records. Required if ACTION="ADD". Should not allow letters and special characters, only numbers. Should be exactly 5 digits.
ORDER SHIPPING MODE string SHIP Conditional This is the order shipping mode. Value should be PICK UP,SHIP Required if ACTION="ADD"
COMMENTS string test comment. Optional This is the order comment. Required if ACTION="ADD"
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>
	<ADDUPDATEPHONEREQUEST>	
		<ACTION></ACTION>
		<PHONEREQUESTID></PHONEREQUESTID>
		<PHONETYPE></PHONETYPE>
		<PHONEPLAN></PHONEPLAN>
		<PHONEPRICEID></PHONEPRICEID>
		<DELIVERYDATE>2019-04-01</DELIVERYDATE>
		<REQUESTEDQUANTITY></REQUESTEDQUANTITY>
		<CARRIER></CARRIER>
		<MAILINGADDRESS1></MAILINGADDRESS1>
		<MAILINGADDRESS2></MAILINGADDRESS2>
		<MAILINGZIPCODE></MAILINGZIPCODE>
		<MAILINGCITY></MAILINGCITY>
		<MAILINGSTATE></MAILINGSTATE>
		<ORDERSHIPPINGMODE></ORDERSHIPPINGMODE>
		<COMMENTS></COMMENTS>
		<AGENTID></AGENTID>
		<AGENTPASSWORD></AGENTPASSWORD>
		<SOURCE></SOURCE>
	</ADDUPDATEPHONEREQUEST>
</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.
41 Carrier is invalid. Please provide valid Carrier.
55 Invalid agent login. Please provide valid agent login.
144 Mailing Zip Code is required. Please provide Mailing Zip Code.
145 Mailing Zip Code is not correct. Please provide correct Mailing Zip code.
184 Invalid delivery date format. Date format should be YYYY-MM-DD. Provide a valid delivery date format ex. YYYY-MM-DD.
214 Action should not be blank. Please provide valid value as Action should not be blank.
334 Invalid action either ADD OR UPDATE is required. Invalid action either ADD OR UPDATE is required.
449 Carrier should not be blank. Carrier can not be blank. You should enter a valid Carrier.
725 Please provide the proper mailing address. Proper mailing address is not valid. Please provide a proper mailing address.
751 Custom message. This is dynamic message.
791 Requested quantity cannot be blank. Please provide Requested quantity.
792 Requested quantity should be number. Please provide a valid requested quantity. Requested quantity can contain character.
793 Please provide phone request ID. Phone request ID can contain number. Please provide a valid phone request ID. Phone request ID can contain number.
794 Please provide phone type. Phone type should be FREE or PAID Please provide a valid phone type. Phone type should be FREE or PAID
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
796 Please provide phone price ID. Phone price ID can contain only number. Please provide a valid phone price ID. Phone price ID can contain only number.
797 Please provide order shipping mode. Order shipping mode should be PICK UP or SHIP. Please provide a valid order shipping mode. Order shipping should be PICK UP or SHIP.
798 Phone type should not be blank. Provide a valid phone type.
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-Terracom</vendorId>
        <referenceNumber>4323423432423</referenceNumber>
    </credentials>
    <AddUpdatePhoneRequest>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <AddPhoneDescription>Request updated successfully.</AddPhoneDescription>
        <AddPhoneEmail>SUCCESS</AddPhoneEmail>
    </AddUpdatePhoneRequest>
</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>
<AddUpdatePhoneRequest>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</AddUpdatePhoneRequest>
</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>
<AddUpdatePhoneRequest>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Carrier is invalid.
How to Resolve?: Please provide valid Carrier.
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>
<AddUpdatePhoneRequest>
	<statusCode>55</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid agent login.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Invalid agent login.
How to Resolve?: Please provide valid agent login.
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>
<AddUpdatePhoneRequest>
	<statusCode>144</statusCode>
	<description>FAIL</description>
	<errorDescription>Mailing Zip Code is required.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Mailing Zip Code is required.
How to Resolve?: Please provide Mailing Zip Code.
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>
<AddUpdatePhoneRequest>
	<statusCode>145</statusCode>
	<description>FAIL</description>
	<errorDescription>Mailing Zip Code is not correct.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Mailing Zip Code is not correct.
How to Resolve?: Please provide correct Mailing Zip code.
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>
<AddUpdatePhoneRequest>
	<statusCode>184</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid delivery date format. Date format should be YYYY-MM-DD.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Invalid delivery date format. Date format should be YYYY-MM-DD.
How to Resolve?: Provide a valid delivery date format ex. YYYY-MM-DD.
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>
<AddUpdatePhoneRequest>
	<statusCode>214</statusCode>
	<description>FAIL</description>
	<errorDescription>Action should not be blank.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Action should not be blank.
How to Resolve?: Please provide valid value as Action should not be 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>
<AddUpdatePhoneRequest>
	<statusCode>334</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid action either ADD OR UPDATE is required.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Invalid action either ADD OR UPDATE is required.
How to Resolve?: Invalid action either ADD OR UPDATE is required.
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>
<AddUpdatePhoneRequest>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</AddUpdatePhoneRequest>
</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>
<AddUpdatePhoneRequest>
	<statusCode>725</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide the proper mailing address.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Please provide the proper mailing address.
How to Resolve?: Proper mailing address is not valid. Please provide a proper mailing address.
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>
<AddUpdatePhoneRequest>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Custom message.
How to Resolve?: This is dynamic message.
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>
<AddUpdatePhoneRequest>
	<statusCode>791</statusCode>
	<description>FAIL</description>
	<errorDescription>Requested quantity cannot be blank.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Requested quantity cannot be blank.
How to Resolve?: Please provide Requested quantity.
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>
<AddUpdatePhoneRequest>
	<statusCode>792</statusCode>
	<description>FAIL</description>
	<errorDescription>Requested quantity should be number.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Requested quantity should be number.
How to Resolve?: Please provide a valid requested quantity. Requested quantity can contain character.
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>
<AddUpdatePhoneRequest>
	<statusCode>793</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide phone request ID. Phone request ID can contain number.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Please provide phone request ID. Phone request ID can contain number.
How to Resolve?: Please provide a valid phone request ID. Phone request ID can contain number.
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>
<AddUpdatePhoneRequest>
	<statusCode>794</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide phone type. Phone type should be FREE or PAID</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Please provide phone type. Phone type should be FREE or PAID
How to Resolve?: Please provide a valid phone type. Phone type should be FREE or PAID
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>
<AddUpdatePhoneRequest>
	<statusCode>795</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide phone plan. Phone plan should be DATA_PLAN or REGULAR</errorDescription>
</AddUpdatePhoneRequest>
</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
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>
<AddUpdatePhoneRequest>
	<statusCode>796</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide phone price ID. Phone price ID can contain only number.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Please provide phone price ID. Phone price ID can contain only number.
How to Resolve?: Please provide a valid phone price ID. Phone price ID can contain only number.
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>
<AddUpdatePhoneRequest>
	<statusCode>797</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide order shipping mode. Order shipping mode should be PICK UP or SHIP.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Please provide order shipping mode. Order shipping mode should be PICK UP or SHIP.
How to Resolve?: Please provide a valid order shipping mode. Order shipping should be PICK UP or SHIP.
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>
<AddUpdatePhoneRequest>
	<statusCode>798</statusCode>
	<description>FAIL</description>
	<errorDescription>Phone type should not be blank.</errorDescription>
</AddUpdatePhoneRequest>
</VcareOssApi>
Error Description: Phone type should not be blank.
How to Resolve?: Provide a valid phone type.

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