API Documentation

Get Client Location

The Get Client Location API retrieves the list of locations associated with the specified client. This API is used to fetch location records configured under a client within the QEval system.

URL https://{Subdomain}.qevalpro.com/api/ManageUser/GetLocationListByClientId
Method POST
Sub Domains “app” or “ai”

1. API Headers

Every API call must include two-factor authentication by providing the following headers:

Header Type Description
Authorisation String Bearer <Generated_Token> (generated after successful login)
X-API-KEY String

<Your_Unique_API_Key> (generated after successful login)

Note: If unavailable, email Qeval@etechtexas.com.

2. Response Examples

Success

</> JSON 
[
    {
        "LocationId": 586,
        "ClientId": 12,
        "LocationName": "Athens",
        "ErrorCode": 0,
        "ResultCode": 0
    },
    {
        "LocationId": 587,
        "ClientId": 12,
        "LocationName": "St Antonio",
        "ErrorCode": 0,
        "ResultCode": 0
    }
]

Status Codes

Code Status Description
200 Success Returns the list of client locations successfully

Response Parameters

S.No Name Type Description
1 LocationId Integer Unique identifier of the location
2 ClientId Integer Unique identifier of the client
3 LocationName String Name of the client location
4 ErrorCode Integer Error code returned by the API
5 ResultCode Integer Result status code

Failure

</> JSON 
[
    {
        "Message": "The request is invalid"
    }
]

Status Codes

Code Status Description
401 Unauthorised Token missing, expired, or invalid
403 Forbidden Invalid or missing API key
406 Not Acceptable Exception occurred while processing the request
500 Internal Server Error Unexpected server error occurred

Notes

  • Authentication is mandatory for accessing this API.
  • The API returns locations associated with the specified client.
  • Use ClientId = 0 to retrieve all accessible locations.
  • A successful response may contain one or more location records depending on the client configuration.
  • ErrorCode = 0 and ResultCode =0 indicate successful execution.

    ×

    Contact Us