QueryPortin

This API is used to validate status of a port in order.

End Point https://www.vcareapi.com/vcareOssApi/QueryPortin/
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 Auto generated unique reference number is required to be passed with each transaction.
CUSTOMERID Numeric 1234567890 Optional ID of the customer assigned by Telgoo5. This can be obtained using another API called GetCustomerInfo
ESN string 8901111111111111 Optional NEW ESN which has been submitted for portin.  
CARRIER string SPR Required Carrier for the MDN has been submitted for Port in. This accepts Carrier id which can be obtained from using another API called GetCompanyCarrier. Use the value passed in GetCompanyCarrier response tag CARRIERNAME. Alphabets. Carrier Abbreviation.
MDN Numeric 1234567890 Required The MDN / MSISDN which has to be port / switch to other carrier. It should be 10 digits only.
RETURN URL string   Optional    
COMPANY ID Numeric 28 Required A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany.
TRANSACTION ID string   Not in Use    
SOURCE string API Optional  Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
AGENT ID 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.  
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>Vcarecorporation</VENDORID>
	<USERNAME>Vcarecorporation</USERNAME>
	<PASSWORD>Vcarecorporation</PASSWORD>
	<PIN>123456789</PIN>
	<REFERENCENUMBER>123456789</REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<QUERYPORTIN> 
	<CUSTOMERID></CUSTOMERID> 
	<ESN></ESN>
	<CARRIER></CARRIER>
	<MDN></MDN>
	<RETURNURL></RETURNURL>
	<COMPANYID></COMPANYID>
	<TRANSACTIONID></TRANSACTIONID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE> 
</QUERYPORTIN>
</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.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
457 Invalid Source. Please provide a valid Source. Given value is invalid for Source.
751 Custom message. This is dynamic message.
Sample Fail Response
CARRIER =TAL
				
				<?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>
				<QueryPortin>
					<statusCode>00</statusCode>
					<description>SUCCESS</description>
					<errorDescription>SUCCESS</errorDescription>
					<MDN></MDN>
					<carrier></carrier>
					<accountnumber></accountnumber>
					<status></status>
					<responsetype></responsetype>
					<reasoncode></reasoncode>
					<reasondescription></reasondescription>
					<osp></osp>
					<ospresponseduetime></ospresponseduetime>
					<portdirection></portdirection>
					<portdirectionid></portdirectionid>
					<firstname></firstname>
					<middleinitial></middleinitial>
					<lastname></lastname>
					<businessname></businessname>
					<ospaccountnumber></ospaccountnumber>
					<ssnortaxid></ssnortaxid>
					<password></password>
					<addressline1></addressline1>
					<addressline2></addressline2>
					<city></city>
					<state></state>
					<zip></zip>
				</QueryPortin>
				</VcareOssApi>

Other CARRIER

			<?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>
					<referenceNumber></referenceNumber>
				</credentials>
				<QueryPortin>
					<statusCode></statusCode>
					<description></description>
					<errorDescription></errorDescription>
					<responsedesc></responsedesc>
					<carrier></carrier>
					<MDN></MDN>
					<reasoncode></reasoncode>
				</QueryPortin>
			</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>
<QueryPortin>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</QueryPortin>
</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>
<QueryPortin>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</QueryPortin>
</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>
<QueryPortin>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</QueryPortin>
</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>
<QueryPortin>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</QueryPortin>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<QueryPortin>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</QueryPortin>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<QueryPortin>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</QueryPortin>
</VcareOssApi>
Error Description: Custom message.
How to Resolve?: This is dynamic message.

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