Интеграция с информационной системой

СБИС.СписокСлужебныхЭтапов

СБИС.СписокСлужебныхЭтапов

Команда СБИС.СписокСлужебныхЭтапов возвращает список служебных этапов, требующих обязательной обработки (например, подписание извещений о получении документа).

Внимание!

Чтобы пользователь мог обработать список служебных этапов, полученный в результате запроса, доступ к этому списку для остальных пользователей блокируется на 60 секунд (привязка происходит по идентификатору сессии). По истечении 1 минуты блокировка снимается. Если за этот период времени, пользователь не успел обработать полученный список, запрос необходимо повторить.

Адрес для выполнения запроса: https://online.sbis.ru/service/?srv=1

Параметры строки запроса

  • "Фильтр": объект:
    • "НашаОрганизация": объект
      • "СвЮЛ": объект
        • "ИНН": строка, 10 символов
        • "КПП": строка, 9 символов
        • "КодФилиала": строка, не обязательно
      • "СвФЛ": объект
        • "ИНН": строка, 12 символов
    • "ИдентификаторДокумента": строка, запрос событий по последней редакции документа
    • "ИдентификаторРедакции": строка, запрос событий по конкретной редакции документа
    • "Блокировать": строка "Да"/"Нет" (при отсутствии подразумевается "Да") — блокировать на одну минуту возвращенные события, от возможности обработки другими пользователями.
    • "Навигация": объект
      • "РазмерСтраницы": целое число от 1 до 20 в виде строки, задаёт число возвращаемых записей

Результат запроса

  • "Документ": массив объектов, служебные события по которым необходимо обработать:
    • "Идентификатор": строка
    • "Направление": строка
    • "НашаОрганизация": объект:
      • ...
    • "Контрагент": объект:
      • ...
    • "Подразделение": объект:
      • ...
    • "Ответственный": объект:
      • ...
    • "Этап": массив объектов:
      • "Название": строка
      • "Идентификатор": строка
      • "Служебный": строка "Да"/"Нет"
      • "Действие": массив объектов:
        • "Название": строка
        • "ТребуетПодписания": строка "Да"/"Нет"
        • "ТребуетКомментария": строка "Да"/"Нет"
        • "Сертификат": массив объектов:
          • "ФИО": строка
          • "Должность": строка
          • "ИНН": строка
          • "Название": строка
          • "Отпечаток": строка
          • "СерийныйНомер": строка
          • "Квалифицированный": строка "Да"/"Нет"
          • "Ключ": объект:
            • "Активирован": строка "Да"/"Нет"
            • "СпособАктивации": строка
            • "Тип": строка
    • "Навигация": объект:
      • "РазмерСтраницы": строка (число целое, указывает размер запрошенной выборки).

Внимание!

Результат запроса существенно зависит от заполнения полей "НашаОрганизация.СвЮЛ.КодФилиала".

Комментарий

  • Категорически не рекомендуется исключать параметр "Фильтр.НашаОрганизация".
  • При указании "Да" в "Фильтр.Блокировать" служебные этапы, возвращенные в ответе, блокируются от обработки другими пользователями на 60 секунд (привязка происходит по идентификатору сессии). По истечении одной минуты блокировака снимается.
  • При указании "ИдентификаторДокумента" или "ИденитифкаторРедакции" блокировки служебынх этапов, выданные другим пользователям не учитываются.
  • Результат запроса существенно зависит от заполнения полей "НашаОрганизация.СвЮЛ.КодФилиала".

Настройки прав доступа

Для выполнения команды СБИС.СписокСлужебныхЭтапов у пользователя внешнего API-интерфейса в кабинете СБИС должны быть настроены права на изменение документов (уровень доступа «Полный» или «Администрирование»).

Если у пользователя настроены права только на «Просмотр», то в результате вызова метода СБИС.СписокСлужебныхЭтапов будет возвращено пустое значение, даже при наличии необработанных служебных этапов.

Примеры запросов

Запрос поиска событий по конкретной «нашей организации».

Запрос списка событий по конкретной «нашей организации» с указанием числа возвращаемых значений.

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

Ответ с пустым списком служебных событий.

Ответ с возвратом одного необработанного служебного этапа.