Properties of a REST API method document

Purpose

This WS is designed to search requests to registration employees by legal_entity_id and other filters

Logic

1. Verify the validity of access token

2. Check user scopes in order to perform this action

3. If according to filters requests are not found, WS returns empty data array.

WS returns list of request objects include id and status, pagination data - for technical info.

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

Description of input parameters

Request structure

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API request structure, example

Headers

Request data validation

• Verify the validity of access token

  • 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 = 'employee_request:read')

  • Return (403, 'Your scope does not allow to access this resource. Missing allowances: employee_request:read') in case of invalid scope(s)

Processing

Service returns specified Employee requests:

1. Get Employee requests by ID from il.employee_requests

   1. Filter by search params

2. Validate data consistency:

   1. Ensure that requested Employee requests relates to the legal entity from token:

      1. Return 403 ('Access denied') in case of error

3. Render a response according to specification with found Employee requests:

   1. if according to filters requests are not found, WS returns empty data array

Response structure examples

See on API-specification (посилання на сторінку з API-специфікацією)

Description of the REST API response structure, example

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "req-adasdoijasdojsda"
  },
  "data": [
    {
      "id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
      "status": "NEW",
      "inserted_at": "2018-03-02T10:45:16.000Z",
      "edrpou": "5432345432",
      "legal_entity_name": "Клініка Ноунейм",
      "no_tax_id": true,
      "first_name": "Петро",
      "last_name": "Іванов",
      "second_name": "Миколайович"
    }
  ],
  "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