Мобильные
сотрудники
Справочный
центр

ИнтеграцияИнтеграция по APIРабота с графиками работы

Работа с графиками работы

Получение графиков работы

Общее описание

Функция GET /v6/api/workScheduleManagement/workSchedules позволяет получить все графики работы.

Параметры вызова

Параметр Описание
entityType Параметр, который указывает к какому типу сущности относится график работ (необязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.

Результат выполнения

Функция возвращает структуру со следующими параметрами графиков работы:

Параметр Описание
workScheduleID ИД графика работы
creationDate Дата начала создания графика работы (подробнее о формате времени).
subscriberID ИД Сотрудника (обязательный параметр)
name Название графика работы Сотрудника
workScheduleGroupID ИД группы графика работы
workScheduleType Тип графика работы. Существуют следующие значения:
  • 0 – расписание;
  • 1 – сменный график;
  • 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
lastModificationDate Дата последнего изменения графика работы.
entityType Параметр, который указывает к какому типу сущности относится график работ:
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:
  • true – график работы будет продлеваться автоматически;
  • false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:
  • 0 – два дня через два;
  • 1 – пять дней через два;
  • 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
exceptionID ИД исключения в графике работы Сотрудника
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
workScheduleItemTypeID ИД типа элемента графика работы
userID ИД пользователя, добавившего исключение в графике работы Сотрудника
externalID Внешний идентификатор исключения в графике работы
subscriberID ИД Сотрудника, в графике работы которого есть исключение
creationDate Дата начала создания исключения в графике работы (подробнее о формате времени).
description Описание исключения
Параметры рабочего интервала (структура items)
workScheduleItemTypeID ИД типа рабочего интервала
startTime Время начала рабочего интервала (подробнее о формате времени).
creationDate Дата начала создания рабочего интервала (подробнее о формате времени).
description Описание рабочего интервала
endTime Время окончания рабочего интервала (подробнее о формате времени).
workScheduleItemTypeID ИД типа рабочего интервала
userID ИД пользователя, добавившего рабочий интервал
externalID Внешний идентификатор рабочего интервала

Формат запроса

GET /v6/api/workScheduleManagement/workSchedules?entityType=\{entityType} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/workScheduleManagement/workSchedules HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "workScheduleID": integer,
        "creationDate": "string",
        "name": "string",
        "workScheduleGroupID": integer,
        "workScheduleTypeID": integer,
        "startDate": "string",
        "endDate": "string",
        "lastModificationDate": "string",
        "isAutoProlongation": boolean,
        "entityType": int,
        "scheduleSettings": \{
            "monday": \{
                "startTime": "string",
                "endTime": "string"
            },
            "tuesday": \{
                "startTime": "string",
                "endTime": "string"
            },
            "wednesday": \{
                "startTime": "string",
                "endTime": "string"
            },
            "thursday": \{
                "startTime": "string",
                "endTime": "string"
            },
            "friday": \{
                "startTime": "string",
                "endTime": "string"
            },
            "saturday": \{
                "startTime": "string",
                "endTime": "string"
            },
            "sunday": \{
                "startTime": "string",
                "endTime": "string"
            }
        },
        "shiftSettings": \{
            "shiftTypeID": integer,
            "startTime": "string",
            "endTime": "string"
        },
        "exceptions": [
            \{
                "exceptionID": integer,
                "startDate": "string",
                "endDate": "string",
                "workScheduleItemTypeID": integer,
                "userID": integer,
                "externalID": "string",
                "subscriberID": integer,
                     "creationDate": "string",
                "description": "string"
            }
        ],
        "items": [
            \{
                "workScheduleItemID": integer,
                "startDate": "string",
                "creationDate": "string",
                "description": "string",
                "endDate": "string",
                "workScheduleItemTypeID": integer,
                "userID": integer,
                "externalID": "string"
            }
        ]
    }
]

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

