Purpose
Method returns a list of merge requests. Service returns only merge requests related to the same legal entity as the user.
Specification
...
або Swagger | Resource | /api/merge_requests | Посилання на ресурс, наприклад: /api/persons/create | Scope | merge_request:read | Scope для доступу | Components | Patient registry | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription | Microservices | il/api mpi/api fe/admin-web | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC | Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST | Request type | GET | Тип запиту API, наприклад: GET, POST, PATCH… | Sync/Async | Sync | Метод є синхронним чи асинхронним? | Public/Private/Internal | Public | Потрібно зазначити тип методу за ступенем доступності |
|
Logic
Only authenticated and authorized
...
SPECIALIST,
...
ASSISTANT or RECEPTIONIST
...
employees can use this WS.
Usage of this WS allowed in EMERGENCY
...
or OUTPATIENT legal entities.
Service returns only merge requests related to the same legal entity as the user
Search by next parameters allowed:
status
master_person_id
...
merge_person_id
...
Filters
See on Apiary
Request structure
See on Apiary
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check scopes in order to perform this action (scope = '
...
merge_request:read')
Return 403 in case invalid scope(s)
Content-Type:application/json
Authorization:Bearer {{access_token}}
api-key:{{secret}}
Request data validation
See Logic
Processing
Prepare response
Service returns only preperson merge requests related to the same legal entity as the user
Extract client_id from token
Return entries filtered by legal_entity_id and query params from merge_requests table
Response structure
See on Apiary
Example:
| Expand |
|---|
|
| Code Block |
|---|
{
"meta": {
"code": 200,
"url": "https://example.com/resource",
"type": "object",
"request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
},
"data": [
{
"id": "7c3da506-804d-4550-8993-bf17f9ee0404",
"master_person_id": "7c3da506-804d-4550-8993-bf17f9ee0402",
"merge_person_id": "7c3da506-804d-4550-8993-bf17f9ee0403",
"status": "NEW",
"inserted_at": "2017-04-20T19:14:13Z",
"inserted_by": "e1453f4c-1077-4e85-8c98-c13ffca0063e",
"updated_at": "2017-04-20T19:14:13Z",
"updated_by": "2922a240-63db-404e-b730-09222bfeb2dd"
}
],
"paging": {
"page_number": 2,
"page_size": 50,
"total_entries": 1000,
"total_pages": 23
}
} |
|
HTTP status codes
| Page Properties |
|---|
|
HTTP status code | Message | What caused the error |
|---|
200 | Response | | 401 | | Access token validation failed | 403 | | Invalid scope |
|