Сотрудники API 1.5.0

Сотрудники, статусы, поиск и блокировка персон.

Базовый путь: https://{IP_контроллера}/api/v1. Версия описания API: 1.5.0.

Примеры используют placeholder-значения для паролей, token, UUID, адресов и секретов. Перед выполнением запроса замените их на значения вашего контроллера.

Методы раздела

Метод	Путь
`GET`	`/staff`
`GET`	`/staff/banned`
`GET`	`/staff/count`
`GET`	`/staff/search`
`GET`	`/staff/{uuid}`
`GET`	`/staff/{uuid}/last_access`
`GET`	`/staff_properties`
`GET`	`/staff_properties/{name}`
`POST`	`/staff`
`POST`	`/staff_properties`
`PUT`	`/staff/ban/{uuid}`
`PUT`	`/staff/unban/{uuid}`
`PUT`	`/staff/{uuid}`
`PUT`	`/staff_properties/{name}`
`DELETE`	`/staff/{uuid}`
`DELETE`	`/staff_properties/{name}`

`GET /staff`

Раздел: Сотрудники.

Возвращает постраничный список сотрудников.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff"
  }
}

`GET /staff/banned`

Раздел: Сотрудники.

Возвращает список всех заблокированных сотрудников.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff/banned" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff/banned" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff/banned"
  }
}

`GET /staff/count`

Раздел: Сотрудники.

Возвращает количество сотрудников подходящих под указанный фильтр.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff/count" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff/count" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "count": 12
}

`GET /staff/search`

Раздел: Сотрудники.

Возвращает отфильтрованный список карточек сотрудников.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff/search" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff/search" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff/search"
  }
}

`GET /staff/{uuid}`

Раздел: Сотрудники.

Возвращает параметры конкретного сотрудника по uuid Сотрудника.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff/{uuid}"
  }
}

`GET /staff/{uuid}/last_access`

Раздел: Сотрудники.

Возвращает последний доступ сотрудника.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff/{uuid}/last_access" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff/{uuid}/last_access" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff/{uuid}/last_access"
  }
}

`GET /staff_properties`

Раздел: Сотрудники.

Возвращает список полей сотрудников с их настройками.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff_properties" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff_properties" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff_properties"
  }
}

`GET /staff_properties/{name}`

Раздел: Сотрудники.

Возвращает настройки конкретного поля персонала.

Пример запроса

curl -k -X GET "https://{IP_контроллера}/api/v1/staff_properties/{name}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X GET "https://{IP_контроллера}/api/v1/staff_properties/{name}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "data": [],
  "meta": {
    "api_version": "1.5.0",
    "path": "/staff_properties/{name}"
  }
}

`POST /staff`

Раздел: Сотрудники.

Добавляет нового сотрудника в систему.

Пример запроса

curl -k -X POST "https://{IP_контроллера}/api/v1/staff" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Пример тела запроса

{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Пример получения ответа

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/staff" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

`POST /staff_properties`

Раздел: Сотрудники.

Добавляет поле персонала.

Пример запроса

curl -k -X POST "https://{IP_контроллера}/api/v1/staff_properties" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "department",
  "type": "string",
  "required": false
}'

Пример тела запроса

{
  "name": "department",
  "type": "string",
  "required": false
}

Пример получения ответа

curl -k -sS -X POST "https://{IP_контроллера}/api/v1/staff_properties" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

`PUT /staff/ban/{uuid}`

Раздел: Сотрудники.

Блокирует доступ существующего сотрудника по uuid сотрудника.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/staff/ban/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Пример тела запроса