[
    \{
        "workScheduleID": 1,
        "creationDate": "2024-09-17T10:54:06.570",
        "name": "График",
        "workScheduleGroupID": 1,
        "workScheduleTypeID": 0,
        "startDate": "2024-09-16T18:43:50.387",
        "endDate": "2024-10-16T18:00",
        "lastModificationDate": "2024-12-19T16:21:13.464Z",
        "isAutoProlongation": false,
        "entityType": 1,
        "scheduleSettings": \{
            "monday": \{
                "startTime": "8:00",
                "endTime": "17:00"
            },
            "tuesday": \{
                "startTime": "8:00",
                "endTime": "17:00"
            },
            "wednesday": \{
                "startTime": "8:00",
                "endTime": "17:00"
            },
            "thursday": \{
                "startTime": "8:00",
                "endTime": "17:00"
            },
            "friday": \{
                "startTime": "8:00",
                "endTime": "17:00"
            }
        },
        "exceptions": [
            \{
                "exceptionID": 1,
                "startDate": "2024-09-17T10:00",
                "endDate": "2024-09-17T10:00",
                "workScheduleItemTypeID": 2,
                "userID": 1,
                "externalID": "123",
                "subscriberID": 1,
                "creationDate": "2024-09-17T10:54:06.570",
                "description": "Командировка"
            }
        ],
        "items": [
            \{
                "workScheduleItemID": 2,
                "startDate": "2024-09-17T10:00",
                "creationDate": "2024-09-17T10:54:06.570",
                "description": "Командировка",
                "endDate": "2024-09-17T10:00",
                "workScheduleItemTypeID": 2,
                "userID": 1,
                "externalID": "1234"
            }
        ]
    }
]

Получение графика работы

Общее описание

Функция GET /v6/api/workScheduleManagement/workSchedules/{workScheduleID} позволяет получить график работы по его идентификатору.

Параметры вызова

В запросе используется обязательный параметр workScheduleID — идентификатор графика работы.

Результат выполнения

Функция возвращает структуру со следующими параметрами графика работы:

Параметр Описание
workScheduleID ИД графика работы
creationDate Дата начала создания графика работы (подробнее о формате времени).
subscriberID ИД Сотрудника (обязательный параметр)
name Название графика работы Сотрудника
workScheduleGroupID ИД группы графика работы
workScheduleType Тип графика работы. Существуют следующие значения:
  • 0 – расписание;
  • 1 – сменный график;
  • 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
lastModificationDate Дата последнего изменения графика работы.
entityType Параметр, который указывает к какому типу сущности относится график работ:
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:
  • true – график работы будет продлеваться автоматически;
  • false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:
  • 0 – два дня через два;
  • 1 – пять дней через два;
  • 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
exceptionID ИД исключения в графике работы Сотрудника
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
workScheduleItemTypeID ИД типа элемента графика работы
userID ИД пользователя, добавившего исключение в графике работы Сотрудника
externalID Внешний идентификатор исключения в графике работы
subscriberID ИД Сотрудника, в графике работы которого есть исключение
creationDate Дата начала создания исключения в графике работы (подробнее о формате времени).
description Описание исключения
Параметры рабочего интервала (структура items)
workScheduleItemTypeID ИД типа рабочего интервала
startTime Время начала рабочего интервала (подробнее о формате времени).
creationDate Дата начала создания рабочего интервала (подробнее о формате времени).
description Описание рабочего интервала
endTime Время окончания рабочего интервала (подробнее о формате времени).
workScheduleItemTypeID ИД типа рабочего интервала
userID ИД пользователя, добавившего рабочий интервал
externalID Внешний идентификатор рабочего интервала

Формат запроса

GET /v6/api/workScheduleManagement/workSchedules/\{workScheduleID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/workScheduleManagement/workSchedules/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "workScheduleID": integer,
    "creationDate": "string",
    "name": "string",
    "workScheduleGroupID": integer,
    "workScheduleTypeID": integer,
    "startDate": "string",
    "endDate": "string",
    "lastModificationDate": "string",
    "isAutoProlongation": boolean,
    "entityType": int,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "exceptionID": integer,
            "startDate": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "externalID": "string",
            "subscriberID": integer,
            "creationDate": "string",
            "description": "string"
        }
    ],
    "items": [
        \{
            "workScheduleItemID": integer,
            "startDate": "string",
            "creationDate": "string",
            "description": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "externalID": "string"
        }
    ]
}

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

\{
    "workScheduleID": 1,
    "creationDate": "2024-09-17T10:54:06.570",
    "name": "График",
    "workScheduleGroupID": 1,
    "workScheduleTypeID": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "endDate": "2024-10-16T18:00",
    "lastModificationDate": "2024-12-19T16:21:13.647Z",
    "isAutoProlongation": false,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "exceptionID": 1,
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "userID": 1,
            "externalID": "123",
            "subscriberID": 1,
            "creationDate": "2024-09-17T10:54:06.570",
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "workScheduleItemID": 2,
            "startDate": "2024-09-17T10:00",
            "creationDate": "2024-09-17T10:54:06.570",
            "description": "Командировка"
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "userID": 1,
            "externalID": "1234"
        }
    ]
}

Создание графика работы

Общее описание

