ЕСОЗ - публічна документація

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

Purpose

Method to create new employee record for the MSP.

Specification

Link

https://uaehealthapi.docs.apiary.io/#reference/internal.-portal-and-reports/employees/search-employees

Посилання на Apiary або Swagger

Resource

/api/stats/employees

Посилання на ресурс, наприклад: /api/persons/create

Scope

Scope для доступу

Components

Employees

Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription

Microservices

il/api

Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC

Protocol type

REST

Тип протоколу, який використовується запитом, наприклад: SOAP | REST

Request type

GET

Тип запиту API, наприклад: GET, POST, PATCH…

Sync/Async

Sync

Метод є синхронним чи асинхронним?

Public/Private/Internal

Private

Потрібно зазначити тип методу за ступенем доступності

Logic

Input parameters

See on Apiary

Filters

See on Apiary

Dictionaries

https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1195114505/SPECIALITY+TYPE POSITION https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1300529210/EMPLOYEE+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1195278373/SPEC+QUALIFICATION+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1194852386/SPECIALITY+LEVEL /wiki/spaces/EBT/pages/1191149607 COUNTRY https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1199734785/SETTLEMENT+TYPE https://e-health-ua.atlassian.net/wiki/spaces/EBT/pages/1199898644/STREET+TYPE

Authorize

Request to process the request using a token in the headers

Headers

  • Content-Type:application/json

Request data validation

Response structure

See on Apiary

Example:

 Response example
{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": [
    {
      "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
      "party": {
        "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
        "first_name": "Петро",
        "second_name": "Миколайович",
        "last_name": "Іванов",
        "specialities": [
          {
            "speciality": "THERAPIST",
            "speciality_officio": true,
            "level": "FIRST",
            "qualification_type": "AWARDING",
            "attestation_name": "Академія Богомольця",
            "attestation_date": "2017-02-28",
            "valid_to_date": "2020-02-28",
            "certificate_number": "AB/21331"
          }
        ],
        "is_available": true
      },
      "division": {
        "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
        "name": "Aдоніс",
        "addresses": {
          "type": "RESIDENCE",
          "country": "UA",
          "area": "Житомирська",
          "region": "Бердичівський",
          "settlement": "Київ",
          "settlement_type": "CITY",
          "settlement_id": "b075f148",
          "street_type": "STREET",
          "street": "вул. Ніжинська",
          "building": "15",
          "apartment": "23",
          "zip": "02090"
        }
      },
      "legal_entity": {
        "id": "7d23bebb-1cf3-4221-bf21-18aada444756",
        "name": "Клініка Ноунейм",
        "status": "ACTIVE"
      }
    }
  ],
  "paging": {
    "page_number": 2,
    "page_size": 50,
    "total_entries": 1000,
    "total_pages": 23
  }
}

HTTP status codes

HTTP status code

Message

What caused the error

 201

 response

 

 

 

 

  • No labels