Properties of a REST API method document

Purpose

Service returns list of connections for specified client

Logic

1. This service must return list of clients connections for specified client ID. Client connections are restricted by Client ID and its context

   1. Extract client_type from token

   2. Validate specified Client ID according to context:

      1. Mithril Admin - receives all client records

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

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

Prepare response

1. Query data from mithril.connections for specified Client ID

2. Hide secret from response

Configuration parameters

N/A

Dictionaries

N/A

Input parameters

Request structure

See on API-specification

Headers

Headers

Request data validation

Authorize

1. Verify the validity of access token

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

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

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

Processing

N/A

Response structure examples

See on API-specification

{
  "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",
      "client_id": "c4a6d45f-2cf2-4e6d-909a-5962604ad63b",
      "consumer_id": "25c03af6-69bd-439e-b0dd-f1669b3dbbfd",
      "redirect_uri": "https://example2.com"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

Post-processing processes

N/A

Technical modules where the method is used