Функция POST /v6/api/workScheduleManagement/workSchedules позволяет создать график работы.

Параметры вызова

Функция имеет следующие параметры:

Параметр Описание
name Название графика работы Сотрудника
type Тип графика работы. Существуют следующие значения:
  • 0 – расписание;
  • 1 – сменный график;
  • 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
entityType Параметр, который указывает к какому типу сущности относится график работ (обязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:
  • true – график работы будет продлеваться автоматически;
  • false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:
  • 0 – два дня через два;
  • 1 – пять дней через два;
  • 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
subscriberID ИД Сотрудника, в графике работы которого есть исключение
externalID Внешний идентификатор исключения в графике работы
workScheduleItemTypeID ИД типа элемента графика работы
description Описание исключения
Параметры элементов графика работы Сотрудника (структура items)
startTime Время начала элемента графика (подробнее о формате времени).
endTime Время окончания элемента графика (подробнее о формате времени).
description Описание элемента графика
workScheduleItemTypeID ИД типа элемента графика работы
externalID Внешний идентификатор элемента графика работы

Результат выполнения

При успешном выполнении возвращается статус 201.

Функция возвращает структуру со следующими параметрами графика работы:

Параметр Описание
workScheduleID ИД графика работы
creationDate Дата начала создания графика работы (подробнее о формате времени).
subscriberID ИД Сотрудника (обязательный параметр)
name Название графика работы Сотрудника
workScheduleGroupID ИД группы графика работы
workScheduleType Тип графика работы. Существуют следующие значения:
  • 0 – расписание;
  • 1 – сменный график;
  • 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
lastModificationDate Дата последнего изменения графика работы.
entityType Параметр, который указывает к какому типу сущности относится график работ:
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:
  • true – график работы будет продлеваться автоматически;
  • false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:
  • 0 – два дня через два;
  • 1 – пять дней через два;
  • 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
exceptionID ИД исключения в графике работы Сотрудника
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
workScheduleItemTypeID ИД типа элемента графика работы
userID ИД пользователя, добавившего исключение в графике работы Сотрудника
externalID Внешний идентификатор исключения в графике работы
subscriberID ИД Сотрудника, в графике работы которого есть исключение
creationDate Дата начала создания исключения в графике работы (подробнее о формате времени).
description Описание исключения
Параметры рабочего интервала (структура items)
workScheduleItemTypeID ИД типа рабочего интервала
startTime Время начала рабочего интервала (подробнее о формате времени).
creationDate Дата начала создания рабочего интервала (подробнее о формате времени).
description Описание рабочего интервала
endTime Время окончания рабочего интервала (подробнее о формате времени).
workScheduleItemTypeID ИД типа рабочего интервала
userID ИД пользователя, добавившего рабочий интервал
externalID Внешний идентификатор рабочего интервала

Формат запроса

POST /v6/api/workScheduleManagement/workSchedules HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "workScheduleGroupID": integer,
    "type": integer,
    "startDate": "string",
    "endDate": "string",
    "isAutoProlongation": boolean,
    "entityType": int,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "startDate": "string",
            "endDate": "string",
            "subscriberID": integer,
            "externalID": "string",
            "workScheduleItemTypeID": integer,
            "description": "string"
        }
    ],
    "items": [
        \{
            "startDate": "string",
            "endDate": "string",
            "description": "string",
            "workScheduleItemTypeID": integer,
            "externalID": "string"
        }
    ]
}

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

POST /v6/api/workScheduleManagement/workSchedules HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "График",
    "workScheduleGroupID": 1,
    "type": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "endDate": "2024-10-16T18:00",
    "isAutoProlongation": false,
    "entityType": 1,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "subscriberID": 1,
            "externalID": "123",
            "workScheduleItemTypeID": 2,
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "externalID": "1234"
        }
    ]
}

Формат ответа

\{
    "workScheduleID": integer,
    "creationDate": "string",
    "name": "string",
    "workScheduleGroupID": integer,
    "workScheduleTypeID": integer,
    "startDate": "string",
    "endDate": "string",
    "lastModificationDate": "string",
    "isAutoProlongation": boolean,
    "entityType": int,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "exceptionID": integer,
            "startDate": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "externalID": "string",
            "subscriberID": integer,
            "creationDate": "string",
            "description": "string"
        }
    ],
    "items": [
        \{
            "workScheduleItemID": integer,
            "startDate": "string",
            "creationDate": "string",
            "description": "string",
            "endDate": "string",
            "workScheduleItemTypeID": integer,
            "userID": integer,
            "externalID": "string"
        }
    ]
}

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

