Перейти к содержанию

Компания

API методы для модуля company

Сотрудники

Получение списка

GET /company/api/staff/list

Метод позволяет получить список пользователей.

curl 'https://{HOST}.platrum.ru/company/api/staff/list' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}'

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "user_id": "some_string",
            "user_email": "some_string",
            "is_disabled": true,
            "is_deleted": true,
            "deletion_date": "2019-01-01 21:00:15",
            "can_be_disabled": true,
            "avatar": 123,
            "user_name": "some_string",
            "phone": "some_string",
            "slack": "some_string",
            "skype": "some_string",
            "telegram": "some_string",
            "comment": "some_string",
            "hiring_date": "2019-01-01 21:00:15",
            "firing_date": "2019-01-01 21:00:15",
            "schedule_id": 123,
            "primary_block_id": 123
        },
        {
            "id": 123,
            "user_id": "some_string",
            "user_email": "some_string",
            "is_disabled": true,
            "is_deleted": true,
            "deletion_date": "2019-01-01 21:00:15",
            "can_be_disabled": true,
            "avatar": 123,
            "user_name": "some_string",
            "phone": "some_string",
            "slack": "some_string",
            "skype": "some_string",
            "telegram": "some_string",
            "comment": "some_string",
            "hiring_date": "2019-01-01 21:00:15",
            "firing_date": "2019-01-01 21:00:15",
            "schedule_id": 123,
            "primary_block_id": 123
        }
    ]
}

Без параметров.

Параметр Описание Тип Значения
id ID int -
user_id ID пользователя string -
user_email Email string -
is_disabled Заблокирован ли пользователь bool -
is_deleted Удален ли пользователь bool -
deletion_date Дата удаления date -
can_be_disabled Может ли быть заблокированным bool -
avatar ID аватар-файла int -
user_name Имя string -
phone Телефон string -
slack Slack string -
skype Skype string -
telegram Telegram string -
comment Комментарий string -
hiring_date Дата найма date -
firing_date Дата увольнения date -
schedule_id ID рабочего графика int -
primary_block_id ID главной должности int -

Редактирование

GET /company/api/staff/edit-employee

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

curl 'https://{HOST}.platrum.ru/company/api/staff/edit-employee' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"avatar":123,"user_name":"some_string","phone":"some_string","slack":"some_string","skype":"some_string","telegram":"some_string","comment":"some_string","hiring_date":"2019-01-01 21:00:15","firing_date":"2019-01-01 21:00:15","schedule_id":123,"primary_block_id":123}'

{
    "status": "success",
    "data": {
        "id": 123,
        "user_id": "some_string",
        "user_email": "some_string",
        "is_disabled": true,
        "is_deleted": true,
        "deletion_date": "2019-01-01 21:00:15",
        "can_be_disabled": true,
        "avatar": 123,
        "user_name": "some_string",
        "phone": "some_string",
        "slack": "some_string",
        "skype": "some_string",
        "telegram": "some_string",
        "comment": "some_string",
        "hiring_date": "2019-01-01 21:00:15",
        "firing_date": "2019-01-01 21:00:15",
        "schedule_id": 123,
        "primary_block_id": 123
    }
}
Параметр Описание Тип Значения
id ID int -
avatar ID аватар-файла int -
user_name Имя string -
phone Телефон string -
slack Slack string -
skype Skype string -
telegram Telegram string -
comment Комментарий string -
hiring_date Дата найма date -
firing_date Дата увольнения date -
schedule_id ID рабочего графика int -
primary_block_id ID главной должности int -
Параметр Описание Тип Значения
id ID int -
user_id ID пользователя string -
user_email Email string -
is_disabled Заблокирован ли пользователь bool -
is_deleted Удален ли пользователь bool -
deletion_date Дата удаления date -
can_be_disabled Может ли быть заблокированным bool -
avatar ID аватар-файла int -
user_name Имя string -
phone Телефон string -
slack Slack string -
skype Skype string -
telegram Telegram string -
comment Комментарий string -
hiring_date Дата найма date -
firing_date Дата увольнения date -
schedule_id ID рабочего графика int -
primary_block_id ID главной должности int -