1 Purpose
2 Specification
3 Logic
4 Input parameters
5 Filters
6 Dictionaries
7 Request structure
8 Authorize
9 Headers
10 Request data validation
11 Processing
12 Response structure
13 HTTP status codes

Purpose

This method to update the employee info by ID.

Specification

Link	https://uaehealthapi.docs.apiary.io/#reference/internal.-partner-relationship-management/employees/update-employee	Посилання на Apiary або Swagger
Resource	/employees/{{id}}	Посилання на ресурс, наприклад: /api/persons/create
Scope		Scope для доступу
Components	Employees	Зазначається перелік бізнес компонентів, які використовують цей метод, наприклад: ePrescription
Microservices	il/api	Перелік мікросервісів, які використовує метод API, наприклад: Auth, ABAC
Protocol type	REST	Тип протоколу, який використовується запитом, наприклад: SOAP \| REST
Request type	PUT	Тип запиту API, наприклад: GET, POST, PATCH…
Sync/Async	Sync	Метод є синхронним чи асинхронним?
Public/Private/Internal	Private	Потрібно зазначити тип методу за ступенем доступності

Logic

Input parameters

See on Apiary

Filters

See on Apiary

Dictionaries

SPECIALITY_TYPE
POSITION
EMPLOYEE_TYPE
SPEC_QUALIFICATION_TYPE
SPECIALITY_LEVEL

Request structure

See on Apiary

Example:

{
  "party_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "no_tax_id": true,
  "legal_entity_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "division_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
  "employee_type": "DOCTOR",
  "position": "P1",
  "start_date": "2017",
  "end_date": "2017",
  "status": "NEW",
  "speciality": {
    "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"
  },
  "status_reason": "new_employee"
}

Authorize

Request to process the request using a token in the headers

Headers

Content-Type:application/json

Request data validation

Processing

Response structure

See on Apiary

Example:

{
  "meta": {
    "code": 200,
    "url": "https://example.com/resource",
    "type": "object",
    "request_id": "6617aeec-15e2-4d6f-b9bd-53559c358f97#17810"
  },
  "data": {
    "id": "d290f1ee",
    "party_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "no_tax_id": true,
    "legal_entity_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "division_id": "d290f1ee-6c54-4b01-90e6-d701748f0851",
    "employee_type": "DOCTOR",
    "position": "P1",
    "start_date": "2017",
    "end_date": "2017",
    "status": "NEW",
    "speciality": {
      "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"
    },
    "status_reason": "new_employee",
    "inserted_at": "1991-08-19T00:00:00.000Z",
    "inserted_by": "userid",
    "updated_at": "1991-08-19T00:00:00.000Z",
    "updated_by": "userid"
  }
}

HTTP status codes

HTTP status code	Message	What caused the error

HTTP status code	Message	What caused the error
200

E-Health

Update employee (Private)

Purpose

Specification

Logic

Input parameters

Filters

Dictionaries

Request structure

Authorize

Headers

Request data validation

Processing

Response structure

HTTP status codes