\{
    "workScheduleID": 1,
    "creationDate": "2024-09-17T10:54:06.570",
    "name": "График",
    "workScheduleGroupID": 1,
    "workScheduleTypeID": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "lastModificationDate": "2024-12-19T16:21:13.549Z",
    "endDate": "2024-10-16T18:00",
    "isAutoProlongation": false,
    "entityType": int,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "exceptionID": 1,
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "userID": 1,
            "externalID": "123",
            "subscriberID": 1,
            "creationDate": "2024-09-17T10:54:06.570",
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "workScheduleItemID": 2,
            "startDate": "2024-09-17T10:00",
            "creationDate": "2024-09-17T10:54:06.570",
            "description": "Командировка"
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "userID": 1,
            "externalID": "1234"
        }
    ]
}

Обновление графика работы

Общее описание

Функция PUT /v6/api/workScheduleManagement/workSchedules/{workScheduleID} позволяет обновить полностью график работы по его идентификатору (должны быть переданы все атрибуты графика работы для обновления, т.е. график работы обновляется полностью).

Параметры вызова

Функция имеет следующие параметры:

Параметр Описание
workScheduleID ИД графика работы
name Название графика работы Сотрудника
type Тип графика работы. Существуют следующие значения:
  • 0 – расписание;
  • 1 – сменный график;
  • 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
entityType Параметр, который указывает к какому типу сущности относится график работ (обязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:
  • true – график работы будет продлеваться автоматически;
  • false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:
  • 0 – два дня через два;
  • 1 – пять дней через два;
  • 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
subscriberID ИД Сотрудника, в графике работы которого есть исключение
externalID Внешний идентификатор исключения в графике работы
workScheduleItemTypeID ИД типа элемента графика работы
description Описание исключения
Параметры элементов графика работы Сотрудника (структура items)
startTime Время начала элемента графика (подробнее о формате времени).
endTime Время окончания элемента графика (подробнее о формате времени).
description Описание элемента графика
workScheduleItemTypeID ИД типа элемента графика работы
externalID Внешний идентификатор элемента графика работы

Результат выполнения

При успешном выполнении возвращается статус 201.

Формат запроса

PUT /v6/api/workScheduleManagement/workSchedules/\{workScheduleID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "workScheduleGroupID": integer,
    "type": integer,
    "startDate": "string",
    "endDate": "string",
    "isAutoProlongation": boolean,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "startDate": "string",
            "endDate": "string",
            "subscriberID": integer,
            "externalID": "string",
            "workScheduleItemTypeID": integer,
            "description": "string"
        }
    ],
    "items": [
        \{
            "startDate": "string",
            "endDate": "string",
            "description": "string",
            "workScheduleItemTypeID": integer,
            "externalID": "string"
        }
    ]
}

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

PUT /v6/api/workScheduleManagement/workSchedules/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "График",
    "workScheduleGroupID": 1,
    "type": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "endDate": "2024-10-16T18:00",
    "isAutoProlongation": false,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "subscriberID": 1,
            "externalID": "123",
            "workScheduleItemTypeID": 2,
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "externalID": "1234"
        }
    ]
}

Изменение графика работы

Общее описание

Функция PATCH /v6/api/workScheduleManagement/workSchedules/{workScheduleID} позволяет изменить нужные параметры графика работы по его идентификатору.

Параметры вызова

Функция имеет следующие параметры (если параметр не передан при вызове функции, то его значение не меняется):

Параметр Описание
workScheduleID ИД графика работы
name Название графика работы Сотрудника
type Тип графика работы. Существуют следующие значения:
  • 0 – расписание;
  • 1 – сменный график;
  • 2 – календарь.
