| Table of Contents |
|---|
...
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.
...
| Page Properties | |||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||||||||||||||
|
Filters
All search params are optional. Search with a few params executes according to the logical AND rule.
...
Content-Type:application/json
Authorization:Bearer {{access_token}}
API-key:{{secret}}
Request data validation
See on Apiary
Processing
...
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.
...
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”
Response structure
Example:
| Expand | ||
|---|---|---|
| ||
|
Post-processing processes
API paragraph not found
HTTP status codes
| Page Properties | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|