List Roles
Returns all Roles available in the user's ForceManager account database based on JSON input.
You will only receive the List of Roles after first providing the Session Key. To know how you can obtain the Session Key, go to Authentication.
HEADERS
| Parameter | Value | Description |
|---|---|---|
| Content-Type | application/json | Language in which all request and response bodies are encoded |
| Accept | */* | Any data of whatever mime type is accepted |
| X-Session-Key | AUTH_TOKEN | This field must be completed with the token obtained at the authentication |
| Count | {number} | The number of records to return in each page of results. The default page limit is 50 |
REQUEST
You can apply filters, organise and choose the language and pagination using any query string parameter in SQL. Query string parameters appear after a question mark in the endpoint followed by the parameters and their values. In the query string, each parameter is listed one right after the other with an "and" separating them. The order of the parameters does not matter.
| Parameter | Type | Description |
|---|---|---|
| page | Integer | Define the pagination data for the returned objects |
| param1, param2... | String, Integer | Apply filters using any query string parameter in SQL |
| order | String | organise and view the results for a specific attribute in descendent order - at the top the most recent results while the oldest results will be down the list |
| lang | String | Define the language in which you want to receive the response |
You can define the pagination data for the returned objects. The default page number is 0, otherwise you can optionally determine the page number.
e.g.
https://api.forcemanager.com/api/v4/users?page=PAGE_NUMBER
You can apply filters.
e.g.
https://api.forcemanager.com/api/v4/roles?where= param1=value AND/OR param2=value2
You can filter Roles by name for example.
You can also organise and view the results for Roles in descendent order - at the top, the most recent results while the oldest results will be down the list.
e.g.
https://api.forcemanager.com/api/v4/roles?order=VALUE
In the request, and using query string parameters, you can also define the language in which you want to receive the response.
e.g.
https://api.forcemanager.com/api/v4/roles?lang=VALUE
RESPONSE
This endpoint returns information about all Roles available in the database.
If you didn't apply any page or count number in the header the default number of records in the response is 50.
List of the supported Roles attributes:
| Attribute | Type | Description |
|---|---|---|
| branches | Object, Null | List of the user branches |
| extId | Integer | External ID of the User from a third party system (ERP, CRM, Accounting System) |
| id | Integer | The unique identifier of the Role in ForceManager |
| level | Integer | Between 1-5. The priority of this role, being 1 minor and 5 major |
| name | String | The name of the role |
RESPONSE CODES
| Status | Description |
|---|---|
| 200 OK | Shows if operation succeeded |
| 400 Bad Request | Shows when an invalid request or the requested service is not available |
Request
- Base URL: https://api.forcemanager.com/api/v4
- URL: https://api.forcemanager.com/api/v4/roles
- Auth: API key in header X-Session-Key
Headers
Response
List Roles
Changes
No recorded changes to this operation across all 1 revision of this API.