startDate Дата начала периода действия графика работы (подробнее о формате времени).
endDate Дата окончания периода действия графика работы (подробнее о формате времени).
entityType Параметр, который указывает к какому типу сущности относится график работ (обязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.
autoProlongation Автоматическое продление графика работы. Существуют следующие значения:
  • true – график работы будет продлеваться автоматически;
  • false – график работы не будет продлеваться автоматически.
Параметры графика работы Сотрудника по каждому дню недели (массив структур scheduleSettings). Для настройки графика работы в структуре соответствующей дня недели (monday — понедельник, tuesday — вторник, wednesday — среда, thursday — четверг, friday — пятница, saturday — суббота, sunday — воскресенье) укажите время начала и окончания работы в этот день.
startTime Время начала работы в выбранный день недели (подробнее о формате времени).
endTime Время окончания работы в выбранный день недели (подробнее о формате времени).
Параметры графика работы Сотрудника с типом «Сменный график» (структура shiftSettings)
shiftType Тип сменного графика. Существуют следующие значения:
  • 0 – два дня через два;
  • 1 – пять дней через два;
  • 2 – три дня через три.
startTime Время начала смены (подробнее о формате времени).
endTime Время окончания смены (подробнее о формате времени).
Параметры исключений в графике работы Сотрудника (структура exceptions)
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
subscriberID ИД Сотрудника, в графике работы которого есть исключение
externalID Внешний идентификатор исключения в графике работы
workScheduleItemTypeID ИД типа элемента графика работы
description Описание исключения
Параметры элементов графика работы Сотрудника (структура items)
startTime Время начала элемента графика (подробнее о формате времени).
endTime Время окончания элемента графика (подробнее о формате времени).
description Описание элемента графика
workScheduleItemTypeID ИД типа элемента графика работы
externalID Внешний идентификатор элемента графика работы

Результат выполнения

При успешном выполнении возвращается статус 201.

Формат запроса

PATCH /v6/api/workScheduleManagement/workSchedules/\{workScheduleID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "workScheduleGroupID": integer,
    "type": integer,
    "startDate": "string",
    "endDate": "string",
    "isAutoProlongation": boolean,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "tuesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "wednesday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "thursday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "friday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "saturday": \{
            "startTime": "string",
            "endTime": "string"
        },
        "sunday": \{
            "startTime": "string",
            "endTime": "string"
        }
    },
    "shiftSettings": \{
        "shiftTypeID": integer,
        "startTime": "string",
        "endTime": "string"
    },
    "exceptions": [
        \{
            "startDate": "string",
            "endDate": "string",
            "subscriberID": integer,
            "externalID": "string",
            "workScheduleItemTypeID": integer,
            "description": "string"
        }
    ],
    "items": [
        \{
            "startDate": "string",
            "endDate": "string",
            "description": "string",
            "workScheduleItemTypeID": integer,
            "externalID": "string"
        }
    ]
}

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

PATCH /v6/api/workScheduleManagement/workSchedules/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "График",
    "workScheduleGroupID": 1,
    "type": 0,
    "startDate": "2024-09-16T18:43:50.387",
    "endDate": "2024-10-16T18:00",
    "isAutoProlongation": false,
    "scheduleSettings": \{
        "monday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "tuesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "wednesday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "thursday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        },
        "friday": \{
            "startTime": "8:00",
            "endTime": "17:00"
        }
    },
    "exceptions": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "subscriberID": 1,
            "externalID": "123",
            "workScheduleItemTypeID": 2,
            "description": "Командировка"
        }
    ],
    "items": [
        \{
            "startDate": "2024-09-17T10:00",
            "endDate": "2024-09-17T10:00",
            "workScheduleItemTypeID": 2,
            "externalID": "1234"
        }
    ]
}

Удаление графика работы

Общее описание

Функция DELETE /v6/api/workScheduleManagement/workSchedules/{workScheduleID} позволяет удалить график работы по его идентификатору.

Параметры вызова

В запросе используется обязательный параметр workScheduleID — идентификатор графика работы.

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

DELETE /v6/api/workScheduleManagement/workSchedules/\{workScheduleID} HTTP/1.1
Host: host		
Authorization: Bearer token

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

DELETE /v6/api/workScheduleManagement/workSchedules/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Получение списка групп графиков работ

Общее описание

Функция GET /v6/api/workScheduleManagement/workScheduleGroups позволяет получить список групп графиков работы.

Параметры вызова

