GetChainPermissions

This API is used to get the Chain Permissions details.

End Point https://www.vcareapi.com/vcareOssApi/GetChainPermissions/
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.
REFERENCENUMBER string 123456789 Required Auto generated unique reference number is required to be passed with each transaction.
LOGINID String John Required A unique LOGINID and id assigned to the MVNO.
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 do not 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 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>XXXXXXXXX</VENDORID>
 <USERNAME>XXXXXXXX</USERNAME>
 <PASSWORD>XXXXXXXXX</PASSWORD>
 <PIN>XXXXXXXXXX</PIN>
 <REFERENCENUMBER>XXXXXXX</REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<GETCHAINPERMISSIONS>
	<LOGINID></LOGINID>
	<AGENTID></AGENTID>
	<AGENTPASSWORD></AGENTPASSWORD>
	<SOURCE></SOURCE>
</GETCHAINPERMISSIONS>
</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.
16 Vendor not found. Wrong credentials. Please enter valid vendor credentials.
336 No Record Found For this Agent. No Record is found for this Agent.
506 Login ID should not be blank. Provide a valid Login ID. Login ID should not be blank.
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>XXXX</vendorId>
        <referenceNumber>XXXXX</referenceNumber>
    </credentials>
    <GetChainPermissions>
        <statusCode></statusCode>
        <description></description>
        <errorDescription></errorDescription>
        <user_id></user_id>
        <m_ids></m_ids>
        <d_ids></d_ids>
        <r_ids></r_ids>
        <e_ids></e_ids>
        <is_auto_add_eids></is_auto_add_eids>
        <is_auto_add_rids></is_auto_add_rids>
        <is_auto_add_dids></is_auto_add_dids>
        <status></status>
        <modified_by></modified_by>
    </GetChainPermissions>
</VcareOssApi>
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>
	<GetChainPermissions>
		<statusCode>13</statusCode>
		<description>FAIL</description>
		<errorDescription>Password is invalid.</errorDescription>
</GetChainPermissions>
</VcareOssApi>
Error Description: Password is invalid.
How to Resolve?: Provide a valid 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>
	<GetChainPermissions>
		<statusCode>16</statusCode>
		<description>FAIL</description>
		<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetChainPermissions>
</VcareOssApi>
Error Description: Vendor not found. Wrong credentials.
How to Resolve?: Please enter valid vendor credentials.
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>
	<GetChainPermissions>
		<statusCode>336</statusCode>
		<description>FAIL</description>
		<errorDescription>No Record Found For this Agent.</errorDescription>
</GetChainPermissions>
</VcareOssApi>
Error Description: No Record Found For this Agent.
How to Resolve?: No Record is found for this Agent.
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>
	<GetChainPermissions>
		<statusCode>506</statusCode>
		<description>FAIL</description>
		<errorDescription>Login ID should not be blank.</errorDescription>
</GetChainPermissions>
</VcareOssApi>
Error Description: Login ID should not be blank.
How to Resolve?: Provide a valid Login ID. Login ID should not be blank.

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