Purpose

This service returns a list of clients filtered by context depending on client type:

• Mithril Admin - receives all client records without context

• MSP - receives only its own client

• MIS - receives only its own client

Specification

Logic

This service must return a list of clients filtered by context depending on client type

1. Extract client_type from token

2. Filter response:

   1. Mithril Admin - receives all client records without context

   2. MSP, MIS, PHARMACY - receives only its own client

Prepare response

1. Query data from mithril.clients using context

Request structure

API paragraph not found

Authorize

1. Verify the validity of access token

   1. in case of error return 401 ('Access denied')

2. Check user scope client:read in order to perform this action

   1. in case of error generate 403 response ('Invalid scopes')

Headers

Content-Type:application/json

Authorization:Bearer c2778f3064753ea70de870a53795f5c9

API-key:uXhEczJ56adsfh3Ri9SUkc4en

Request data validation

API paragraph not found

Processing

API paragraph not found

Response structure

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "name": "eHealth portal",
      "settings": {},
      "user_id": "user-1380df72-275a-11e7-93ae-92361f002671",
      "client_type_id": "261d52f9-b355-4029-863d-8fc52e9d0b81",
      "is_blocked": "false",
      "block_reason": "MSP has fakes doctors",
      "inserted_at": "2017-04-20T19:14:13Z",
      "updated_at": "2017-04-20T19:14:13Z"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

Post-processing processes

API paragraph not found

HTTP status codes