...
...
...
...
...
...
...
...
...
Purpose
This method returns a list of all available already created capitation reports
Specification
Page Properties |
---|
|
Link | https://ehealthmisapi1.docs.apiary.io/#reference/public.-medical-service-provider-integration-layer/capitation-reports/get-capitation-reports | Посилання на Apiary або Swagger | Resource | /api/capitation_reports | Посилання на ресурс, наприклад: /api/persons/create | Scope | capitation_report:read | Scope для доступу | Components | Contracts | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | API paragraph not found | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
|
Filters
See on Apiary
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')
Наприклад:
Content-Type:application/json
Request data validation
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
...
Response structure
Return array of existing reports according to Apiary and Capitation Report Data Structure
Example:
Expand |
---|
|
Code Block |
---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": [
{
"id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
"billing_date": "2018-05-01",
"inserted_at": "2018-05-22"
}
]
} |
|
HTTP status codes
Page Properties |
---|
|
HTTP status code | Message | What caused the error |
---|
200 | Response | | 401 | Invalid scopes Access denied
| | 403 | Client is not active Client is blocked
| |
|