Управление графиками активности

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

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

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
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
Тип. По дням недели или по числам месяца.
days array Если "type" = "days_of_week":
  • 1 - понедельник;
  • 2 - вторник;
  • 3 - среда;
  • 4 - четверг;
  • 5 - пятница;
  • 6 - суббота
  • 0 - воскресенье;
  • 8 - выходной;
  • 7 - рабочий;
Если "type" = "days_of_month":
  • числа от 1 до 31
Дни недели или месяца
Время активности графика
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"

Создание графика активности

Метод create.schedules
Описание Создание графика активности
Кому доступен Партнёр, Клиент

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

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

Удаление графика активности

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

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор графика активности
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"delete.schedules",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number"
  }
}

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

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

  }
}

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

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

Редактирование графика активности

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

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

Название Тип Обязательный Описание
access_token string да Ключ сессии аутентификации
id number да Уникальный идентификатор графика активности
user_id number нет Уникальный идентификатор пользователя клиента агента от имени которого делается запрос
Является обязательным для агента
name string да Название графика активности

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

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"update.schedules",
  "params":{
    "access_token":"string",
    "id":"number",
    "user_id":"number",
    "name":"string"
  }
}

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

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

  }
}

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

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

Нам интересно ваше мнение о CoMagic.
Пожалуйста, оставьте контакты для связи с менеджером
ФИО*:
E-mail*:
Телефон*:
* - Обязательные для заполнения поля