REST API method / Метод REST API (настанова) (remove the link block before publishing the document)

• Properties of a REST API method document

• Purpose

• Logic

• Configuration parameters

• Dictionaries

• Input parameters

• Request structure

• Headers

• Request data validation

• Processing

• Response structure examples

• HTTP status codes

• Post-processing processes

• Technical modules where the method is used

Properties of a REST API method document

Purpose

This WS is designed to get the personal information of patient by token

Logic

Description of the working algorithm of the API method and the interaction of services with each other add Service logic (if necessary)

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

Validate token

• Check token existance

  • in case error return 404 - token was not found

• Check expiration date tokens.expires_at 

  • if  tokens.expires_at < now() return 401 - access denied

• Extract user_id from token

Validate role

• Check users_roles.user_id=&.user and user_roles.role_id = roles.id where roles.name = CABINET

  • in case error return 403

Validate person

• Check if mithril.users.person_id = mpi.persons.id and mithril.users.tax_id = mpi.persons.tax_id

  • in case error return 401

• Check if users.is_blocked = false

  • in case error return 401

• Check users password is not expired

  • in case error return 401 - password expired

Processing

In case nothing found return 404 - user was not found

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": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "first_name": "Петро",
    "last_name": "Іванов",
    "second_name": "Миколайович",
    "id": "7e9cffd9-c75f-45fb-badf-6e8d20b6a8a8"
  }
}

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