Получение списка параметров условий пула
| Метод | get.number_pool_condition_parameters |
|---|---|
| Описание | Получение списка параметров условий пула |
| Кому доступен | Агент, Клиент |
Параметры запроса
| Название | Тип | Обязательный | Допустимые значения | Описание |
|---|---|---|---|---|
access_token |
string | да | Ключ сессии аутентификации | |
user_id |
number | нет | Уникальный идентификатор пользователя клиента агента от имени которого делается запрос Является обязательным для агентаДля получения списка пользователей клиента необходимо использовать метод "get.customer_users" |
|
limit |
number | нет | Количество возвращаемых записей. См. раздел "Постраничный вывод" | |
offset |
number | нет | Сдвиг, определяет с какого номера записи возвращать `"limit"` записей. По умолчанию "0". См. раздел "Постраничный вывод" | |
fields |
array | нет | См. раздел "Представление возвращаемых данных" | |
| Фильтры применяемые в отчете | filter |
object | нет | Допустимо использовать не более 2 уровней вложенности. |
Фильтры применяемые в отчете. Логика построения аналогична "Критерии фильтрации" |
filters |
array | да | Выражение, может содержать в себе как простые фильтры, так и дерево фильтров. Доступный список фильтров для отчета с их возможными значениями см.раздел "Критерии фильтрации" . | |
field |
string | Поле сущности к которой будет применяться фильтрация (список заранее определен для метода) | ||
operator |
enum | Оператор фильтрации. Список всех операторов можно получить в разделе "Операторы фильтрации" | ||
value |
string | Значение для оператора фильтрации. Необязательное поле, если оно отсутствует, то считается пустота. | ||
| Сортировка применяемая в отчете | sort |
array | нет | Сортировка применяемая в отчете. Логика построения аналогична "Сортировка данных" |
Параметры ответа
| Название | Тип | Допустимые значения | Фильтрация | Сортировка | Описание |
|---|---|---|---|---|---|
groups |
array | Массив групп параметров пула | |||
id |
number | Уникальный идентификатор группы параметров пула | |||
name |
string | Название группы параметров пула | |||
parameters |
array | массив параметров пула | |||
id |
number | Уникальный идентификатор параметра пула | |||
name |
string | Название параметра пула | |||
group_id |
number | Уникальный идентификатор группы параметров пула | |||
operator_ids |
array | Массив идентификаторов операторов применимых к параметру | |||
operators |
array | Массив операторов | |||
id |
string | Уникальный идентификатор оператора | |||
name |
string | Название оператора |
JSON структура запроса
{
"jsonrpc":"2.0",
"id":"number",
"method":"get.number_pool_condition_parameters",
"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": [
{
"groups": [
{
"id":"number",
"name":"string"
}
],
"parameters": [
{
"id":"number",
"name":"string",
"group_id":"number",
"operator_ids":[
"string"
]
}
],
"operators": [
{
"id":"string",
"name":"string"
}
]
}
]
}
}
Список возвращаемых ошибок
Смотрим раздел "Список ошибок для методов с глаголом create"