Параметр Описание
entityType Параметр, который указывает к какому типу сущности относится график работ (необязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.

Результат выполнения

Функция возвращает структуру со следующими параметрами групп графиков работы:

Параметр Описание
workScheduleGroupID ИД группы графиков работы
parentID ИД родительской группы графиков работы
name Название группы графиков работы
color Цвет группы графиков работы
entityType Параметр, который указывает к какому типу сущности относится график работ (необязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.

Формат запроса

GET /v6/api/workScheduleManagement/workScheduleGroups?entityType=\{entityType} HTTP/1.1
Host: host		
Authorization: Bearer token

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

GET /v6/api/workScheduleManagement/workScheduleGroups?entityType=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

[
    \{
        "workScheduleGroupID": integer,
        "parentID": integer,
        "name": "string",
        "color": integer,
        "entityType": integer
    },
    \{
        "workScheduleGroupID": integer,
        "parentID": integer,
        "name": "string",
        "color": integer,
        "entityType": integer
    }
]

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

[
    \{
        "workScheduleGroupID": 1,
        "name": "Курьеры",
        "color": 0,
        "entityType": 1
    },
    \{
        "workScheduleGroupID": 2,
        "parentID": 1,
        "name": "Сборщики",
        "color": 6,
        "entityType": 1
    }
]

Получение группы графиков работы

Общее описание

Функция GET /v6/api/workScheduleManagement/workScheduleGroups/{workScheduleGroupID} позволяет получить группу графиков работы по ее идентификатору.

Параметры вызова

В запросе используется обязательный параметр workScheduleGroupID — идентификатор группы графиков работы.

Результат выполнения

Функция возвращает структуру со следующими параметрами группы графиков работы:

Параметр Описание
workScheduleGroupID ИД группы графиков работы
parentID ИД родительской группы графиков работы
name Название группы графиков работы
color Цвет группы графиков работы
entityType Параметр, который указывает к какому типу сущности относится график работ (необязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.

Формат запроса

GET /v6/api/workScheduleManagement/workScheduleGroups/\{workScheduleGroupID} HTTP/1.1
Host: host		
Authorization: Bearer token

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

GET /v6/api/workScheduleManagement/workScheduleGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "workScheduleGroupID": integer,
    "parentID": integer,
    "name": "string",
    "color": integer,
    "entityType": integer 

}

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

\{
    "workScheduleGroupID": 1,
    "parentID": 2,
    "name": "Курьеры",
    "color": 6,
    "entityType": 1 
}

Создание группы графиков работы

Общее описание

Функция POST /v6/api/workScheduleManagement/workScheduleGroups позволяет создать группу графиков работы.

Параметры вызова

Параметр Описание
parentID ИД родительской группы графиков работы
name Название группы графиков работы (обязательный параметр)
color Цвет группы графиков работы
entityType Параметр, который указывает к какому типу сущности относится группа графиков работ (обязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.

Результат выполнения

При успешном выполнении возвращается статус 201.

Функция возвращает структуру со следующими параметрами группы графиков работы:

Параметр Описание
workScheduleGroupID ИД группы графиков работы
parentID ИД родительской группы графиков работы
name Название группы графиков работы
color Цвет группы графиков работы
entityType Параметр, который указывает к какому типу сущности относится график работ (необязательный параметр, целое число):
  • 1 – график сотрудников;
  • 14 – график объекта;
  • 76 – график актива.

Формат запроса

POST /v6/api/workScheduleManagement/workScheduleGroups HTTP/1.1
Host: host		
Authorization: Bearer token

\{
    "parentID": integer,
    "name": "string",
    "color": integer,
    "entityType": integer
}

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

POST /v6/api/workScheduleManagement/workScheduleGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 1,
    "name": "Графики работы",
    "color": 1,	
    "entityType": 1

}

Формат ответа

\{
    "workScheduleGroupID": integer,
    "parentID": integer,
    "name": "string",
    "color": integer,
    "entityType": integer
}

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

\{
    "workScheduleGroupID": 3,
    "parentID": 1,
    "name": "Графики работы",
    "color": 1,
    "entityType": 1
}

Обновление группы графиков работы

Общее описание

Функция PUT /v6/api/workScheduleManagement/workScheduleGroups/{workScheduleGroupID} позволяет полностью обновить группу графиков работы по её идентификатору. Для обновления должны быть переданы все атрибуты группы графиков работы.

Параметры вызова

Параметр Описание
workScheduleGroupID ИД группы графиков работы
parentID ИД родительской группы графиков работы
name Название группы графиков работы
color Цвет группы графиков работы

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

PUT /v6/api/workScheduleManagement/workScheduleGroups/\{workScheduleGroupID} HTTP/1.1
Host: host		
Authorization: Bearer token

\{
    "parentID": integer,
    "name": "string",
    "color": integer
}

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

PUT /v6/api/workScheduleManagement/workScheduleGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 2,
    "name": "Графики работы",
    "color": 1
}

Изменение группы графиков работы

Общее описание

Функция PATCH /v6/api/workScheduleManagement/workScheduleGroups/{workScheduleGroupID} позволяет изменить только часть параметров группы графиков работы.

Параметры вызова

Параметр Описание
workScheduleGroupID ИД группы графиков работы
parentID ИД родительской группы графиков работы
name Название группы графиков работы
color Цвет группы графиков работы

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

PATCH /v6/api/workScheduleManagement/workScheduleGroups/\{workScheduleGroupID} HTTP/1.1
Host: host		
Authorization: Bearer token

\{
    "parentID": integer,
    "name": "string",
    "color": integer
}

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

PATCH /v6/api/workScheduleManagement/workScheduleGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "parentID": 2,
    "name": "Графики работы",
    "color": 1
}

