SwapMdn

This XML API is used to swap/change subscriber's telephone number. This allows you to change an MDN electronically or non electronically. This api also allows you to bypass NLAD update for new mdn.

End Point https://www.vcareapi.com/vcareOssApi/SwapMDN/
Field 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.
CUSTOMER ID Numeric 123456 Required Auto generated customer account number. This is returned in GetCustomerInfo
ESN / SIM string 8901260713156280780 Required This is returned in the Getcustomerinfo Can be alpha numeric. Max length = 30
EXISTING MDN Numeric 1234567890 Required Subscribers existing telephone number. This can be obtained using another api called GetCustomerinfo. Max 10 digits. Hyphen not allowed.
NEW MDN Numeric 1234567890 Conditional New MDN is required only in case you are doing NONELECTRONIC change. Max 10 digits. Hyphen not allowed.
COMPANYID Numeric 28 Required This can be obtained using another API call GetCompany.
CARRIER string TMB Required This can be obtained using another API call GetCompany. This accepts Carrier abbreviation configured for a carrier in Telgoo5 Carrier Abbreviation
CHANGE TYPE string NONELECTRONIC Required

• NONELECTRONIC

• ELECTRONIC
BYPASS NLAD string NO Required Yes will bypass the NLAD mdn update. We recommend to pass No so the new MDN gets updated on NLAD as well. YES or NO. Capital letters expected.
ZIPCODE string 73001 Required This is the zipcode on which the new MDN will be generated. This is only required in case of ELECTRONIC change
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
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.
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>Vcarecorporation</PIN>
<REFERENCENUMBER>11111</REFERENCENUMBER>
 </CREDENTIALS>
 <VCAREOSS>
 <SWAPMDN>
	<CUSTOMERID>2115386</CUSTOMERID>
	<ESN>8901260713156294161</ESN>
	<OLDMDN>4056386954</OLDMDN>
	<NEWMDN></NEWMDN>
	<COMPANYID>28</COMPANYID>
	<CARRIER>TMB</CARRIER>
	<CHANGETYPE>ELECTRONIC</CHANGETYPE>
	<NLADBYPASS>NO</NLADBYPASS>
	<ZIPCODE>21215</ZIPCODE>
	<AGENTID>Zeeshan Ahmed</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
</SWAPMDN>
</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.
15 Zip code is invalid. Please enter valid zip code.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
113 Zip Code is required. Zip code cannot be blank. You should enter a valid Zip code.
114 Zip Code is not correct. Please provide correct zip code.
126 Invalid MDN. Please provide valid MDN.
130 Invalid Company ID. Please provide valid company id.
154 Old MDN not belong to this customer ID. Please provide valid value as old MDN is not belonging to this customer ID.
155 ESN/SIM not belong to this customer ID. Please provide valid value as old ESN/SIM is not belonging to this customer ID.
156 Invalid Carrier name. Please provide a valid Carrier name.
157 Carrier not belongs to this customer ID. Please provide valid value as Carrier is not belonging to this customer ID.
158 ESN/SIM is required. Please provide an ESN.
159 New MDN is required. Please provide a MDN.
169 Company ID is required. Please provide company ID.
226 Customer ID is required. Please provide Customer ID.
254 Old MDN is required. Please provide Old MDN.
321 Customer not found. Customer is not found.
356 Agent ID cannot be blank. Please provide Agent ID as it cannot be blank.
367 MDN should be 10 digits. Please provide a valid MDN and it should be 10 digits.
374 Change Type should not be blank. Please provide Change Type as it cannot be blank.
377 Change Type is not valid. Please provide a valid Change Type.
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.
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>Vcarecorporation</vendorId>
        <referenceNumber>11111</referenceNumber>
    </credentials>
    <SwapMdn>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>MDN Changed Successfully. </errorDescription>
<newMDN>1234567890</newMDN>
    </SwapMdn>
</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>
<SwapMDN>
	<statusCode>01</statusCode>
	<description>FAIL</description>
	<errorDescription>Error Received from Carrier.</errorDescription>