{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Пример получения ответа

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/staff/ban/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

`PUT /staff/unban/{uuid}`

Раздел: Сотрудники.

Разблокирует доступ существующего сотрудника по uuid сотрудника.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/staff/unban/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Пример тела запроса

{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Пример получения ответа

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/staff/unban/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

`PUT /staff/{uuid}`

Раздел: Сотрудники.

Позволяет отредактировать существующего сотрудника по uuid.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}'

Пример тела запроса

{
  "last_name": "Иванов",
  "first_name": "Иван",
  "cards": [
    "<card_code>"
  ],
  "access_profile": "<access_profile_uuid>"
}

Пример получения ответа

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

`PUT /staff_properties/{name}`

Раздел: Сотрудники.

Позволяет отредактировать настройки полей персонала.

Пример запроса

curl -k -X PUT "https://{IP_контроллера}/api/v1/staff_properties/{name}" \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  --data-raw '{
  "name": "department",
  "type": "string",
  "required": false
}'

Пример тела запроса

{
  "name": "department",
  "type": "string",
  "required": false
}

Пример получения ответа

curl -k -sS -X PUT "https://{IP_контроллера}/api/v1/staff_properties/{name}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "data": {
    "uuid": "<uuid>"
  }
}

`DELETE /staff/{uuid}`

Раздел: Сотрудники.

Позволяет отредактировать существующего сотрудника по uuid.

Пример запроса

curl -k -X DELETE "https://{IP_контроллера}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/staff/{uuid}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "deleted": true
}

`DELETE /staff_properties/{name}`

Раздел: Сотрудники.

Позволяет удалить поле персонала по названию.

Пример запроса

curl -k -X DELETE "https://{IP_контроллера}/api/v1/staff_properties/{name}" \
  -H "Authorization: Bearer <token>"

Пример получения ответа

curl -k -sS -X DELETE "https://{IP_контроллера}/api/v1/staff_properties/{name}" \
  -H "Authorization: Bearer <token>" | jq .

Пример ответа

{
  "status": "success",
  "deleted": true
}

Методы раздела​

GET /staff​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff/banned​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff/count​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff/search​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff/{uuid}​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff/{uuid}/last_access​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff_properties​

Пример запроса​

Пример получения ответа​

Пример ответа​

GET /staff_properties/{name}​

Пример запроса​

Пример получения ответа​

Пример ответа​

POST /staff​

Пример запроса​

Пример тела запроса​

Пример получения ответа​

Пример ответа​

POST /staff_properties​

Пример запроса​

Пример тела запроса​

Пример получения ответа​

Пример ответа​

PUT /staff/ban/{uuid}​

Пример запроса​

Пример тела запроса​

Пример получения ответа​

Пример ответа​

PUT /staff/unban/{uuid}​

Пример запроса​

Пример тела запроса​

Пример получения ответа​

Пример ответа​

PUT /staff/{uuid}​

Пример запроса​

Пример тела запроса​

Пример получения ответа​

Пример ответа​

PUT /staff_properties/{name}​

Пример запроса​

Пример тела запроса​

Пример получения ответа​

Пример ответа​

DELETE /staff/{uuid}​

Пример запроса​

Пример получения ответа​

Пример ответа​

DELETE /staff_properties/{name}​

Пример запроса​

Пример получения ответа​

Пример ответа​

Методы раздела

`GET /staff`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff/banned`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff/count`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff/search`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff/{uuid}`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff/{uuid}/last_access`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff_properties`

Пример запроса

Пример получения ответа

Пример ответа

`GET /staff_properties/{name}`

Пример запроса

Пример получения ответа

Пример ответа

`POST /staff`

Пример запроса

Пример тела запроса

Пример получения ответа

Пример ответа

`POST /staff_properties`

Пример запроса

Пример тела запроса

Пример получения ответа

Пример ответа

`PUT /staff/ban/{uuid}`

Пример запроса

Пример тела запроса

Пример получения ответа

Пример ответа

`PUT /staff/unban/{uuid}`

Пример запроса

Пример тела запроса

Пример получения ответа

Пример ответа

`PUT /staff/{uuid}`

Пример запроса

Пример тела запроса

Пример получения ответа

Пример ответа

`PUT /staff_properties/{name}`

Пример запроса

Пример тела запроса

Пример получения ответа

Пример ответа

`DELETE /staff/{uuid}`

Пример запроса

Пример получения ответа

Пример ответа

`DELETE /staff_properties/{name}`

Пример запроса

Пример получения ответа

Пример ответа