Удаление группы графиков работы

Общее описание

Функция DELETE /v6/api/workScheduleManagement/workScheduleGroups/{workScheduleGroupID} позволяет удалить группу графиков работы по её идентификатору.

Параметры вызова

Параметр Описание
workScheduleGroupID ИД группы графиков работы

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

DELETE /v6/api/workScheduleManagement/workScheduleGroups/\{workScheduleGroupID} HTTP/1.1
Host: host		
Authorization: Bearer token

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

DELETE /v6/api/workScheduleManagement/workScheduleGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Получение типов элементов графика работы

Общее описание

Функция GET /v6/api/workScheduleManagement/workSchedules/itemTypes позволяет получить типы элементов графика работы.

Параметры вызова

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает структуру со следующими параметрами типов элементов графика работы:

Параметр Описание
workScheduleItemTypeID ИД типа элемента графика работы
name Название типа элемента графика работы
level Уровень приоритета или иерархии этого типа элемента графика работы
isWorkingTime Является ли этот тип элемента рабочим временем графика работы. Возможные значения:
  • true — рабочее время
  • false — нерабочее время

Формат запроса

GET /v6/api/workScheduleManagement/workSchedules/itemTypes HTTP/1.1
Host: host		
Authorization: Bearer token

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

GET /v6/api/workScheduleManagement/workSchedules/itemTypes HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Формат ответа

\{
    "workScheduleItemTypes": [
        \{
            "workScheduleItemTypeID": integer,
            "name": "string",
            "level": integer,
            "isWorkingTime": boolean
        },
        \{
            "workScheduleItemTypeID": integer,
            "name": "string",
            "level": integer,
            "isWorkingTime": boolean
        }
    ]
}

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

\{
    "workScheduleItemTypes": [
        \{
            "workScheduleItemTypeID": 1,
            "name": "Рабочий день",
            "level": 1,
            "isWorkingTime": true
        },
        \{
            "workScheduleItemTypeID": 2,
            "name": "Болезнь",
            "level": 1,
            "isWorkingTime": false
        },
        \{
            "workScheduleItemTypeID": 3,
            "name": "Выходной",
            "level": 1,
            "isWorkingTime": false
        }
    ]
}

Создание исключения в графике работы Сотрудника

Общее описание

Функция POST /v6/api/workScheduleManagement/subscribers/{subscriberID}/workSchedule/exceptions позволяет создать исключение в графике работы Сотрудника.

Параметры запроса

Параметр Описание
subscriberID ИД Сотрудника
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
externalID Внешний идентификатор исключения
workScheduleItemTypeID ИД типа исключения в графике работы
description Описание

Результат выполнения

Функция возвращает структуру с параметрами графика работы Сотрудника:

Параметр Описание
exceptionID ИД исключения
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
externalID Внешний идентификатор исключения
workScheduleItemTypeID ИД типа исключения в графике работы
userID ИД пользователя, добавившего исключение в графике работы Сотрудника
subscriberID ИД Сотрудника, в графике работы которого добавлено исключение
description Описание
creationDate Дата создания исключения в графике работы (подробнее о формате времени).

Формат запроса

POST /v6/api/workScheduleManagement/subscribers/\{subscriberID}/workSchedule/exceptions HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "startDate": "string",
    "endDate": "string",
    "externalID": "string",
    "workScheduleItemTypeID": integer,
    "description": "string",
}

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

POST /v6/api/workScheduleManagement/subscribers/1/workSchedule/exceptions HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "startDate": "2024-09-20T00:00:00",
    "endDate": "2024-09-20T23:59:59",
    "externalID": "123",
    "workScheduleItemTypeID": 2,
    "description": "Больничный",
}

Формат ответа

\{
    "exceptionID": integer,
    "startDate": "string",
    "endDate": "string",
    "externalID": "string",
    "workScheduleItemTypeID": integer,
    "userID": integer,
    "subscriberID": integer,
    "description": "string",
    "creationDate": "string"
}

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

\{
    "exceptionID": 4536,
    "startDate": "2024-09-20T00:00:00",
    "endDate": "2024-09-20T23:59:59",
    "externalID": "123",
    "workScheduleItemTypeID": 2,
    "userID": 89051,
    "subscriberID": 1,
    "description": "Больничный",
    "creationDate": "2024-09-17T12:24:39.283"
}