</SwapMDN>
</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>
<SwapMDN>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</SwapMDN>
</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>
<SwapMDN>
	<statusCode>15</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip code is invalid.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Zip code is invalid.
How to Resolve?: Please enter valid zip code.
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>
<SwapMDN>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
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>
<SwapMDN>
	<statusCode>113</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip Code is required.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Zip Code is required.
How to Resolve?: Zip code cannot be blank. You should enter a valid 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>
<SwapMDN>
	<statusCode>114</statusCode>
	<description>FAIL</description>
	<errorDescription>Zip Code is not correct.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Zip Code is not correct.
How to Resolve?: Please provide correct zip code.
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>
<SwapMDN>
	<statusCode>126</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid MDN.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Invalid MDN.
How to Resolve?: Please provide valid MDN.
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>
<SwapMDN>
	<statusCode>130</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Company ID.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Invalid Company ID.
How to Resolve?: Please provide valid company id.
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>
<SwapMDN>
	<statusCode>154</statusCode>
	<description>FAIL</description>
	<errorDescription>Old MDN not belong to this customer ID.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Old MDN not belong to this customer ID.
How to Resolve?: Please provide valid value as old MDN is not belonging to this customer ID.
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>
<SwapMDN>
	<statusCode>155</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN/SIM not belong to this customer ID.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: ESN/SIM not belong to this customer ID.
How to Resolve?: Please provide valid value as old ESN/SIM is not belonging to this customer ID.
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>
<SwapMDN>
	<statusCode>156</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Carrier name.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Invalid Carrier name.
How to Resolve?: Please provide a valid Carrier name.
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>
<SwapMDN>
	<statusCode>157</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier not belongs to this customer ID.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Carrier not belongs to this customer ID.
How to Resolve?: Please provide valid value as Carrier is not belonging to this customer ID.
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>
<SwapMDN>
	<statusCode>158</statusCode>
	<description>FAIL</description>
	<errorDescription>ESN/SIM  is required.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: ESN/SIM is required.
How to Resolve?: Please provide an ESN.
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>
<SwapMDN>
	<statusCode>159</statusCode>
	<description>FAIL</description>
	<errorDescription>New MDN is required.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: New MDN is required.
How to Resolve?: Please provide a MDN.
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>
<SwapMDN>
	<statusCode>169</statusCode>
	<description>FAIL</description>
	<errorDescription>Company ID is required.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Company ID is required.
How to Resolve?: Please provide company ID.
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>
<SwapMDN>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer ID.
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>
<SwapMDN>
	<statusCode>254</statusCode>
	<description>FAIL</description>
	<errorDescription>Old MDN is required.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Old MDN is required.
How to Resolve?: Please provide Old MDN.
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>
<SwapMDN>
	<statusCode>321</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer not found.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Customer not found.
How to Resolve?: Customer is not found.
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>
<SwapMDN>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
Sample Fail Response: 20
<?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>
<SwapMDN>
	<statusCode>367</statusCode>
	<description>FAIL</description>
	<errorDescription>MDN should be 10 digits.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: MDN should be 10 digits.
How to Resolve?: Please provide a valid MDN and it should be 10 digits.
Sample Fail Response: 21
<?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>
<SwapMDN>
	<statusCode>374</statusCode>
	<description>FAIL</description>
	<errorDescription>Change Type  should not be blank.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Change Type should not be blank.
How to Resolve?: Please provide Change Type as it cannot be blank.
Sample Fail Response: 22
<?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>
<SwapMDN>
	<statusCode>377</statusCode>
	<description>FAIL</description>
	<errorDescription>Change Type is not valid.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Change Type is not valid.
How to Resolve?: Please provide a valid Change Type.
Sample Fail Response: 23
<?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>
<SwapMDN>
	<statusCode>449</statusCode>
	<description>FAIL</description>
	<errorDescription>Carrier should not be blank.</errorDescription>
</SwapMDN>
</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: 24
<?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>
<SwapMDN>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</SwapMDN>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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