/wiki/spaces/EN/pages/17591304241 (remove the link block before publishing the document)
Properties of a REST API method document
Purpose
This WS allows to get a list of divisions of legal entity. Also, this list can be filtered using search parameters.
Only authenticated and authorized owners with appropriate scope can get a list of divisions.
Method returns a list of divisions for user’s legal entity only.
List can be filtered by search params.
Logic
Get client_id from token as legal entity identifier
Define all the divisions of the legal entity
Get and render all the records with defined divisions from divisions table filtered by search params.
Configuration parameters
N/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 | |||||
2 |
Request structure
See on API-specification
Headers
Request data validation
Authorize
Verify the validity of access token
in case of error - return 401 “Invalid access token” in case of validation fails
Verify that token is not expired
in case of error - return 401 “Invalid access token”
Check user scopes in order to perform this action (scope = 'division:read')
return 403 “Your scope does not allow to access this resource. Missing allowances: division:read” in case of invalid scope(s)
Validate legal entity
Extract client_id from token.
Check client scopes in order to perform this action (scope = 'division:read')
in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: division:read”
Check legal entity status (status = ACTIVE, SUSPENDED)
In case of error - return 422 “Legal entity is not active”
Processing
N/A
Response structure examples
See on API-specification
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 200 | Response |
| ||
3 | 401 | Authorization failed | |||
4 | 401 | Invalid access token | |||
5 | 403 | Invalid scopes | |||
6 | 403 | Your scope does not allow to access this resource. Missing allowances: division:read | |||
7 | 422 | Legal entity is not active | |||
8 | 422 | Validation failed | |||
9 | Специфічні | ||||
10 |
Post-processing processes
N/A