ЕСОЗ - публічна документація
Reject merge request
Purpose
This method gives opportunity to reject and close preperson merge request by hand.
Specification
Link | Посилання на Apiary або Swagger | |
Resource | /api/merge_requests/{{id}}/actions/reject | Посилання на ресурс, наприклад: /api/persons/create |
Scope | merge_request:write | Scope для доступу |
Components | Patient registry | Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription |
Microservices | il/api mpi/api fe/admin-web | Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC |
Protocol type | REST | Тип протоколу, який використовується запитом, наприклад: SOAP | REST |
Request type | PATCH | Тип запиту 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.
Only NEW or APPROVED merge request can be rejected.
The request can be rejected only by employee who made the request.
Change status should be logged in the Event manager.
Input parameters
Input parameter | Values | Type | Description | Example |
---|---|---|---|---|
id |
| String | Identifier of the merge request. Required | 7c3da506-804d-4550-8993-bf17f9ee0404 |
Authorize
Verify the validity of access token
Return 401 in case validation fails
Check user scopes in order to perform this action (scope = 'merge_request:write')
Return 403 in case invalid scope(s)
Check the employee has created this merge request. Thus select inserted_by from il.merge_requests of this merge request and compare it with user_id from the token.
If not match - return 403 error (Only author of merge request is allowed to reject it)
Check that client_id from the token maches with il.merge_requests.legal_entity_id
If not match - return 422 error (User doesn’t belong to legal entity where the merge request was created)
Headers
Content-Type:application/json
Authorization:Bearer {{access_token}}
Api-key:{{secret}}
Request data validation
Validate merge request
Validate merge request id exists in DB
In case of error - return 404
Check merge request status is NEW or APPROVED
In case of error - return 409 (Invalid merge request status)
Processing
Update object in DB
mpi.merge_requests table
Parameter | Source | Description |
status | Request: status | Status of the request, required. Set REJECTED |
updated_by | uuid | Extract user from token |
updated_at | timestamp | Get current date-time |
Response structure
See on Apiary
Example:
HTTP status codes
HTTP status code | Message | What caused the error |
---|---|---|
200 | Response |
|
401 |
| Access token validation failed |
403 | Invalid scope Only author of merge request is allowed to reject it | Validation failed |
404 |
| Validation failed |
409 | Invalid merge request status | Validation failed |
422 | User doesn’t belong to legal entity where the merge request was created | Validation failed |
ЕСОЗ - публічна документація