Info |
---|
Note |
Сторінка знаходиться в процесі розробки. Інформація на ній може бути застарілою. |
Info |
---|
/wiki/spaces/EN/pages/17591304241 (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
Description of input parameters
Input parameter | Mandatory | Type | Description | Example | |
---|---|---|---|---|---|
1 |
composition_id
M
String ($uuid) (path)
Composition object ID
2 |
Request structure
See on API-specification (посилання на сторінку з API-специфікацією)
Description of the REST API request structure, example
Expand | ||
---|---|---|
| ||
|
...
|
...
|
...
Headers
...
...
Request data validation
...
Example
...
Content-Type
...
application/json
...
M
...
Тип контенту
...
Content-Type:application/json
...
Authorize
Verify the validity of access token
in case of error return 401 ('Access denied')
Check user scope capitation_report:read in order to perform this action
in case of error generate 401 response ('Invalid scopes')
Verify role
Extract from token:
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
Return array of existing reports according to Apiary and Capitation Report Data Structure
See on API-specification
Expand | |||||
---|---|---|---|---|---|
| |||||
|
HTTP status codes
Response code | HTTP Status code | Message | Internal name | Description | |
---|---|---|---|---|---|
1 | Базові | ||||
2 | 200 |
Response | |||||
3 | 401 | Access denied | |||
4 | 401 | Invalid scopes | |||
5 |
401
Unauthorized
Помилка підтвердження
403 | Client is blocked |
6 | 403 | Client is not active |
7 | Специфічні |
422
8 |
Post-processing processes
Description of actions performed on data after processing
Technical modules where the method is used
List of pages describing technical N/A
Technical modules where the method is used
Page Properties Report | ||||
---|---|---|---|---|
|
...