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

В данный момент метод перерабатывается, возможны изменения

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

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

{

  "page": <int>,

  "size": <int>,

  "filter": {

    "profile": <string>,

    "msu_block": <bool>,

    "blocked": <bool>,

    "company": <array of string>

  },

  "sort": <object>

}

Параметры

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

Параметр "filter"

Задает фильтрацию списка сим. Объект имеет следующие значения:

Параметр	Тип	Описание	Допустимые значения	Обязательность
profile	string	Фильтр по столбцу "Профиль"	"tc", "td"	Нет
msu_block	bool	Отобразить только заблокированные по MSU		Нет
blocked	bool	Фильтр по блокировке	true - отобразить только заблокированные false - отобразить только разблокированные	Нет
company	array	Массив компаний	"my", "all", идентификаторы компаний	Нет

Параметр "sort"

В объект передается ключ столбца, по которому идет сортировка, в значение - направление:

• ASC - по возрастанию
• DESC - по убыванию

Результат

Положительный результат выглядит следующим образом:

{

  "code": 200, //Код успешной операции

  "count": <int>, //Количество элементов в результате

  "all_count": <int>, //Общее количество элементов в БД

  "items": [  

  {

      "id": <int>, //IDИдентификатор сим-карты

        "iccid": <string>, //ICCID сим-карты

    "number": <string>, //НОсновной номер телефона сим-карты

    "external_number": <string>, //Дополнительный номер сим-картелефонаы

    "name": <string | null>, //Название сим-карты

      "blocked": <bool>, //Флаг блокировки

    "balance": <float>, //Баланс сим-карты

    "currency": <string>, //Валюта баланса

      "limit_type"msu_value": <stringint | null>, //Количество MSU

  "profile": <string>, //Профиль

  "block": <string>, //Тип блокировки

  "comment": <string | null>, //Комментарий системы

  "groups": [],

  "limit": {

      "type": <string>, //Тип лимита

          "limit_value"value": <int | null>, //ОгрУстаниовленное значение лимита

          "limit_date"used": <int | null>, //Использованный лимит

      "updated": <int | null>, //Дата обновления поля used

      "created": <int | null> //Дата установки лимита

  },

  "limit_value_used"tariff": {

      "id": <int|null>, //КолИдентичество использованного лимита

      "msu_lock": <bool>, //Флаг блокировки по MSU

      "msu_value": <int | null>, //Количество MSU

      "profile": <string>, //Профиль сим-каторты

      "tariff_plan_change_lock": <bool | null>, //Флаг блокировки смены тарифа

      "tp_id": <int | null>, //ID тарифного плана

          "tp_name"name": <string | null>, //Название тарифного плана

      "change_lock": <int | null>, //Дата снятия блокировки на смену ТП

 "package_auto": <bool>, //Флаг автоматического продключения пакета при истечении

      "limit": <string>, //Текстовое описание лимита}

    "network": <int>, //Статус сим-карты}

      "danger": <int>, //Флаг предупреждений для сим-карты

      "comment": <string>, //Текстовое описание предупреждений для сим

      "groups": <array> //Массив идентификаторов групп

    }

],

  "allow_operations": { //Доступные операции

    "block": <bool>, //Блокировка

    "unblock": <bool>, //Разблокировка

    "disconnect": <bool>, //Сброс регистрации в сети (Cancel Location)

    "reconnect": <bool>, //Мягкая перезагрузка (POD)

    "ping": <bool>, //Пинг через СМС

    "sms": <bool>, //Отправка СМС

    "balance": <bool>, //Изменение баланса

    "edit": <bool>, //Редактирование название

    "limit": <bool>, //Установка лимита

    "tariff": <bool>, //Изменение тарифного плана

    "repackage": <bool>, //Переподключение пакета

 "dealer": <bool>, //Возможность передачи сим другой компании

    "group": <bool> //Изменение групп

  },

  "message": <string> //Сообщение о результате

}