UpdatePortin

The API will be used to send a update port in request to carrier for a pending port in Resolution Required Status.

End Point https://www.vcareapi.com/vcareOssApi/UpdatePortin/
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 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo.
COMPANY ID Numeric 28 Required A unique Company ID assigned to the MVNO. This can be obtained using another API called GetCompany.
SIM String 8901111111111111 Required ESN/SIM to which port in was placed on.  Used with the combination of MDN to validate the pending port in order.
SSN Numeric 1234 Optional This is the last four digits of the SSN of the subscriber. Last four digits of SSN
MDN Numeric 1234567890 Required Pending Port in Mobile telephone number [MDN]. Used with the combination of SIM to validate the pending port in order.
FIRST NAME string John Required Subscribers first name with the old service provider. Only
English alphabet letters, space, apostrophe, Accent Grave ("`") and hyphen.
Max length - 50 symbols.
Space characters at the start or end of the name the space should be cut off.
LAST NAME string Doe Required Subscribers last name with the old service provider.
STREET NAME string St, Dr Required This is the street name of service address line 1 of the applicant with old service provider.
STREET NUMBER Numeric 123 Required This is the street number of service address line 1 of the applicant with old service provider. Should allow only numbers
STREET DIRECTION string N, NW Optional This is the street direction of service address line 1 of the applicant with old service provider.  
Address 2 string APT 1 Optional This is the service address line 2 of the applicant with old service provider.  
CITY string Houston Required This is the city of service address of the applicant with old service provider. Should allow only letters, hyphen and space.
STATE string TX Required This is the State of the service address with old service provider. State should be standard abbreviated form.
ZIP CODE Numeric 73001 Required This is the Zip code of the service address of the applicant with old service provider. Should not allow letters and special characters, only numbers.
Should be exactly 5 digits.
OSP ACCOUNT NUMBER Numeric 22545558 Required Subscribers account number with old service provide.  
OSP ACCOUNT PASSWORD string 654165465 Required Subscribers account password with old service provider.  
OLD ESN string   Optional For internal use only. MVNO partner can decide not to pass any value.  
BIRTH DATE Numeric YYYY-MM-DD Optional This is the date of birth of the applicant. YYYY-MM-DD is expected.
CARRIER string SPR Required Carrier to which Port in request was created for. This accepts Carrier id which can be obtained from using another API called GetCompanyCarrier. Use the value passed in GetCompanyCarrier response tag CARRIERNAME. Abbreviation for carrier configured in Telgoo5.  
RETURN URL string   Optional    
AGENT ID string John Required
This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
  
AGENT PASSWORD 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>Vcarecorporation</VENDORID>
<USERNAME>Vcarecorporation</USERNAME>
<PASSWORD>Vcarecorporation</PASSWORD>
<PIN>123456789</PIN>
<REFERENCENUMBER>123456789</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
   <UPDATEPORTIN>
	<CUSTOMERID></CUSTOMERID>
	<COMPANYID>28</COMPANYID>
	<SIM>8901260713163533221</SIM>
	<SSN>111111111</SSN>
	<MDN>4058199607</MDN>
	<FIRSTNAME>test</FIRSTNAME>
	<LASTNAME>vcare</LASTNAME>
	<STREETNUMBER>114 test</STREETNUMBER>
	<STREETNAME>test</STREETNAME>
	<STREETDIRECTION></STREETDIRECTION>
	<ADD2></ADD2>
	<CITY>Oklahoma City</CITY>
	<STATE>OK</STATE>
	<ZIP>73101</ZIP>
	<OSPACCOUNTNUMBER>1122445</OSPACCOUNTNUMBER>
	<OSPACCOUNTPASSWORD>123456</OSPACCOUNTPASSWORD>
	<OLDESN></OLDESN>
	<DOB></DOB>
	<CARRIER></CARRIER>
	<RETURNURL></RETURNURL>
	<AGENTID>TAGAGENT</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
  </UPDATEPORTIN>
</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.
15 Zip code is invalid. Please enter valid zip code.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
25 Customer ID is invalid. Provide a valid Customer ID.
41 Carrier is invalid. Please provide valid Carrier.
43 Multiple input errors. Please check description. This is providing multiple dynamic errors.
44 Input error. Please check description. This is provided dynamic error.
126 Invalid MDN. Please provide valid MDN.
130 Invalid Company ID. Please provide valid company id.
169 Company ID is required. Please provide company ID.
226 Customer ID is required. Please provide Customer ID.
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.
453 Password pin should not be blank. Enter a valid Password PIN. Password PIN should not be blank.
454 Account number should not be blank. Enter a valid Account. Account should not be blank.
473 SIM Type should not be blank. Enter a valid SIM Type. SIM Type should not be blank.
492 Zip code should not be blank. Provide correct Zip code. Zip code should not be blank.
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>
 <UpdatePortin>
	<statusCode>00</statusCode>
	<description>SUCCESS</description>
	<errorDescription>SUCCESS</errorDescription>
	<MDN>9876543210</MDN>
	<RESULT></RESULT>
  </UpdatePortin>
</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>
<UpdatePortin>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid Password.
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>
<UpdatePortin>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Zip code is invalid.
How to Resolve?: Please enter valid zip code.
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>
<UpdatePortin>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
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>
<UpdatePortin>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer ID.
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>
<UpdatePortin>
	<statusCode>41</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier is invalid.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Carrier is invalid.
How to Resolve?: Please provide valid Carrier.
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>
<UpdatePortin>
	<statusCode>43</statusCode>
	<description>FAIL</description>
	<errorDescription>Multiple input errors.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Multiple input errors.
How to Resolve?: Please check description. This is providing multiple dynamic errors.
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>
<UpdatePortin>
	<statusCode>44</statusCode>
	<description>FAIL</description>
	<errorDescription>Input error.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Input error.
How to Resolve?: Please check description. This is provided dynamic error.
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>
<UpdatePortin>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Invalid MDN.
How to Resolve?: Please provide valid MDN.
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>
<UpdatePortin>
	<statusCode>130</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Company ID.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Invalid Company ID.
How to Resolve?: Please provide valid company id.
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>
<UpdatePortin>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide company ID.
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>
<UpdatePortin>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer ID.
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>
<UpdatePortin>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<UpdatePortin>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</UpdatePortin>
</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: 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>
<UpdatePortin>
	<statusCode>453</statusCode>
	<description>FAIL</description>
	<errorDescription>Password pin should not be blank.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Password pin should not be blank.
How to Resolve?: Enter a valid Password PIN. Password PIN should not be blank.
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>
<UpdatePortin>
	<statusCode>454</statusCode>
	<description>FAIL</description>
	<errorDescription>Account number should not be blank.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Account number should not be blank.
How to Resolve?: Enter a valid Account. Account should not be blank.
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>
<UpdatePortin>
	<statusCode>473</statusCode>
	<description>FAIL</description>
	<errorDescription>SIM Type should not be blank.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: SIM Type should not be blank.
How to Resolve?: Enter a valid SIM Type. SIM Type should not be blank.
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>
<UpdatePortin>
	<statusCode>492</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code  should not be blank.</errorDescription>
</UpdatePortin>
</VcareOssApi>
Error Description: Zip code should not be blank.
How to Resolve?: Provide correct Zip code. Zip code should not be blank.
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>
<UpdatePortin>
	<statusCode>751</statusCode>
	<description>FAIL</description>
	<errorDescription>Custom message.</errorDescription>
</UpdatePortin>
</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.