Telgoo5 APIs

RemoveAgentPermission

This API is used to set the agent manage user level permission.

End Point

https://www.vcareapi.com/vcareOssApi/RemoveAgentPermission/

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.

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.

MASTER

String

Conditional

Master Login Id. Require at least one input from MASTER,DISTRIBUTOR,RETAILER,EMPLOYEE filled.

A valid Master login ID

DISTRIBUTOR

String

Conditional

Distributor Login Id. Require at least one input from MASTER,DISTRIBUTOR,RETAILER,EMPLOYEE filled.

A valid Distributor login ID

RETAILER

string

Conditional

Retailer Login Id. Require at least one input from MASTER,DISTRIBUTOR,RETAILER,EMPLOYEE filled.

A valid Retailer login ID.

EMPLOYEE

String

Conditional

Employee Login Id.Require at least one input from MASTER,DISTRIBUTOR,RETAILER,EMPLOYEE filled.

A valid Employee login ID.

LOGINID

string

John Doe

Required

This is the Telgoo5 user id to give permission request.

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.

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></VENDORID>
 <USERNAME></USERNAME>
 <PASSWORD></PASSWORD>
 <PIN></PIN>
 <REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<REMOVEAGENTPERMISSION>
<LOGINID></LOGINID>
<MASTERAGENTREMOVE><MASTERID></MASTERID></MASTERAGENTREMOVE>
<DISTRIBUTORREMOVE><DISTRIBUTORID></DISTRIBUTORID></DISTRIBUTORREMOVE>
<RETAILERREMOVE><RETAILERID></RETAILERID></RETAILERREMOVE>
<EMPLOYEEREMOVE>
<EMPLOYEEID></EMPLOYEEID>
<EMPLOYEEID></EMPLOYEEID>
<EMPLOYEEID></EMPLOYEEID>
</EMPLOYEEREMOVE>
<AGENTID></AGENTID>
<AGENTPASSWORD></AGENTPASSWORD>
<SOURCE></SOURCE>
</REMOVEAGENTPERMISSION>
</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.
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.
506	Login ID should not be blank.	Provide a valid Login ID. Login ID should not be blank.
554	Master ID is invalid.	Provide a Master ID. Master ID is mandatory.
555	Distributor ID is invalid.	Provide a Distributor ID. Distributor ID is mandatory.
556	Retailer ID is invalid.	Provide a Retailer ID. Retailer ID is mandatory.
557	Employee ID is invalid.	Provide a Employee ID. Employee ID is mandatory.
584	Login ID not found in user level permission.	Please check Login ID user level permission.
591	Master OR Distributor OR Retailer OR Employee login ID is not empty.	Provide correct Login ID. Master OR Distributor OR Retailer OR Employee login ID is not empty.

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>111111</referenceNumber>
    </credentials>
    <RemoveAgentPermission>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
    </RemoveAgentPermission>
</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>
<RemoveAgentPermission>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</RemoveAgentPermission>
</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>
<RemoveAgentPermission>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</RemoveAgentPermission>
</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>
<RemoveAgentPermission>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Agent ID cannot be blank.

How to Resolve?: Please provide Agent ID as it cannot be blank.

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>
<RemoveAgentPermission>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Invalid Source.

How to Resolve?: Please provide a valid Source. Given value is invalid for Source.

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>
<RemoveAgentPermission>
	<statusCode>506</statusCode>
	<description>FAIL</description>
	<errorDescription>Login ID should not be blank.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Login ID should not be blank.

How to Resolve?: Provide a valid Login ID. Login ID should not be blank.

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>
<RemoveAgentPermission>
	<statusCode>554</statusCode>
	<description>FAIL</description>
	<errorDescription>Master ID is invalid.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Master ID is invalid.

How to Resolve?: Provide a Master ID. Master ID is mandatory.

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>
<RemoveAgentPermission>
	<statusCode>555</statusCode>
	<description>FAIL</description>
	<errorDescription>Distributor ID is invalid.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Distributor ID is invalid.

How to Resolve?: Provide a Distributor ID. Distributor ID is mandatory.

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>
<RemoveAgentPermission>
	<statusCode>556</statusCode>
	<description>FAIL</description>
	<errorDescription>Retailer ID is invalid.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Retailer ID is invalid.

How to Resolve?: Provide a Retailer ID. Retailer ID is mandatory.

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>
<RemoveAgentPermission>
	<statusCode>557</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee ID is invalid.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Employee ID is invalid.

How to Resolve?: Provide a Employee ID. Employee ID is mandatory.

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>
<RemoveAgentPermission>
	<statusCode>584</statusCode>
	<description>FAIL</description>
	<errorDescription>Login ID not found in user level permission.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Login ID not found in user level permission.

How to Resolve?: Please check Login ID user level permission.

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>
<RemoveAgentPermission>
	<statusCode>591</statusCode>
	<description>FAIL</description>
	<errorDescription>Master OR Distributor OR Retailer OR Employee login ID is not empty.</errorDescription>
</RemoveAgentPermission>
</VcareOssApi>

Error Description: Master OR Distributor OR Retailer OR Employee login ID is not empty.

How to Resolve?: Provide correct Login ID. Master OR Distributor OR Retailer OR Employee login ID is not empty.

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