Создание графика активности
Метод | create.schedules |
---|---|
Описание | Создание графика активности |
Кому доступен | Партнёр, Клиент |
Параметры запроса
Название | Тип | Обязательный | Допустимые значения | Описание |
---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
name |
string | да | Название графика активности | |
Расписания работы | ||||
schedules |
array | да | Расписания работы | |
activity_days |
object | да | Дни в которые график активен | |
type |
enum | да |
|
Тип.
|
days |
array | да |
Если "type" = "days_of_week" :
"type" = "days_of_month" :
"type" = "cycle" :
"type" = "business_calendar" :
|
Дни недели или месяца
Пример циклического календаря:
Пример производственного календаря: |
Время активности графика | ||||
activity_time |
array | нет |
Время активности графика.
Если параметр не задан, то график работает без ограничений |
|
time_from |
string | да | HH:MM | Время начала активности графика |
time_till |
string | да | HH:MM |
Время окончания активности графика.
Должно быть обязательно больше чем указано в параметре "time_from"
|
Период активности графика | ||||
activity_date_from |
string | нет | YYYY-MM-DD | Дата начала активности графика |
activity_date_till |
string | нет | YYYY-MM-DD | Дата окончания активности графика |
Параметры ответа
Название | Тип | Обязательный | Описание |
---|---|---|---|
id |
number | да | Уникальный идентификатор графика активности |
JSON структура запроса
{
"jsonrpc":"2.0",
"id":"number",
"method":"create.schedules",
"params":{
"access_token":"string",
"id":"number",
"name":"string",
"schedules":[
{
"activity_days":{
"type":"enum",
"days":[
]
},
"activity_time":[
{
"time_from":"string",
"time_till":"string"
}
],
"activity_date_from":"string",
"activity_date_till":"string"
}
]
}
}
JSON структура ответа
{
"jsonrpc":"2.0",
"id":"number",
"result":{
"id":"number"
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом create"