SwapESN
This XML API is used to swap/change the ESN/SIM on the subscriber's account.
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> <SWAPESN> <CUSTOMERID>2115386</CUSTOMERID> <MDN>12345678904</MDN> <OLDESN>8901260713156294161</OLDESN> <OLDUICCID></OLDUICCID> <NEWESN>8901260713156294000</NEWESN> <NEWUICCID></NEWUICCID> <CARRIER>TMB</CARRIER> <CHANGETYPE>NONELECTRONIC</CHANGETYPE> <CHANGEREASON>BAD</CHANGEREASON> <CHANGENOTES></CHANGENOTES> <MODELID>iPhone7s</MODELID> <STORETYPE>Employee</STORETYPE> <STOREID>Zeeshan Ahmed</STOREID> <IS_ESIM_SWAP></IS_ESIM_SWAP> <ESIM_EID></ESIM_EID> <AGENTID>Zeeshan Ahmed</AGENTID> <AGENTPASSWORD></AGENTPASSWORD> <SOURCE>API</SOURCE> </SWAPESN> </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. |
25 | Customer ID is invalid. | Provide a valid Customer ID. |
41 | Carrier is invalid. | Please provide valid Carrier. |
153 | New ESN OR New UICCID is required. | Please provide New ESN OR New UICCID. |
170 | Carrier ID is required. | Please provide a Carrier ID. |
225 | Model ID is required. | Please provide Model ID. |
253 | Old ESN is required. | Please provide Old ESN. |
255 | Change Reason is required. | Please provide Change Reason. |
351 | ESN must be greater than 8 and less than 26 characters. | Please provide a valid ESN and it must be greater than 8 and less than 26 characters. |
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. |
368 | Store Type should not be blank. | Please provide Store Type as it cannot be blank. |
369 | Store Type not valid. | Please provide a valid Store Type. |
370 | Store ID should not be blank. | Please provide Store ID as it cannot be blank. |
374 | Change Type should not be blank. | Please provide Change Type as it cannot be blank. |
375 | Change Reason is not valid. | Please provide a valid Change Reason. |
376 | Model ID is not valid. | Please provide a valid Model ID. |
377 | Change Type is not valid. | Please provide a valid Change Type. |
457 | Invalid Source. | Please provide a valid Source. Given value is invalid for Source. |
462 | UICCID should not be blank. | Enter a valid UICCID. UICCID should not be blank. |
486 | UICCID must be greater than 8 and less than 25 characters. | Provide correct UICCID which must be greater than 8 and less than 25 characters. |
762 | Old UICCID is invalid OR not available. | Please provide a valid Old UICCID. Old UICCID value should be Invalid or Not Available. |
763 | Old UICCID is not match in our system. | Provide another Old UICCID. |
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> <SwapESN> <statusCode>00</statusCode> <description>SUCCESS</description> <errorDescription>SUCCESS</errorDescription> </SwapESN> </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> <SwapESN> <statusCode>01</statusCode> <description>FAIL</description> <errorDescription>Error Received from Carrier.</errorDescription> </SwapESN> </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> <SwapESN> <statusCode>13</statusCode> <description>FAIL</description> <errorDescription>Password is invalid.</errorDescription> </SwapESN> </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> <SwapESN> <statusCode>16</statusCode> <description>FAIL</description> <errorDescription>Vendor not found. Wrong credentials.</errorDescription> </SwapESN> </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> <SwapESN> <statusCode>25</statusCode> <description>FAIL</description> <errorDescription>Customer ID is invalid.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Customer ID is invalid.
How to Resolve?: Provide a valid Customer ID.
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> <SwapESN> <statusCode>41</statusCode> <description>FAIL</description> <errorDescription>Carrier is invalid.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Carrier is invalid.
How to Resolve?: Please provide valid Carrier.
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> <SwapESN> <statusCode>153</statusCode> <description>FAIL</description> <errorDescription>New ESN OR New UICCID is required.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: New ESN OR New UICCID is required.
How to Resolve?: Please provide New ESN OR New UICCID.
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> <SwapESN> <statusCode>170</statusCode> <description>FAIL</description> <errorDescription>Carrier ID is required.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Carrier ID is required.
How to Resolve?: Please provide a Carrier ID.
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> <SwapESN> <statusCode>225</statusCode> <description>FAIL</description> <errorDescription>Model ID is required.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Model ID is required.
How to Resolve?: Please provide Model 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> <SwapESN> <statusCode>253</statusCode> <description>FAIL</description> <errorDescription>Old ESN is required.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Old ESN is required.
How to Resolve?: Please provide Old ESN.
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> <SwapESN> <statusCode>255</statusCode> <description>FAIL</description> <errorDescription>Change Reason is required.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Change Reason is required.
How to Resolve?: Please provide Change Reason.
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> <SwapESN> <statusCode>351</statusCode> <description>FAIL</description> <errorDescription>ESN must be greater than 8 and less than 26 characters.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: ESN must be greater than 8 and less than 26 characters.
How to Resolve?: Please provide a valid ESN and it must be greater than 8 and less than 26 characters.
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> <SwapESN> <statusCode>356</statusCode> <description>FAIL</description> <errorDescription>Agent ID cannot be blank.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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> <SwapESN> <statusCode>367</statusCode> <description>FAIL</description> <errorDescription>MDN should be 10 digits.</errorDescription> </SwapESN> </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: 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> <SwapESN> <statusCode>368</statusCode> <description>FAIL</description> <errorDescription>Store Type should not be blank.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Store Type should not be blank.
How to Resolve?: Please provide Store Type as it cannot be blank.
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> <SwapESN> <statusCode>369</statusCode> <description>FAIL</description> <errorDescription>Store Type not valid.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Store Type not valid.
How to Resolve?: Please provide a valid Store Type.
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> <SwapESN> <statusCode>370</statusCode> <description>FAIL</description> <errorDescription>Store ID should not be blank.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Store ID should not be blank.
How to Resolve?: Please provide Store ID as it cannot be blank.
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> <SwapESN> <statusCode>374</statusCode> <description>FAIL</description> <errorDescription>Change Type should not be blank.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Change Type should not be blank.
How to Resolve?: Please provide Change Type as it cannot be blank.
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> <SwapESN> <statusCode>375</statusCode> <description>FAIL</description> <errorDescription>Change Reason is not valid.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Change Reason is not valid.
How to Resolve?: Please provide a valid Change Reason.
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> <SwapESN> <statusCode>376</statusCode> <description>FAIL</description> <errorDescription>Model ID is not valid.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Model ID is not valid.
How to Resolve?: Please provide a valid Model ID.
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> <SwapESN> <statusCode>377</statusCode> <description>FAIL</description> <errorDescription>Change Type is not valid.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Change Type is not valid.
How to Resolve?: Please provide a valid Change Type.
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> <SwapESN> <statusCode>457</statusCode> <description>FAIL</description> <errorDescription>Invalid Source.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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> <SwapESN> <statusCode>462</statusCode> <description>FAIL</description> <errorDescription>UICCID should not be blank.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: UICCID should not be blank.
How to Resolve?: Enter a valid UICCID. UICCID should not be blank.
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> <SwapESN> <statusCode>486</statusCode> <description>FAIL</description> <errorDescription>UICCID must be greater than 8 and less than 25 characters.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: UICCID must be greater than 8 and less than 25 characters.
How to Resolve?: Provide correct UICCID which must be greater than 8 and less than 25 characters.
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> <SwapESN> <statusCode>762</statusCode> <description>FAIL</description> <errorDescription>Old UICCID is invalid OR not available.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Old UICCID is invalid OR not available.
How to Resolve?: Please provide a valid Old UICCID. Old UICCID value should be Invalid or Not Available.
Sample Fail Response: 25
<?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> <SwapESN> <statusCode>763</statusCode> <description>FAIL</description> <errorDescription>Old UICCID is not match in our system.</errorDescription> </SwapESN> </VcareOssApi>
Error Description: Old UICCID is not match in our system.
How to Resolve?: Provide another Old UICCID.
All the status codes are listed under the status code sections. Please click here to go to the status code.