Properties of a REST API method document

Purpose

Describe the purpose of the API method, add Key points (if necessary)

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)This WS allows to get a list of medical programs already provided by the divisions of legal entity according to contracts. Also, this list can be filtered using search parameters.

Key points

1. Only authenticated and authorized employees with appropriate scope can get a list of Medical programs provision.

2. Method returns a list of Medical programs provision for user’s legal entity only.

3. List can be filtered by search params.

Filters

Logic

This method allows to get a list of medical programs already provided by the divisions of legal entity according to contracts. Also, this list can be filtered using search parameters.

Service logic

1. Get client_id from token as legal entity identifier

2. Define all the divisions of the legal entity

3. Get and render all the records with defined divisions from medical_program_provision table filtered by search params.

Configuration parameters

Description of the configuration parameters that are used when processing a request in the system.

Dictionaries

Provides a list of links to dictionaries that are available in Confluence

Input

...

parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)Description of the REST API request structure, example

Headers

Request data validation

Authorize

Describe the process of checking the input data transmitted in the request for compliance with the given rules and restrictions set in the API

Processing

A list of processes related to receiving, changing or transmitting data according to the logic defined in the REST API

Response structure examples

Description of the REST API response structure, example

...

...

• Verify the validity of access token

  • in case of error - return 401 “Invalid access token” in case of validation fails

• Verify that token is not expired

  • in case of error - return 401 “Invalid access token”

• Check user scopes in order to perform this action (scope = 'medical_program_provision:read')

  • return 403 “Your scope does not allow to access this resource. Missing allowances: medical_program_provision:read” in case of invalid scope(s)

Request to process the request using a token in the headers

Validate legal entity

• Extract client_id from token.

• Check client scopes in order to perform this action (scope = 'medical_program_provision:read')

  • in case of error - return 403 “Your scope does not allow to access this resource. Missing allowances: medical_program_provision:read”

• Check legal entity status (status = ACTIVE, SUSPENDED)

  • In case of error - return 422 “Legal entity is not active”

Processing

Search params

All search params are optional. Search with a few params executes according to the logical AND rule.

• contract_number

  • If submitted, filter list by medical_program_provision.contract_number

• medical_program_id

  • If submitted, filter list by medical_program_provision.medical_program_id

• division_id

  • If submitted, filter list by medical_program_provision.division_id

• is_active

  • If submitted, filter list by medical_program_provision.is_active

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "3e34da3d-9b8c-4aaf-be8e-24a161279b6a",
      "contract_number": "0000-PAP5-M000",
      "medical_program_id": "04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b",
      "division_id": "15caea3f-cac3-483c-a3da-5875eba96430",
      "is_active": true,
      "deactivate_reason": null,
      "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"
    },
    {
      "id": "2060b523-b469-4fc5-89af-ddb5899d8efe",
      "contract_number": "0000-PAP5-M000",
      "medical_program_id": "04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b",
      "division_id": "6d07bdb0-59c0-4b54-8a90-bada3e232877",
      "is_active": true,
      "deactivate_reason": null,
      "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

Post-processing processes

Description of actions performed on data after processing

Technical modules where the method is used

List of pages describing technical modules where the method is used

...