Skip to main content

Додати співробітника POST /api/external/company/employee

REQUEST

URL

Метод запиту

POST

URL запиту

/api/external/company/form

URL параметри

companyCode (обов’язково) - код Компанії.

Authorization

Auth type

 API key

Key / Value

 x-system-id - токен, отриманий при підключенні

Headers

  

Content-Type

multipart/form-data

REQUEST

  

REQUEST Body

info (обов’язково) JSON attr - дані для додавання співробітника;

identification (обов’язково) file - підписаний контейнер ідентифікації співробітника.

 

Всі персональні дані ідентифікації беруться з підпису/сертифіката у file identification, а не з JSON info. 

info:

{
  "phone": "380501112233",
  "email": "employee@example.com",
  "role": "USER",
  "identificationType": "SIGN"
}

Опис полів:

Поле Тип Обовʼязкове Опис
phone string так Телефон у форматі 380XXXXXXXXX.
email string так Email співробітника.
role enum так USER, ADMIN.
identificationType enum так SIGN, DIIA_INTERNAL_PASSPORT або DIIA_FOREIGN_PASSPORT.
RESPONSE

У тілі відповіді передається об'єкт ESSUser з даними доданого або вже існуючого співробітника.

CURL
curl -X POST 'https://host/api/external/company/employee?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898' \
  -F 'info={
    "phone":"380501112233",
    "email":"employee@example.com",
    "role":"USER",
    "identificationType":"SIGN"
  }' \
  -F 'identification=@employee-identification.p7s;type=application/octet-stream'
Помилки 
HTTP type Опис
400 invalid_info Невалідний або неповний info.
400 invalid_phone phone не відповідає формату 380XXXXXXXXX.
400 identification_file_not_found Не переданий file identification.
400 invalid_signature Неможливо перевірити підпис ідентифікації.
400 unsupported_role Непідтримувана роль.
400 unsupported_identification_type Непідтримуваний тип ідентифікації.
400 wrong_ipn ІПН існуючого користувача не збігається з ІПН у підписі.
403 company_access_denied Немає доступу до company.
403 company_wrong_status Компанія не ACTIVE.
Back to top