Метод API для получения обновленных данных в справочнике MNP

Метод предназначен для получения обновленных данных в справочнике MNP.

1. Отправьте запрос в службу технической поддержки support@edna.ru, чтобы подключить сервис.
2. Получите URL-адрес подключения.
3. Отправьте на платформу запрос provideOperatorRequest с номером версии обновления данных MNP.
4. Получите от платформы ответ provideOperatorResponse с информацией об изменениях.

Запрос

Запрос provideOperatorRequest содержит секцию payload с обязательным параметром — fromVersion. Параметр fromVersion — это номер версии обновления, начиная с которой требуются данные MNP.

Пример запроса provideOperatorRequest:

<provideOperatorRequest>
    <header>
        <auth>
            <login>username</login>
            <password>password</password>
        </auth>
    </header>
    <payload>
        <fromVersion>123</fromVersion>
    </payload>
</provideOperatorRequest>

Ответ

В ответ на запрос платформа возвращает пакет provideOperatorResponse. Секция payload содержит результаты:

• статус выполнения запроса;
• данные о мобильных операторах и телефонных номерах.

Параметры ответы

Параметр	Характер	Тип	Описание
code	Обязательный	string	Статус выполнения запроса. Возможные значения: • ok — запрос выполнен; • error-system — сервис недоступен, обратитесь в службу технической поддержки; • error-auth — ошибка авторизации; • error-syntax — неверный синтаксис запроса.
countryList	Обязательный	object	Список стран.

Параметры, входящие в countryList:

Параметр	Характер	Тип	Описание
country	Обязательный	object	Структура с информацией о стране оператора.

Параметры, входящие в country:

Параметр	Характер	Тип	Описание
code	Обязательный	string	Кодовое обозначение страны в базы данных.
name	Необязательный	string	Название страны.
description	Необязательный	string	Описание страны.
operator	Обязательный	object	Структура с данными оператора связи.

Параметры, входящие в operator:

Параметр	Характер	Тип	Описание
code	Обязательный	string	Код оператора в базе данных.
name	Необязательный	string	Название оператора.
description	Необязательный	string	Дополнительная информация об операторе.
standard	Необязательный	string	Стандарт мобильной связи. Пример: gsm.
unitList	Обязательный	object	Список территориальных подразделений оператора.

Параметры, входящие в unitList:

Параметр	Характер	Тип	Описание
unit	Обязательный	object	Структура с данными территориального подразделения оператора.

Параметры, входящие в unit:

Параметр	Характер	Тип	Описание
code	Обязательный	string	Кодовое обозначение подразделения в базе данных.
name	Необязательный	string	Название подразделения (юридического лица). Пример: ОАО «Мобильные ТелеСистемы».
description	Необязательный	string	Дополнительная информация о подразделении.
regionList	Обязательный	object	Список регионов.

Параметры, входящие в regionList:

Параметр	Характер	Тип	Описание
region	Обязательный	object	Структура с данными региона, к которому относится номер абонента.

Параметры, входящие в region:

Параметр	Характер	Тип	Описание
code	Обязательный	string	Кодовое обозначение региона в базе данных.
name	Необязательный	string	Название региона. Пример: Саратовская область.
description	Необязательный	string	Дополнительная информация о регионе.
timeZone	Обязательный	string	Часовой пояс региона. Пример: Europe/Samara.
prefixList	Обязательный	object	Список телефонных номеров, переведенных в территориальное подразделение оператора.

Параметры, входящие в prefixList:

Параметр	Характер	Тип	Описание
prefix	Обязательный	object	Данные телефонного номера.

Параметры, входящие в prefix:

Параметр	Характер	Тип	Описание
code	Обязательный	integer	Уникальный код префикса.
name	Обязательный	string	Название префикса. Обычно совпадает с кодом.
description	Необязательный	string	Дополнительная информация о префиксе.
addressPrefix	Обязательный	string	Значение префикса — начальная часть или полный телефонный номер. Все номера, начинающиеся с этого префикса, относятся к одному оператору и региону. Примеры префиксов: 7981860, 79261234567.
mnp	Обязательный	boolean	Возможные значения: • false — возвращена начальная часть, с которой начинаются несколько номеров; • true — в ответе платформы возвращен полный номер, для которого был изменен оператор.
remove	Обязательный	boolean	Возможные значения: • false — значение префикса актуально; • true — значение префикса устарело и его не следует учитывать.
version	Обязательный	integer	Версия обновления.

Пример пакета provideOperatorResponse:

<provideOperatorResponse>
    <header></header>
    <payload>
        <code>ok</code>
        <countryList>
            <country>
                <code>ru</code>
                <name>Россия</name>
                <description>Россия</description>
                <operatorList>
                    <operator>
                        <code>ru-megafon</code>
                        <name>МегаФон</name>
                        <description>МегаФон</description>
                        <standard>gsm</standard>
                        <unitList>
                            <unit>
                                <code>ru-megafon-megafon_ural</code>
                                <name>ОАО "Мегафон" Уральский филиал</name>
                                <description>ОАО "Мегафон" Уральский филиал</description>
                                <regionList>
                                    <region>
                                        <code>ru-megafon-megafon_ural-sverdlovskaya_oblast</code>
                                        <name>Свердловская область</name>
                                        <description>Свердловская область</description>
                                        <timeZone>Asia/Yekaterinburg</timeZone>
                                        <prefixList>
                                            <prefix>
                                                <code>79122369285</code>
                                                <name>79122369285</name>
                                                <description>mnp</description>
                                                <addressPrefix>79122369285</addressPrefix>
                                                <mnp>true</mnp>
                                                <remove>false</remove>
                                                <version>80419</version>
                                            </prefix>
                                            <prefix>
                                                <code>79122370644</code>
                                                <name>79122370644</name>
                                                <description>mnp</description>
                                                <addressPrefix>79122370644</addressPrefix>
                                                <mnp>true</mnp>
                                                <remove>false</remove>
                                                <version>80421</version>
                                            </prefix>
                                        </prefixList>
                                    </region>
                                </regionList>
                            </unit>
                        </unitList>
                    </operator>
                </operatorList>
            </country>
        </countryList>
    </payload>
</provideOperatorResponse>