| Info |
|---|
REST API method / Метод REST API (настанова) (remove the link block before publishing the document) |
...
| Page Properties | ||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||||||||||
|
...
This method returns a list of all available already created capitation reports
Logic
Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)N/A
Configuration parameters
Description of the configuration parameters that are used when processing a request in the system
Dictionaries
Provides a list of links to dictionaries that are available in ConfluenceN/A
Dictionaries
N/A
Input parameters
Input parameter | Mandatory | Type | Description | Example | |
|---|---|---|---|---|---|
| 1 | |||||
| 2 |
...
| Expand | ||
|---|---|---|
| ||
|
Headers
...
Key
...
Value
...
Mandatory
...
Description
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Request data validation
Authorize
...
Validate client_id (is_blocked=false)
in case of error return 403 Error ('Client is blocked')
In case WS was called by MSP check contractor_legal_entity is active
in case error return 403 - ('Client is not active')
Processing
A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST APIN/A
Response structure examples
...
Response code | HTTP Status code | Message | Internal name | Description | ||||
|---|---|---|---|---|---|---|---|---|
| 1 | Базові | |||||||
| 2 | 200 | Response | 3 | 401 | Access denied | |||
| 43 | 401 | Invalid scopes | ||||||
| 54 | 403 | Client is blocked | ||||||
| 65 | 403 | Client is not active | ||||||
| 76 | Специфічні | |||||||
| 87 | ||||||||
Post-processing processes
Description of actions performed on data after processingN/A
Technical modules where the method is used
List of pages describing technical modules where the method is used
| Page Properties Report | ||||
|---|---|---|---|---|
|
...