ExistingSubscriberPortin

This API can be used to place a port in request order of an existing subscriber that has an account in Telgoo5 already.

End Point https://www.vcareapi.com/vcareOssApi/ExistingSubscriberPortin/
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 Auto generated unique reference number is required to be passed with each transaction.
CUSTOMER ID string 123564 Required This Customer ID should be existing account number of subscriber in Telgoo5.  
ESN/SIM string 8901111111111111 Required Current ESN/SIM of subscriber in Telgoo5. This should be the ESN/SIM which subscriber is using on their current telephone number .
NEW ESN/SIM string 8901111111111111 Optional This is a required field when existing carrier is TMobile (TMB). This field is optional in case of Sprint (SPR). Incase of Sprint, Port in is placed on the existing device.
ICCID string   Optional This is the ICCID for Sprint LTE. This field is optional for TMobile (TMB). The field become required for 4G/LTE and existing Carrier is Sprint (SPR).  
Existing Telephone Number string 1234567890 Required Subscribers existing Telephone number in Telgoo5. It should be 10 digits only.
PORT MDN string 1234567890 Required The MDN / MSISDN subscriber would like to port In. It should be 10 digits only.
PLAN ID string   Required This is the plan id on which subscriber will be on. The plan id list is returned in ExistingSubscriberPortin API.  
CARRIER string TMB Required This should be the carrier subscriber is on in Telgoo5. This can be obtained using GetCustomerInfo.
SOCIAL SECURITY NUMBER string 1234 Optional This is the last four digits of the social security number of the subscriber. Last four digits of SSN
OSP FIRST NAME string Tom Required Subscribers first name with old service provider.  
OSP MIDDLE NAME string Jay Optional Subscribers middle name with old service provider.  
OSP LAST NAME string Hari Required Subscribers Last name with old service provider.  
BUSINESS NAME string Tommy Optional This is the business name of the MVNO.  
OSP ADDRESS1 string 123 Main St Required This is the service address line 1 of the subscriber with old service provider(OSP).
OSP CITY string Houston Required This is the service address city of the subscriber with old service provider (OSP). Should allow only letters, hyphen and space.
OSP STATE string TX Required This is the service address state of the subscriber with old service provider (OSP). State should be standard abbreviated form.
OSP ZIP CODE string 73001 Required This is the service address state of the subscriber with old service provider (OSP). Should not allow letters and special characters, only numbers.Should be exactly 5 digits.
OSP ACCOUNT NUMBER string 22545558 Required This is the account number with old service provider (OSP).  
OSP ACCOUNT PASSWORD/PIN string 654165465 Required This is the subscribers account password/pin with old service providerThis is the service address state of the subscriber with old service provider (OSP). ANY combination of alpha numeric.  
COMPANY ID Numeric 28 Required A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany.
SET OLD ESN/SIM STATUS string Deactivate; Optional This is required in case of TMobile(TMB). This will set the existing SIM status in the inventory. Passing Deactivate will set the status to Deactivate in the inventory only. Deactivate
OLD ESN/SIM STATUS CHANGE REASON string   Optional This is a notes field to pass the reason for status change of the OLD ESN/SIM. Example: You can pass Portin.  
ASSIGN OLD ESN/SIM TO string testemp Conditional This is primarily for the purpose of assigning old ESN/SIM to the user. This is the Telgoo5 user login ID who will be assigned with the old SIM, more for accounting purposes. Employee Login ID can be obtained using another API called GetEmployeeDetail it should be Employee Login ID.
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></VENDORID>
<USERNAME></USERNAME>
<PASSWORD></PASSWORD>
<PIN></PIN>
<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<EXISTINGSUBSCRIBERPORTIN>
	<CUSTOMER_ID></CUSTOMER_ID>
	<ESN></ESN>
	<NEWESN></NEWESN>
	<ICCID></ICCID>
	<OLDMDN></OLDMDN>
	<PORT_MDN></PORT_MDN>
	<PLANID></PLANID>
	<CARRIER></CARRIER>
	<SSN></SSN>
	<BILLFIRSTNAME></BILLFIRSTNAME>
	<MIDDLE_NAME></MIDDLE_NAME>
	<BILLLASTNAME></BILLLASTNAME>
	<BUSINESS_NAME></BUSINESS_NAME>
	<ADDRESS1></ADDRESS1>
	<CITY></CITY>
	<STATE></STATE>
	<ZIP></ZIP>
	<ACNUMBER></ACNUMBER>
	<PASSWORDPIN></PASSWORDPIN>
	<COMPANY_ID></COMPANY_ID>
	<PORTIN_OLD_ESN_STATUS></PORTIN_OLD_ESN_STATUS>
	<PORTIN_OLD_ESN_REASON></PORTIN_OLD_ESN_REASON>
	<USER></USER>
	<SOURCE></SOURCE>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
</EXISTINGSUBSCRIBERPORTIN>
</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.
169 Company ID is required. Please provide company ID.
226 Customer ID is required. Please provide Customer ID.
321 Customer not found. Customer is not found.
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.
751 Custom message. This is dynamic message.
Sample Response 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>
        <referenceNumber></referenceNumber>
    </credentials>
    <ExistingSubscriberPortin>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</ExistingSubscriberPortin>
</VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide 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>
<ExistingSubscriberPortin>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</ExistingSubscriberPortin>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer 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>
<ExistingSubscriberPortin>
	<statusCode>321</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer not found.</errorDescription>
</ExistingSubscriberPortin>
</VcareOssApi>
Error Description: Customer not found.
How to Resolve?: Customer is not found.
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>
<ExistingSubscriberPortin>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ExistingSubscriberPortin>
</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>
<ExistingSubscriberPortin>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</ExistingSubscriberPortin>
</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.