Создание или изменение исключения в графике работы Сотрудника по внешнему идентификатору исключения

Общее описание

Функция POST /v6/api/workScheduleManagement/subscribers/{subscriberID}/workSchedule/exceptions/externalID/{externalID} позволяет создать исключение в графике работы Сотрудника.

Параметры запроса

Параметр Описание
subscriberID ИД Сотрудника
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
externalID Внешний идентификатор исключения
workScheduleItemTypeID ИД типа исключения в графике работы
description Описание

Результат выполнения

Функция возвращает структуру с параметрами графика работы Сотрудника:

Параметр Описание
exceptionID ИД исключения
startTime Время начала исключения (подробнее о формате времени).
endTime Время окончания исключения (подробнее о формате времени).
externalID Внешний идентификатор исключения
workScheduleItemTypeID ИД типа исключения в графике работы
userID ИД пользователя, добавившего исключение в графике работы Сотрудника
subscriberID ИД Сотрудника, в графике работы которого добавлено исключение
description Описание
creationDate Дата создания исключения в графике работы (подробнее о формате времени).

Формат запроса

POST /v6/api/workScheduleManagement/subscribers/\{subscriberID}/workSchedule/exceptions/externalID/\{externalID} HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "startDate": "string",
    "endDate": "string",
    "externalID": "string",
    "workScheduleItemTypeID": integer,
    "description": "string",
}

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

POST /v6/api/workScheduleManagement/subscribers/1/workSchedule/exceptions/externalID/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "startDate": "2024-09-20T00:00:00",
    "endDate": "2024-09-20T23:59:59",
    "externalID": "123",
    "workScheduleItemTypeID": 2,
    "description": "Больничный",
}

Формат ответа

\{
    "exceptionID": integer,
    "startDate": "string",
    "endDate": "string",
    "externalID": "string",
    "workScheduleItemTypeID": integer,
    "userID": integer,
    "subscriberID": integer,
    "description": "string",
    "creationDate": "string"
}

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

\{
    "exceptionID": 4536,
    "startDate": "2024-09-20T00:00:00",
    "endDate": "2024-09-20T23:59:59",
    "externalID": "123",
    "workScheduleItemTypeID": 2,
    "userID": 89051,
    "subscriberID": 1,
    "description": "Больничный",
    "creationDate": "2024-09-17T12:24:39.283"
}

Удаление исключения из графика работы Сотрудника по идентификатору исключения

Общее описание

Функция DELETE /v6/api/workScheduleManagement/subscribers/{subscriberID}/workSchedule/exceptions/{exceptionID} позволяет удалить исключение из графика работы Сотрудника по внешнему идентификатору исключения.

Параметры вызова

Параметр Описание
subscriberID ИД Сотрудника
exceptionID ИД исключения из графика работы Сотрудника

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

DELETE /v6/api/workScheduleManagement/subscribers/\{subscriberID}/workSchedule/exceptions/\{exceptionID} HTTP/1.1
Host: host		
Authorization: Bearer token

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

DELETE /v6/api/workScheduleManagement/subscribers/1/workSchedule/exceptions/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Удаление исключения из графика работы Сотрудника по внешнему идентификатору исключения

Общее описание

Функция DELETE /v6/api/workScheduleManagement/subscribers/{subscriberID}/workSchedule/exceptions/externalID/{externalID} позволяет удалить исключение из графика работы Сотрудника по внешнему идентификатору исключения.

Параметры вызова

Параметр Описание
subscriberID ИД Сотрудника
externalID Внешний ИД исключения из графика работы Сотрудника

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

DELETE /v6/api/workScheduleManagement/subscribers/\{subscriberID}/workSchedule/exceptions/externalID/\{externalID} HTTP/1.1
Host: host		
Authorization: Bearer token

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

DELETE /v6/api/workScheduleManagement/subscribers/1/workSchedule/exceptions/externalID/123 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Работа с задачами

Предыдущая страница

Работа с планированием

Следующая страница

Содержание

Получение графиков работыПолучение графика работыСоздание графика работыОбновление графика работыИзменение графика работыУдаление графика работыПолучение списка групп графиков работПолучение группы графиков работыСоздание группы графиков работыОбновление группы графиков работыИзменение группы графиков работыУдаление группы графиков работыПолучение типов элементов графика работыСоздание исключения в графике работы СотрудникаСоздание или изменение исключения в графике работы Сотрудника по внешнему идентификатору исключенияУдаление исключения из графика работы Сотрудника по идентификатору исключенияУдаление исключения из графика работы Сотрудника по внешнему идентификатору исключения