GetEmployeeDetail

XML API Request and Response for get employee detail.

End Point https://www.vcareapi.com/vcareOssApi/GetEmployeeDetail/
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.
MASTER LOGIN ID string samplemaster Optional This is the master agent login id.  
DISTRIBUTOR LOGIN ID string sampledistributor Optional This is the distributor agent login id.
RETAILER LOGIN ID string samplereteler Optional This is the reteler agent login id.
EMPLOYEE LOGIN ID string Optional This is the ISO/agent login id.
EMPLOYEE FIRST NAME string Conditional First name of the ISO/Agent login id
EMPLOYEE LAST NAME string Conditional Last name of the ISO/Agent login id
SOURCE string API Optional Source of the order/application Expected Value:API, TABLET, IVR, WEBSITE
AGENT ID string John Doe Required This is the Telgoo5 user id.For the Agent/Employee who is sending the API request.
AGENT PASSWORD 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></VENDORID>
<USERNAME></USERNAME>
<PASSWORD></PASSWORD>
<PIN></PIN>
<REFERENCENUMBER></REFERENCENUMBER>
</CREDENTIALS>
<VCAREOSS>
<GETEMPLOYEEDETAIL>
<MASTERLOGINID></MASTERLOGINID>
<DISTRIBUTORLOGINID></DISTRIBUTORLOGINID>
<RETAILERLOGINID></RETAILERLOGINID>
<EMPLOYEELOGINID></EMPLOYEELOGINID>
<EMPLOYEEFIRSTNAME></EMPLOYEEFIRSTNAME>
<EMPLOYEELASTNAME></EMPLOYEELASTNAME>
<AGENTID></AGENTID>
<AGENTPASSWORD></AGENTPASSWORD>
<SOURCE></SOURCE>
</GETEMPLOYEEDETAIL>
</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.
243 Record(s) not found. Please provide valid value as Record(s) not found.
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.
520 Employee first name and last name required. Provide correct Employee first name and last name. Employee first name and last name should not be blank.
521 Employee first name required. Employee first name is mandatory.
522 Employee last name required. Employee last name is mandatory.
523 Master LoginId is invalid. Provide a valid Master LoginId.
524 Master LoginId Inactive. Provide an active Master Loginid.
525 Distributor LoginId invalid. Provide a valid Distributor LoginId.
526 Distributor LoginId Inactive. Provide an active Distributor LoginId.
527 Retailer LoginId invalid. Provide a valid Retailer LoginId.
528 Retailer LoginId Inactive. Provide an active Retailer LoginId.
529 Employee LoginId invalid. Provide a valid Employee LoginId.
530 Employee LoginId Inactive. Provide an active Employee LoginId.
Sample Response 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>
        <referenceNumber>1111111</referenceNumber>
    </credentials>
    <GetEmployeeDetail>
        <statusCode>00</statusCode>
        <description>SUCCESS</description>
        <errorDescription>SUCCESS</errorDescription>
        <employeelist>
            <masterAgentName></masterAgentName>
            <distributorAgentName></distributorAgentName>
            <retailerAgentName></retailerAgentName>
            <employeeName>)</employeeName>
        </employeelist>
    </GetEmployeeDetail>
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>
<GetEmployeeDetail>
	<statusCode>13</statusCode>
	<description>FAIL</description>
	<errorDescription>Password is invalid.</errorDescription>
</GetEmployeeDetail>
</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>
<GetEmployeeDetail>
	<statusCode>16</statusCode>
	<description>FAIL</description>
	<errorDescription>Vendor not found. Wrong credentials.</errorDescription>
</GetEmployeeDetail>
</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>
<GetEmployeeDetail>
	<statusCode>243</statusCode>
	<description>FAIL</description>
	<errorDescription>Record(s) not found.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Record(s) not found.
How to Resolve?: Please provide valid value as Record(s) not found.
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>
<GetEmployeeDetail>
	<statusCode>356</statusCode>
	<description>FAIL</description>
	<errorDescription>Agent ID cannot be blank.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Agent ID cannot be blank.
How to Resolve?: Please provide Agent ID as it cannot be blank.
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>
<GetEmployeeDetail>
	<statusCode>457</statusCode>
	<description>FAIL</description>
	<errorDescription>Invalid Source.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Invalid Source.
How to Resolve?: Please provide a valid Source. Given value is invalid for Source.
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>
<GetEmployeeDetail>
	<statusCode>520</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee first name and last name required.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Employee first name and last name required.
How to Resolve?: Provide correct Employee first name and last name. Employee first name and last name should not be blank.
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>
<GetEmployeeDetail>
	<statusCode>521</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee first name required.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Employee first name required.
How to Resolve?: Employee first name 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>
<GetEmployeeDetail>
	<statusCode>522</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee last name required.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Employee last name required.
How to Resolve?: Employee last name 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>
<GetEmployeeDetail>
	<statusCode>523</statusCode>
	<description>FAIL</description>
	<errorDescription>Master LoginId is invalid.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Master LoginId is invalid.
How to Resolve?: Provide a valid Master LoginId.
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>
<GetEmployeeDetail>
	<statusCode>524</statusCode>
	<description>FAIL</description>
	<errorDescription>Master LoginId Inactive.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Master LoginId Inactive.
How to Resolve?: Provide an active Master Loginid.
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>
<GetEmployeeDetail>
	<statusCode>525</statusCode>
	<description>FAIL</description>
	<errorDescription>Distributor LoginId invalid.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Distributor LoginId invalid.
How to Resolve?: Provide a valid Distributor LoginId.
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>
<GetEmployeeDetail>
	<statusCode>526</statusCode>
	<description>FAIL</description>
	<errorDescription>Distributor LoginId Inactive.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Distributor LoginId Inactive.
How to Resolve?: Provide an active Distributor LoginId.
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>
<GetEmployeeDetail>
	<statusCode>527</statusCode>
	<description>FAIL</description>
	<errorDescription>Retailer LoginId invalid.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Retailer LoginId invalid.
How to Resolve?: Provide a valid Retailer LoginId.
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>
<GetEmployeeDetail>
	<statusCode>528</statusCode>
	<description>FAIL</description>
	<errorDescription>Retailer LoginId Inactive.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Retailer LoginId Inactive.
How to Resolve?: Provide an active Retailer LoginId.
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>
<GetEmployeeDetail>
	<statusCode>529</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee LoginId invalid.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Employee LoginId invalid.
How to Resolve?: Provide a valid Employee LoginId.
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>
<GetEmployeeDetail>
	<statusCode>530</statusCode>
	<description>FAIL</description>
	<errorDescription>Employee LoginId Inactive.</errorDescription>
</GetEmployeeDetail>
</VcareOssApi>
Error Description: Employee LoginId Inactive.
How to Resolve?: Provide an active Employee LoginId.

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