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

СБИС.СписокИзменений

СБИС.СписокИзменений

Команда СБИС.СписокИзменений возвращает список документов, по которым произошли события документооборота за указанный период времени.

В качестве параметров фильтра указывается период времени, тип документа, реквизиты «нашей организации», идентификатор последнего обработанного события (из прежнего запроса) и другие.

Результат запроса представляет массив объектов, за форматирование которых отвечает параметр «Навигация».

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

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

  • "Фильтр": объект:
    • "ИдентификаторСобытия": строка
    • "ДатаВремяС": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
    • "ДатаВремяПо": строка в формате "ДД.ММ.ГГГГ ЧЧ.ММ.СС"
    • "Тип": строка, тип документа
    • "НашаОрганизация": объект:
    • "ПолныйСертификатЭП": строка "Да"/"Нет":

    • "Навигация": объект:
      • "РазмерСтраницы": строка, задает число записей, которые будут возвращены

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

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

Порядок работы с командой

  1. Передать сохраненный идентификатор последнего обработанного события, получить список событий за интересующий период и/или для «нашей организации;
  2. Обработать полученный список. Если он пуст, приостановить запросы на 1-5 минут;
  3. Сохранить идентификатор и дату/время последнего обработанного события;
  4. Повторить с шага 1.

Правила работы со списком событий

  • При первом запросе идентификатор события указывать не обязательно.
  • Если фильтр «Наша организация» не указан, в результате запроса возвращаются события для всех организаций кабинета.
  • При отсутствии параметра:
    • «ДатаВремяС» дата и время берется с самого первого зарегистрированного в системе события.
    • «ДатаВремяПо» берется текущая дата и время запроса на сервере.
  • Входящий документ следует определять и фиксировать в своей информационной системе при получении события с названием «Получение».
  • В случае, когда событие с переданным идентификатором отсутствует (например, из-за удаления документа), будет возвращена ошибка входных параметров (код 00000000-0000-0000-0000-1FA000010000) — необходимо повторить запрос с указанием сохраненной даты/времени последнего обработанного события.

Комментарий

  • Для унификации форматов данных каждое изменение (событие) возвращается внутри объекта «Документ» («Документ.Событие»), к которому относится.
  • Когда в документе происходят изменения, могут появляться новые вложения и/или подписи под ними. Новые вложения, связанные с событием документооборота, передаются как «Документ.Событие.Вложение», новые подписи — «Документ.Событие.Вложение.Подпись».
  • Если в результате изменения к вложению документа добавлена только подпись, то поле «Файл.Ссылка» у «Документ.Вложение.Файл.Ссылка» будет пустым. Скачивание подписи выполняется по «Документ.Событие.Вложение.Подпись.Файл.Ссылка».
  • Для переданного во входных параметрах значения поля «ИдентификаторСобытия» определяется дата/время события (берется в качестве параметра фильтрации «ДатаВремяС»). При наличии «ДатаВремяС» выбирается наиболее «старое».

  • Документы-черновики, которые не участвовали в документообороте, в вывод метода не попадают.
  • Результат запроса существенно зависит от поля «НашаОрганизация.СвЮЛ.КодФилиала».
  • Запрещается пользоваться командой «СБИС.ПрочитатьДокумент» для получения расширенной информации о документе или событии, так как вся необходимая информация передается в результате вызова объекта «Документ».
  • Чтобы ускорить работу списочных методов в 2-10 раз, в запросе фильтра используется необязательный параметр «ПолныйСертификатЭП» со значением «Нет».
  • Если отправитель и получатель документа работают в одном аккаунте, то при использовании поля «Фильтр.ИдентификаторСобытия» в запрос обязательно необходимо передавать «Фильтр.НашаОрганизация», который получен из предыдущего запроса. Иначе, возможен пропуск событий или зацикливание при получении списка событий.

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

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

Пример запроса с указанием фильтра

Пример запроса с указанием фильтра

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