GET Roles of Organization

Overview

---

The following table contains important information about the GET method in regards to receiving the Roles in an organization.

GET Roles of Organization
Method	GET
URL or Endpoint	​/api/roles
Headers	Authorization
Parameters	projectId, search, page, take, order, insertedDate, organizationId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

The description of the parameters is as follows:

Parameter Name	Mandatory	Type	Description
search	Yes	string	A word you want to filter.
page	Yes	integer($int32)	The page in which the roles are located
take	Yes	integer($int32)	The number of roles to take from the page
order	Yes	string	The order in which you receive the roles.
insertedDate	No	Date	The date when the role was inserted.
organizationId	Yes	integer($int32)	The Id of the organization.

Request Body

The request does not contain a request body.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "currentPage": 1,
    "totalPages": 2,
    "pageSize": 3,
    "totalCount": 6,
    "items": [
      {
        "id": 4,
        "name": "Owner",
        "description": "System Role",
        "isActive": true,
        "organizationId": 1
      },
      {
        "id": 5,
        "name": "Admin",
        "description": "System Role",
        "isActive": true,
        "organizationId": 1
      },
      {
        "id": 39,
        "name": "Content Editor",
        "description": "System Role",
        "isActive": true,
        "organizationId": 1
      }
    ]
  },
  "resultInfo": null,
  "statusCode": 200
}

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

Field Name	Type	Description
success	bool	If the response is successful it will return true. Otherwise will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
currentPage	integer($int32)	The page where the recieved roles are located.
totalPages	integer($int32)	The total number of pages that contain roles.
pageSize	integer($int32)	The amount of items a page has.
totalCount	integer($int32)	The total number of roles.
items	array[Object]	Returns the items received as an array of objects.
id	integer($int32)	The id of the role.
name	string	The name of the role.
description	string	The description of the role.
isActive	bool	Indicates whether the role is active.
organizationId	integer($int32)	The id of the organization.
resultInfo	string	Returns extra information about the result.
statusCode	integer($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