GetList (справочник)

Метод GetList

Примените метод GetList для получения справочника по характеристикам номеров (тип, категория, регион, и проект). Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/number/reference/v1/GetList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

ИмяТипОписание
AuthorizationstringAPI-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

Входные параметры

Передайте пустой JSON в теле запроса.

ПараметрОписание
{}пустой JSON

Выходные параметры

ПараметрТипОписание
typesNumberTypesсопоставляет наименование типа номера и его идентификатор
categoriesCategoriesсопоставляет имя категории и ее идентификатор, а также принадлежащие к ней тип номера и его идентификатор
regionsRegionsсопоставляет название региона с его идентификатором и кодом

NumberTypes

ПараметрТипОписание
type_iduint32идентификатор типа номера
type_namestringнаименование типа номера

Categories

ПараметрТипОписание
category_iduint32идентификатор категории
type_iduint32идентификатор типа номера
type_namestringнаименование типа номера
category_namestringимя категории

Regions

ПараметрТипОписание
project_iduint32идентификатор проекта
region_iduint32идентификатор региона
parent_region_iduint32идентификатор родительского региона
region_codestringкод региона
region_namestringимя региона (латиница)
descriptionstringимя региона (кириллица)

Возможные ошибки

КодСтатусПример сообщенияОписание
400Bad Requestproto: syntax error (line 1:2): unexpected tokenнекорректный формат запроса
400Bad Requestproto: syntax error (line 1:2): invalid valueневалидный запрос

Примеры

Входные параметры:

{}

Выходные параметры:


{
    "regions": [
        {
            "project_id": 10008,
            "region_id": 10257,
            "parent_region_id": 10084,
            "region_code": "SLH",
            "region_name": "Salekhard",
            "description": "Салехард"
        }
     ],
    "types": [
        {
            "type_id": 1104,
            "type_name": "DEF"
        }
     ],
    "categories": [
        {
            "category_id": 10003,
            "type_id": 1107,
            "type_name": "CEN",
            "category_name": "REGULAR"
        }
    ]
}