Skip to main content

Пошук співробітників компанії POST /api/external/company/employees/search

REQUEST

URL

Метод запиту

POST

URL запиту

/api/external/company/employees/search

URL параметри

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

Authorization

Auth type

 API key

Key / Value

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

Headers

  

Content-Type

application/json

REQUEST

  

JSON Body

В тілі запиту методу передається об’єкт ESSUsersQuery

 

 JSON приклад запиту:

 

{
  "search": "3148615913",
  "role": ["USER", "ADMIN"],
  "identification": ["YES"],
  "employeeStatus": ["ACTIVE"],
  "limit": {
    "offset": 0,
    "count": 20
  }
}
RESPONSE

В тілі відповіді передаються статус 200 та масив об'єктів ESSUser.

JSON  приклад відповіді:

[
  {
    "id": 456,
    "login": "380501112233",
    "email": "employee@example.com",
    "fullName": "Іваненко Іван Іванович",
    "ipn": "3148615913",
    "identified": "YES",
    "role": "USER",
    "employeeStatus": "ACTIVE",
    "employeeEmail": "employee@example.com"
  }
]

 

CURL 
curl -X POST 'https://host/api/external/company/employees/search?...' \
  -H 'x-system-id: 019eb581-307b-7562-8a1f-20227511e898' \
  -H 'Content-Type: application/json' \
  -d '{
    "search": "3148615913",
    "employeeStatus": ["ACTIVE"],
    "limit": {"offset": 0, "count": 20}
  }'
Помилки 
HTTP type Опис
403 company_access_denied Немає доступу до company.
Back to top