Purpose

Method returns a list of merge requests. Service returns only merge requests related to the same legal entity as the user.

Specification

Logic

1. Only authenticated and authorized SPECIALIST, ASSISTANT or RECEPTIONIST employees can use this WS.

2. Usage of this WS allowed in EMERGENCY or OUTPATIENT legal entities.

3. Service returns only merge requests related to the same legal entity as the user

4. Search by next parameters allowed:

   1. status

   2. master_person_id

   3. merge_person_id

Filters

See on Apiary

Authorize

1. Verify the validity of access token

   1. Return 401 in case validation fails

2. Check scopes in order to perform this action (scope = 'merge_request:read')

   1. Return 403 in case invalid scope(s)

Headers

Content-Type:application/json

Authorization:Bearer {{access_token}}

api-key:{{secret}}

Request data validation

API paragraph not found

Processing

Prepare response

Service returns only merge requests related to the same legal entity as the user

1. Extract client_id from token

2. Return entries filtered by legal_entity_id and query params from merge_requests table

Response structure

See on Apiary

Example:

{
  "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