Список сим-карт

Для получения списка сим-карт используется метод sim/list:

POST https://api.novaconnect.kz/api/sim/list

{
  "page": <int>,
  "size": <int>,
  "filter": {
    "profile": <string>,
    "msu_block": <bool>,
    "blocked": <bool>,
    "query": <string>
  },
  "sort": <object>
}

Параметры

Параметр	Тип	Описание	Обязательность
page	int	Страница (нумерация с 0)	Нет
size	int	Размер страницы	Нет
filter	object	Объект фильтра	Нет
sort	object	Объект сортировки	Нет

Фильтр

Параметр	Тип	Описание	Обязательность
profile	string	Код профиля сим-карты	Нет
msu_block	bool	Блокировка по MSU	Нет
blocked	bool	Блокировка	Нет
query	string	Поисковый запрос	Нет

Фильтр query принимает на вход поисковый запрос, подробнее см. Фильтрация информации -> Универсальное поле поиска
Фильтр profile принимает на вход код профиля: TD для сим профиля TD, TC для сим профиля TC;
Фильтр blocked работает по следующей логике:
- при передаче значения false будут получены все записи, у которых значение block = n, то есть разблокированные;
- при передаче значения true будут получены все записи, у которых значение block = u, p, m, g, f, то есть заблокированные по любой причине;

Сортировка

В объект сортировки передается код поля, по которому нужно провести сортировку, в качестве ключа. В качестве значение - направление (ASC - по возрастанию, DESC - по убыванию).

{
    "id": "DESC" //Сортировка по убыванию идентификаторов сим
}

Ограничения и доступы

Метод доступен пользователю с любой ролью

Успешный ответ

{
  "code": 200,
  "message": <string>,
  "count": <int>,
  "all_count": <int>,
  "items": [
        //Объекты типа Сим-карта
  ]
}

Параметр	Тип	Описание
code	int	Код ответа, для успеха - 200
message	string	Сообщение ответа
count	int	Количество элементов в массиве items
all_count	int	Количество элементов в БД
items	array	Массив элементов типа Сим-карта