Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

Purpose

This WS method gives opportunity to reject and close preperson merge request by hand.

Specification

Page Properties
idAPI_Specification

...

або 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

  1. Only authenticated and authorized

...

  1. SPECIALIST,

...

  1. ASSISTANT or RECEPTIONIST

...

  1. employees can use this WS.

  2. Usage of this WS allowed in EMERGENCY

...

  1. or OUTPATIENT legal entities.

  2. Only NEW or APPROVED

...

  1. merge request can be rejected.

  2. The request can be rejected only by employee who made the request.

  3. 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

  1. Verify the validity of access token

    1. Return 401 in case validation fails

  2. Check user scopes in order to perform this action (scope = '

...

  1. merge_request:write')

    1. Return 403 in case invalid scope(s)

  2. 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.

    1. If not match - return 403 error (Only author of merge request is allowed to reject it)

  3. Check that client_id from the token maches with il.merge_requests.legal_entity_id

    1. 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

  1. Validate

...

  1. merge request id exists in DB

    1. In case of error - return 404

  2. Check

...

  1. merge request status is NEW or APPROVED

    1. In case of error - return

...

    1. 409 (Invalid merge request

...

Validate employee

Validate employee as on create preperson merge request, but in addition check the employee has created this merge request:

  1. Select inserted_at from il.person_requests of this preperson merge request

  2. Compare user_id with inserted_at.

    1. If not match - return 422 error (User created preperson merge request does’nt match with current)

    1. status)

Processing

Update object in DB

mpi.personmerge_requeststable

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:

Expand
titleResponse example
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": "REJECTED",
    "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"
  }
}

HTTP status codes

Page Properties
idAPI_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