Telgoo5 APIs

ViewPhoneRequest

This XML API is used to get phone request.

End Point	https://www.vcareapi.com/vcareOssApi/ViewPhoneRequest/
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 REQUEST ID		Numeric	123456	Optional	Auto generated phone request id.
PHONE STATUS		string	NEW	Optional	This is the phone type. Value should be 'NEW','DENIED','ON HOLD','CLOSED'	'NEW','DENIED','ON HOLD','CLOSED'
ORDER SHIPPING MODE		string	SHIP	Optional	This is the order shipping mode. Value should be PICK UP,SHIP	PICK UP,SHIP
PO NUMBER		string	DATER201302151	Optional	This is the po number.	DATER201302151
FROM DATE		string	2019-01-02	Required	This is the requested date.	YYYY-MM-DD is expected. hyphen allowed.
TO DATE		string	2019-01-02	Required	This is the requested date.	YYYY-MM-DD is expected. hyphen allowed.
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>
<VIEWPHONEREQUEST>
	<PHONEREQUESTID></PHONEREQUESTID>
	<STATUS>free</STATUS>
	<ORDERSHIPPINGMODE></ORDERSHIPPINGMODE>
	<PO_NUMBER></PO_NUMBER>
	<DATETO></DATETO>
	<DATEFROM></DATEFROM>
	<AGENTID>Devteam</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</VIEWPHONEREQUEST>
</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.
243	Record(s) not found.	Please provide valid value as Record(s) not found.
708	From date is required.	From date can not be blank. You should enter a valid From date.
709	To date is required.	To date can not be blank. You should enter a valid To date.
711	Invalid from date.	Enter a valid From Date.
712	Invalid to date.	Enter a valid To Date.
751	Custom message.	This is dynamic message.
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.

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>
    <ViewPhoneRequest>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <PhoneRequestDetails>
            <phonerequestid></phonerequestid>
            <po_number></po_number>
            <d_id></d_id>
            <r_id>2048</r_id>
            <agent_type></agent_type>
            <phone_type></phone_type>
            <phone_plan></phone_plan>
            <phone_name></phone_name>
            <phone_price></phone_price>
            <phone_id></phone_id>
            <carrier></carrier>
            <zip></zip>
            <area_code></area_code>
            <phone_request_quantity></phone_request_quantity>
            <phone_request_date></phone_request_date>
            <phone_request_update_date></phone_request_update_date>
            <phone_approval_quantity></phone_approval_quantity>
            <phone_approval_date></phone_approval_date>
            <phone_delivery_quantity></phone_delivery_quantity>
            <phone_delivery_date></phone_delivery_date>
            <request_by></request_by>
            <approve_by></approve_by>
            <mailing_zip></mailing_zip>
            <mailing_city></mailing_city>
            <mailing_state></mailing_state>
            <mailing_address1></mailing_address1>
            <mailing_address2></mailing_address2>
            <tracking_number></tracking_number>
            <order_mode></order_mode>
            <notes></notes>
            <approve_notes></approve_notes>
            <current_status></current_status>
            <standing_order></standing_order>
            <paid_unpaid></paid_unpaid>
            <forecast_state></forecast_state>
            <forecast_city></forecast_city>
            <total_paid_phone_Price></total_paid_phone_Price>
            <source>INVENTORY</source>
        </PhoneRequestDetails>
         <PhoneRequestDetails>
            <phonerequestid></phonerequestid>
            <po_number></po_number>
            <d_id></d_id>
            <r_id>2048</r_id>
            <agent_type></agent_type>
            <phone_type></phone_type>
            <phone_plan></phone_plan>
            <phone_name></phone_name>
            <phone_price></phone_price>
            <phone_id></phone_id>
            <carrier></carrier>
            <zip></zip>
            <area_code></area_code>
            <phone_request_quantity></phone_request_quantity>
            <phone_request_date></phone_request_date>
            <phone_request_update_date></phone_request_update_date>
            <phone_approval_quantity></phone_approval_quantity>
            <phone_approval_date></phone_approval_date>
            <phone_delivery_quantity></phone_delivery_quantity>
            <phone_delivery_date></phone_delivery_date>
            <request_by></request_by>
            <approve_by></approve_by>
            <mailing_zip></mailing_zip>
            <mailing_city></mailing_city>
            <mailing_state></mailing_state>
            <mailing_address1></mailing_address1>
            <mailing_address2></mailing_address2>
            <tracking_number></tracking_number>
            <order_mode></order_mode>
            <notes></notes>
            <approve_notes></approve_notes>
            <current_status></current_status>
            <standing_order></standing_order>
            <paid_unpaid></paid_unpaid>
            <forecast_state></forecast_state>
            <forecast_city></forecast_city>
            <total_paid_phone_Price></total_paid_phone_Price>
            <source>INVENTORY</source>
        </PhoneRequestDetails>
    </ViewPhoneRequest>
</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>
<ViewPhoneRequest>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ViewPhoneRequest>
</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>
<ViewPhoneRequest>
	<statusCode>243</statusCode>
	<description>FAIL</description>
	<errorDescription>Record(s) not found.</errorDescription>
</ViewPhoneRequest>
</VcareOssApi>

Error Description: Record(s) not found.

How to Resolve?: Please provide valid value as Record(s) not found.

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>
<ViewPhoneRequest>
	<statusCode>708</statusCode>
	<description>FAIL</description>
	<errorDescription>From date is required.</errorDescription>
</ViewPhoneRequest>
</VcareOssApi>

Error Description: From date is required.

How to Resolve?: From date can not be blank. You should enter a valid From date.

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>
<ViewPhoneRequest>
	<statusCode>709</statusCode>
	<description>FAIL</description>
	<errorDescription>To date is required.</errorDescription>
</ViewPhoneRequest>
</VcareOssApi>

Error Description: To date is required.

How to Resolve?: To date can not be blank. You should enter a valid To date.

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>
<ViewPhoneRequest>
	<statusCode>711</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid from date.</errorDescription>
</ViewPhoneRequest>
</VcareOssApi>

Error Description: Invalid from date.

How to Resolve?: Enter a valid From Date.

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>
<ViewPhoneRequest>
	<statusCode>712</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid to date.</errorDescription>
</ViewPhoneRequest>
</VcareOssApi>

Error Description: Invalid to date.

How to Resolve?: Enter a valid To Date.

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>
<ViewPhoneRequest>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</ViewPhoneRequest>
</VcareOssApi>

Error Description: Custom message.

How to Resolve?: This is dynamic message.

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>
<ViewPhoneRequest>
	<statusCode>797</statusCode>
	<description>FAIL</description>
	<errorDescription>Please provide order shipping mode. Order shipping mode should be PICK UP or SHIP.</errorDescription>
</ViewPhoneRequest>
</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.

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