ReDoc documentation

company/role/

company/role/

get/V1/company/role/

Returns the list of roles and permissions for a specified company.

Request
query Parameters
searchCriteria[currentPage]
integer

Current page.

searchCriteria[filterGroups][0][filters][0][conditionType]
string

Condition type

searchCriteria[filterGroups][0][filters][0][field]
string

Field

searchCriteria[filterGroups][0][filters][0][value]
string

Value

searchCriteria[pageSize]
integer

Page size.

searchCriteria[sortOrders][0][direction]
string

Sorting direction.

searchCriteria[sortOrders][0][field]
string

Sorting field.

Responses
200

200 Success.

401

401 Unauthorized

500

Internal Server error

default

Unexpected error

Response samples
{
  • "items": [
    ],
  • "search_criteria": {
    },
  • "total_count": 0
}

company/role/

post/V1/company/role/

Create or update a role for a selected company.

Request
Request Body schema:
required
object (company-data-role-interface)

Role data transfer object interface.

Responses
200

200 Success.

400

400 Bad Request

401

401 Unauthorized

default

Unexpected error

Request samples
{
  • "role": {
    }
}
Response samples
{
  • "id": 0,
  • "role_name": "string",
  • "permissions": [
    ],
  • "company_id": 0,
  • "extension_attributes": { }
}
➔ Next to company/role/{id}