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

Метод	`get.schedules`
Описание	Получение списка графиков активности
Кому доступен	Партнер, Клиент

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

Название	Тип	Обязательный	Описание
`access_token`	string	да	Ключ сессии аутентификации
`user_id`	number	нет	Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агента Для получения списка пользователей клиента необходимо использовать метод "get.customer_users"
`limit`	number	нет	Количество возвращаемых записей. См. раздел "Постраничный вывод"
`offset`	number	нет	Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод"
`filter`	object	нет	См. раздел "Критерии фильтрации"
`fields`	array	нет	См. раздел "Представление возвращаемых данных"
`sort`	array	нет	См. раздел "Сортировка данных"

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

Название	Тип	Допустимые значения	Фильтрация	Сортировка	Описание
`id`	number		да		Уникальный идентификатор графика активности
`name`	string		да	да	Название графика активности
Расписания работы
`schedules`	array		да		Расписания работы
`activity_days`	object				Дни в которые график активен
`type`	enum	days_of_week days_of_month business_calendar cycle			Тип. days_of_week - Календарь по дням недели days_of_month - Календарь по дням месяца business_calendar - Производственный календарь cycle - Циклический календарь
`days`	array	Если `"type" = "days_of_week"`: 1 - понедельник; 2 - вторник; 3 - среда; 4 - четверг; 5 - пятница; 6 - суббота 0 - воскресенье; 8 - выходной; 7 - рабочий; Если `"type" = "days_of_month"`: числа от 1 до 31 Если `"type" = "cycle"`: Количество рабочих дней в цикле; Количество нерабочих дней в цикле; Если `"type" = "business_calendar"`: 8 - выходной; 7 - рабочий;			Дни недели или месяца Пример циклического календаря: `[2,2]` - в цикле будет два рабочих, а затем два нерабочих дня. В итоге график получается два через два. Пример производственного календаря: `[7]` - Календарь будет активен по рабочим дням согласно производственного календаря; `[8]` - Календарь будет активен по выходным дням согласно производственного календаря
Время активности графика
`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			Дата окончания активности графика

JSON структура запроса

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "method":"get.schedules",
 "params":{
  "access_token":"string",
  "user_id":"number",
  "offset":"number",
  "limit":"number",
  "filter":{

  },
  "sort":[
   {
    "field":"string",
    "order":"string"
   }
  ],
  "fields":[
   "string"
  ]
 }
}

JSON структура ответа

Копировать

{
 "jsonrpc":"2.0",
 "id":"number",
 "result":{
  "metadata":{

  },
  "data":[
   {
    "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"
     }
    ]
   }
  ]
 }
}

Список возвращаемых ошибок

Смотрим раздел "Список ошибок для методов с глаголом get"

Оборудование

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

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

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

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

JSON структура запроса

JSON структура ответа

Список возвращаемых ошибок