Properties of a REST API method document

Purpose

This service is designed to obtain a list of capitation or reimbursement contract_requests by NHS employee (private API) or by MSP (public API).

Logic

Contract_type should be declared in the URL.

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

Headers

Request data validation

Authorize

Request to process the request using a token in the headers

Validate token

• Verify the validity of access token

  • Return 401 in case validation fails

• token is not expired

  • in case error return 401 

Validate scopes

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

  1. Return 403 in case invalid scope(s) -"Your scope does not allow to access this resource. Missing allowances: contract_requests:read"

Validate employee

extract user_id from token

...

• Check if user is active

  • in case error return 403 - "user is not active"

• Check nhs_legal_entity is active

  • in case error return 403 - "Client is not active"

Validate context

Return response to user limited by context from user's token

• if TOKENS_TYPES_PERSONAL

  • return response limited by contractor_legal_entity_id

• if TOKENS_TYPES_NHS

  • return non limitted response

Dictionaries

• CONTRACT_PAYMENT_METHOD

• CONTRACT_TYPE

• REIMBURSEMENT_CONTRACT_TYPE

Processing

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

Response structure examples

See on API-specification

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "09106b70-18b0-4726-b0ed-6bda1369fd52",
      "contract_type": "CAPITATION",
      "contractor_legal_entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "contractor_owner_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "contractor_base": "на підставі закону про Медичне обслуговування населення",
      "status": "NEW",
      "status_reason": "Не відповідає попереднім домовленостям",
      "nhs_signer_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "nhs_legal_entity_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "nhs_signer_base": "на підставі наказу",
      "issue_city": "Київ",
      "nhs_contract_price": 50000,
      "nhs_payment_method": "prepayment",
      "contract_number": "0000-9EAX-XT7X-3115",
      "contract_id": "df9f70ee-4b12-4740-b0f5-bb5aea116863",
      "parent_contract_id": "22e416c4-5747-41cd-9f73-c3a85cdee885",
      "start_date": "2017-04-20",
      "end_date": "2017-04-20"
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

...

If no contract request is found return 200 and empty array

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

...