ResetPassword

This XML API is used to change the customer's account password

End Point https://www.vcareapi.com/vcareOssApi/ResetPassword/
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 number. This is returned in Getcustomerinfo
PASSWORD string 1234xzc56 Required Subscribers new account password. A password consists of 4 digit only.
REQUEST TYPE string FORGOT PASSWORD Required FORGOT PASSWORD OR RESET PASSWORD
UNIQUE CODE numeric 123456 conditional if REQUEST_TYPE = FORGOT PASSWORD then UNIQUE_CODE is Required
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE,CUSTOMERPORTAL
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 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>
<RESETPASSWORD>
	<CUSTOMERID>2115387</CUSTOMERID>
	<PASSWORD>wrgewr46</PASSWORD>
	<REQUEST_TYPE>FORGOT PASSWORD</REQUEST_TYPE>
	<UNIQUE_CODE>21321321</UNIQUE_CODE>
	<AGENTID>Zeeshan Ahmed</AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE>API</SOURCE>
</RESETPASSWORD>
</VCAREOSS>
</VCAREOSSAPI>
List of status code, description and resolution.
Status Code Description How to Resolve?
00 SUCCESS SUCCESS
02 A password consists of 4 digits only. Provide a valid 4 digits password.
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.
226 Customer ID is required. Please provide Customer ID.
296 Customer Password should not be blank. Please provide Customer Password.
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.
716 Request type should be FORGOT PASSWORD OR RESET PASSWORD. You have one 2 options for Request type as FORGOT PASSWORD or RESET PASSWORD. Request type should be FORGOT PASSWORD OR RESET PASSWORD.
717 Unique code should not be blank. Provide a valid Unique code. Unique code should not be blank.
718 Unique code is invalid. Please provide a valid Unique code. Given value is invalid for Unique code.
Sample Success 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>
    <ResetPassword>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </ResetPassword>
</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>
<ResetPassword>
	<statusCode>02</statusCode>
	<description>FAIL</description>
	<errorDescription>A password consists of 4 digits only.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: A password consists of 4 digits only.
How to Resolve?: Provide a valid 4 digits password.
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>
<ResetPassword>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</ResetPassword>
</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>
<ResetPassword>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</ResetPassword>
</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>
<ResetPassword>
	<statusCode>25</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is invalid.</errorDescription>
</ResetPassword>
</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>
<ResetPassword>
	<statusCode>226</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer ID is required.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Customer ID is required.
How to Resolve?: Please provide Customer 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>
<ResetPassword>
	<statusCode>296</statusCode>
	<description>FAIL</description>
	<errorDescription>Customer Password should not be blank.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Customer Password should not be blank.
How to Resolve?: Please provide Customer Password.
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>
<ResetPassword>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<ResetPassword>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<ResetPassword>
	<statusCode>716</statusCode>
	<description>FAIL</description>
	<errorDescription>Request type should be FORGOT PASSWORD OR RESET PASSWORD.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Request type should be FORGOT PASSWORD OR RESET PASSWORD.
How to Resolve?: You have one 2 options for Request type as FORGOT PASSWORD or RESET PASSWORD. Request type should be FORGOT PASSWORD OR RESET PASSWORD.
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>
<ResetPassword>
	<statusCode>717</statusCode>
	<description>FAIL</description>
	<errorDescription>Unique code should not be blank.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Unique code should not be blank.
How to Resolve?: Provide a valid Unique code. Unique code should not be blank.
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>
<ResetPassword>
	<statusCode>718</statusCode>
	<description>FAIL</description>
	<errorDescription>Unique code  is invalid.</errorDescription>
</ResetPassword>
</VcareOssApi>
Error Description: Unique code is invalid.
How to Resolve?: Please provide a valid Unique code. Given value is invalid for Unique code.

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