RetrieveDomainsIntegralStatus - Получить интегральный статус узла дерева объектов

Общая информация

  1. Команда актуальна, начиная с версии 1.8.

  2. Используется в ЛК для отображения статуса регионов, площадок, каждом из которых соответствует узел в дереве объектов, однозначно идентифицирующийся по домену.

  3. В версии 1.18 данные начали выбираться из БД. Теперь разрешено передавать только один домен и этот параметр является обязательным.

  4. Для запроса порции данных и числа записей используются разные запросы.

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

Параметр Значение Формат значения Расшифровка формата Ссылка

domains

домен, внутри которого искать

String

Обязательно указывать один домен. Точка в начале домена означает Со всеми вложенными.

count

число записей, он же limit.

Integer

0, чтобы запросить только подсчет числа записей.

page

страница (для пагинации)

Integer

Параметр не используется, устарел, оставили только для совместимости API.

startIndex

пропустить N записей с начала, он же offset

Integer

locale

null

String

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

Параметр Значение Формат значения

domains

Список данных по узлам

NbiDomainIntegralStatus

totalSize

Общее число записей, удовлетворяющих условиям фильтрации

int

code

Код ответа

int

detail

Пояснение к ответу

String

Примеры команд и кодов

Код Описание

0

Успешно
Запрос порции данных
      <nbi:RetrieveDomainsIntegralStatus>
         <nbi:domains>.root</nbi:domains>
         <nbi:count>3</nbi:count>
         <nbi:page>0</nbi:page>
         <nbi:startIndex>100</nbi:startIndex>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveDomainsIntegralStatus>
Ответ
      <ns:RetrieveDomainsIntegralStatusResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax229:domains xsi:type="ax229:NbiDomainIntegralStatus">
               <ax229:domainName>8619-00770_Chernomorskiy_Yubileynaya_77a.Sberbank.Severskaya.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax229:domainName>
               <ax229:grayStatusCount>0</ax229:grayStatusCount>
               <ax229:greenStatusCount>2</ax229:greenStatusCount>
               <ax229:orangeStatusCount>0</ax229:orangeStatusCount>
               <ax229:pinkStatusCount>0</ax229:pinkStatusCount>
               <ax229:redStatusCount>0</ax229:redStatusCount>
               <ax229:yellowStatusCount>0</ax229:yellowStatusCount>
            </ax229:domains>
            <ax229:domains xsi:type="ax229:NbiDomainIntegralStatus">
               <ax229:domainName>8619-0766_ul_Lenina_184.Sberbank.Ilskiy.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax229:domainName>
               <ax229:grayStatusCount>0</ax229:grayStatusCount>
               <ax229:greenStatusCount>0</ax229:greenStatusCount>
               <ax229:orangeStatusCount>0</ax229:orangeStatusCount>
               <ax229:pinkStatusCount>0</ax229:pinkStatusCount>
               <ax229:redStatusCount>3</ax229:redStatusCount>
               <ax229:yellowStatusCount>0</ax229:yellowStatusCount>
            </ax229:domains>
            <ax229:domains xsi:type="ax229:NbiDomainIntegralStatus">
               <ax229:domainName>1806-0165_ul_Sovetskaya_2A.Sberbank.Dzhubga.Krasnodarskiy_kray.Krasnodarskiy_filial.Ug.Ap.root</ax229:domainName>
               <ax229:grayStatusCount>0</ax229:grayStatusCount>
               <ax229:greenStatusCount>2</ax229:greenStatusCount>
               <ax229:orangeStatusCount>0</ax229:orangeStatusCount>
               <ax229:pinkStatusCount>0</ax229:pinkStatusCount>
               <ax229:redStatusCount>0</ax229:redStatusCount>
               <ax229:yellowStatusCount>0</ax229:yellowStatusCount>
            </ax229:domains>
            <ax229:totalSize>0</ax229:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusResponse>
Запрос общего числа записей
      <nbi:RetrieveDomainsIntegralStatus>
         <nbi:domains>.root</nbi:domains>
         <nbi:count>0</nbi:count>
         <nbi:page>0</nbi:page>
         <nbi:startIndex>100</nbi:startIndex>
         <nbi:locale>ru_RU</nbi:locale>
      </nbi:RetrieveDomainsIntegralStatus>
Ответ
      <ns:RetrieveDomainsIntegralStatusResponse>
         <ns:return>
            <ax21:code>0</ax21:code>
            <ax21:detail>Success</ax21:detail>
            <ax211:domains xsi:nil="true"/>
            <ax211:totalSize>10996</ax229:totalSize>
         </ns:return>
      </ns:RetrieveDomainsIntegralStatusResponse>

Пример использования

См. также

Вернуться к списку команд
Версия 1.23-2588
Дата публикации 15-07-2022 10:13:12