GET_RoleNames.md

GET /Roles/Names

Description

Gets a list of role names.

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

Sample Request

URI

GET https://localhost:81/Roles/Names

Headers

• Authorization : Basic UUFUZXN0R29sZi5NR1I6cGFzc3dvcmQx
• Accept : application/json

Response Codes

• 200 OK The request was successful, the list of role names was returned.
• 401 Unauthorized The request could not be fulfilled. Likely due to a missing or invalid authorization header.
• 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 role list was returned.
• ERROR_UNKNOWN: An unexpected error occurred. See the Message field for more details.

Response Body

{
  "roleList": [
    "Role1",
    "Role2",
    "Role3"
  ],
  "ErrorCode": "SUCCESS"
}

Response Body

roleList

Element	Datatype	Description
roleList	List	The list of role names.