GET_RoleUsers.md

GET /Role/{RoleName}/Users

Description

Gets a list of users assigned to the role.

• Requires API Key: No
• Requires System Administrator: No
• Requires Counterpoint Registration option: No
• Requires Company Administrator: Yes

Sample Request

URI

GET https://localhost:81/Role/{RoleName}/Users

Headers

• Authorization : Basic UUFUZXN0R29sZi5NR1I6cGFzc3dvcmQx
• Accept : application/json

Parameters

Name	Parameter Type	Data Type	Required	Description
RoleName	path	string	true	The name of the role.

Response Codes

• 200 OK The request was successful, the user data was returned.
• 401 Unauthorized The request could not be fulfilled. Likely due to a missing or invalid authorization header.
• 404 Not Found The request could not be fulfilled. The role name provided was not found.
• 500 Internal Server Error The request could not be fulfilled due to an unexpected internal error. This could be caused by a bug in the system, an unavailable database, or any other unexpected internal problem processing the request.

Error Codes

The following error codes may be returned from requests to this endpoint:

• SUCCESS: The request was successful and the user data was returned.
• ERROR_RECORD_NOT_FOUND: The role name provided was not found.
• ERROR_UNKNOWN: An unexpected error occurred. See the Message field for more details.

Response Body

{
  "UserList": [
    "MGR",
    "POS1",
    "POS2",
    "Z"
  ],
  "ErrorCode": "SUCCESS"
}

Response Body

UserList

Element	Datatype	Description
UserList	List	The list of users in this role.