Skip to main content

GET Role by ID

Overview


The following table contains important information about the GET method in regards to receiving the role by id.

GET Role by Id
MethodGET
URL or Endpoint/api/projects/projectId/roles/id
HeadersAuthorization
ParametersprojectId, id
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.
idYesstringUnique id of the role.

Request Body

The request does not contain a request body

Response

{
"success": true,
"errors": [],
"messages": [],
"result": {
"id": 1036,
"name": "Tester",
"description": "Tester Role",
"isActive": false,
"organizationId": null
},
"resultInfo": null,
"statusCode": 200
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idinteger($int32)The id of the role.
namestringThe name of the role.
descriptionstringThe description of the role.
isActiveboolIndicates whether the role is active.
organizationIdinteger($int32)The id of the organization.
resultInfostringReturns extra information about the result.
statusCodeinteger($int32)Returns the HTTP Status Code.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed