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

Пользователь

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

Профили

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

GET /user/api/profile/list

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

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

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

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

Параметр Описание Тип Значения
id ID int -
avatar Id файла аватара пользователя string -
birth_date Дата рождения date -
comment Примечание string -
deletion_date Дата удаления date -
firing_date Дата увольнения date -
hired_by Id нанявшего сотрудника string -
hiring_date Дата найма date -
is_deleted Удалён ли профиль bool -
is_disabled Выключен ли профиль bool -
name Имя string -
phone Номер телефона string -
responsible_hr Id ответсвенного HR string -
skype Skype string -
slack Slack string -
telegram Telegram string -
user_email Почта string -
user_id Id сотрудника string -
user_name Имя string -

Рабочие графики

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

GET /user/api/schedule/list

Метод позволяет получить список рабочих графиков

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

{
    "status": "success",
    "data": [
        {
            "id": 123,
            "is_active": true,
            "was_assigned": true,
            "name": "some_string",
            "type": "some_string",
            "weekends": "array",
            "extra_weekends": "array",
            "extra_working_days": "array",
            "working_days_count": 123,
            "weekends_count": 123,
            "is_starting_from_work_days": true,
            "start_date": "2019-01-01 21:00:15",
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "deletion_date": "2019-01-01 21:00:15",
            "is_default": true
        },
        {
            "id": 123,
            "is_active": true,
            "was_assigned": true,
            "name": "some_string",
            "type": "some_string",
            "weekends": "array",
            "extra_weekends": "array",
            "extra_working_days": "array",
            "working_days_count": 123,
            "weekends_count": 123,
            "is_starting_from_work_days": true,
            "start_date": "2019-01-01 21:00:15",
            "author_id": "some_string",
            "last_editor_id": "some_string",
            "creation_date": "2019-01-01 21:00:15",
            "deletion_date": "2019-01-01 21:00:15",
            "is_default": true
        }
    ]
}

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

Параметр Описание Тип Значения
id ID int -
is_active Используется ли график в настоящее время bool -
was_assigned Использовался ли график когда либо bool -
name Название string -
type Тип string -
weekends Выходные дни array -
extra_weekends Дополнительные выходные дни array -
extra_working_days Дополнительные рабочие дни array -
working_days_count Количество рабочих дней int -
weekends_count Количество выходных int -
is_starting_from_work_days Начинать ли с рабочих дней bool -
start_date Дата начала рабочего цикла date -
author_id Id автора string -
last_editor_id Id последнего редактора string -
creation_date Дата создание date -
deletion_date Дата удаления date -
is_default Является ли графиком по умолчанию bool -

Создание и обновление

GET /user/api/schedule/save

Метод позволяет создать новый или обновить существующий рабочий график

curl 'https://{HOST}.platrum.ru/user/api/schedule/save' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123,"name":"some_string","type":"some_string","weekends":"array","extra_weekends":"array","extra_working_days":"array","working_days_count":123,"weekends_count":123,"is_starting_from_work_days":true,"start_date":"2019-01-01 21:00:15"}'

{
    "status": "success",
    "data": {
        "id": 123,
        "is_active": true,
        "was_assigned": true,
        "name": "some_string",
        "type": "some_string",
        "weekends": "array",
        "extra_weekends": "array",
        "extra_working_days": "array",
        "working_days_count": 123,
        "weekends_count": 123,
        "is_starting_from_work_days": true,
        "start_date": "2019-01-01 21:00:15",
        "author_id": "some_string",
        "last_editor_id": "some_string",
        "creation_date": "2019-01-01 21:00:15",
        "deletion_date": "2019-01-01 21:00:15",
        "is_default": true
    }
}
Параметр Описание Тип Значения
id Id рабочего графика int -
name* Название string -
type* Тип string -
weekends Выходные дни array -
extra_weekends Дополнительные выходные дни array -
extra_working_days Дополнительные рабочие дни array -
working_days_count Количество рабочих дней int -
weekends_count Количество выходных int -
is_starting_from_work_days Начинать ли с рабочих дней bool -
start_date Дата начала рабочего цикла date -
Параметр Описание Тип Значения
id ID int -
is_active Используется ли график в настоящее время bool -
was_assigned Использовался ли график когда либо bool -
name Название string -
type Тип string -
weekends Выходные дни array -
extra_weekends Дополнительные выходные дни array -
extra_working_days Дополнительные рабочие дни array -
working_days_count Количество рабочих дней int -
weekends_count Количество выходных int -
is_starting_from_work_days Начинать ли с рабочих дней bool -
start_date Дата начала рабочего цикла date -
author_id Id автора string -
last_editor_id Id последнего редактора string -
creation_date Дата создание date -
deletion_date Дата удаления date -
is_default Является ли графиком по умолчанию bool -

Удаление

GET /user/api/schedule/delete

Метод позволяет удалить рабочий график

curl 'https://{HOST}.platrum.ru/user/api/schedule/delete' \
    --request POST \
    --header 'Content-type: application/json' \ 
    --header 'Api-key: {KEY}' \ 
    --data '{"id":123}'

{
    "status": "success",
    "data": true
}
Параметр Описание Тип Значения
id* Id рабочего графика int -

bool