...

...

...

...

...

...

...

...

...

...

...

...

...

Required parameters are marked with "*"

Якщо інформації по відповідному параметру немає, потрібно зазначити: “APIparagraph not found”.

Purpose*

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

Key points

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

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

3. The list can be filtered by search parameters.

...

Specification*

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

Preconditions

API paragraph not found

Global and configurable parameters

No

Input parameters

No

Filters

See on Apiary

Dictionaries

API paragraph not found

...

*

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.

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

Request structure*

API paragraph not found

Authorize*

• 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

Headers*

Наприклад:

• Content-Type:application/json

• Authorization:Bearer F3GF124Df565FDS234SDF34

• api-key:aDGFDFGT46S5gFGD

Request data validation*

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

Processing

API paragraph not found

...

• • is_active

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.

Response structure*

See on Apiary

Example:

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

     "msp_legal_entity_id": "15d5ea65-d6e7-44f8-9eef-f0d3c1121d3a",
      "medical_program_id": "04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b",
      "division_id": "15caea3f-cac3-483c-a3da-5875eba96430",
      "is_active": true,
      "deactivate_reason": "MANUAL_DEACTIVATION"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",
      "msp_legal_entity_id": "15d5ea65-d6e7-44f8-9eef-f0d3c1121d3a",
      "medical_program_id": "04d5ea65-d6e7-44f8-9eef-f0d3c1121d2b",
      "division_id": "6d07bdb0-59c0-4b54-8a90-bada3e232877",
      "is_active": true,
      "deactivate_reason": "MANUAL_DEACTIVATION"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
  }
}

Post-processing processes*

API paragraph not found

HTTP status codes

...

*

Backward compatibility

...

...

200

...

Response

...

...

401

...

Invalid access token

...

...

403

...

Your scope does not allow to access this resource. Missing allowances: medical_program_provision:read

...

...

422

...

Legal entity is not active

...