Получение каналов источников

Метод	`get.sources_channels`
Описание	Получение каналов источников
Кому доступен	Агент, Клиент
Необходимые компоненты для работы с методом	Data API для настройки
Вес метода	1 балл

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

Название	Тип	Обязательный	Описание
`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		да	да	да	Название канала источника
`mnemonic`	string		да	да	да	Мнемоника канала источника
`is_custom`	boolean		да	да	да	Создан ли канал пользователем клиента
`state`	enum	`active` Канал активен `off` Канал отключен `removed` Канал удален	да	да	да	Статус источника источника
`default_source_id`	number		да	да	да	Дефолтный идентификатор источника в канале. Метод получение списка существующих Источников: "get.sources"

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

Копировать

{
  "jsonrpc":"2.0",
  "id":"number",
  "method":"get.sources_channels",
  "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",
      "mnemonic": "string",
      "is_custom": "boolean"
      }
    ]
  }
}

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

Копировать

{
  "jsonrpc": "2.0",
  "id": "HXw4IeLYAfblv6FRkzRNd",
  "result": {
    "data": [
      {
        "id": -1,
        "name": "Контекстная реклама",
        "mnemonic": "context",
        "is_custom": false
      }
    ],
    "metadata": {
      "total_items": 1,
      "version": null,
      "limits": {}
    }
  }
}

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

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