Присоединяйтесь!
  1. Saby
  2. База знаний
  3. Электронный документооборот
  4. API ЭДО
  5. Справочник команд
  6. Работа с документами
  7. СБИС.ПрочитатьДокумент

СБИС.ПрочитатьДокумент

СБИС.ПрочитатьДокумент

Метод «СБИС.ПрочитатьДокумент» возвращает последнюю редакцию документа с заданным идентификатором документа или редакции.

Адрес запроса: https://online.sbis.ru/service/?srv=1

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

* — обязательный параметр.

"Документ": объект:

  • "Идентификатор"*: строка, идентификатор обрабатываемого документа
  • "ДопПоля": строка, позволяет получить информацию из дополнительных полей документа
  • "Редакция": объект:
    • "Идентификатор"*: строка, идентификатор обрабатываемой редакции документа

Результат

"Документ": объект

Комментарий

  1. Объект «Документ» в ответе от сервера будет содержать:
    • текущее состояние документа (последнюю редакцию) — при определении по «Документ.Идентификатор»;
    • состояние редакции — при определении по «Документ.Редакция.Идентификатор».
  2. Возможные значения параметра «ДопПоля»:
    • «Расширение» — отследить состояние обработки документа с маркированным товаром в ГИС МТ. В результате вернутся объекты «СостояниеМарк» и «СостояниеГосСистемы».

      Оба объекта содержат параметры «КодОперации», «Операция», «КодСостоянияОперации» и «СостояниеОперации». Возможные значения

      Объект «СостояниеГосСистемы» также содержит параметры «Фиксация в ГИС МТ», «Отмена фиксации в ГИС МТ» и «Регистрация в ГИС МТ УПД с кодом итога 3».

    • «Расширение,Период» — получить период действия акта для типов документов «АктСверИсх» и «АктСверВх». В результате вернутся параметры «КонецПериода» и «НачалоПериода».
  3. В документе с многостраничным вложением данные по ссылке в параметре «Документ.Вложение.Файл.Ссылка» будут содержать zip-архив. В него входят:
    • файлы страниц. Имена файлов сохраняются в архиве без изменений. При совпадении имен файлов к ним добавляется «(1)», «(2)» и так далее;
    • файл description.xml с описанием вложения. Он задает порядок нумерации страниц. Пример
  4. При чтении ссылки в параметре «Документ.Вложение.Подпись.Файл.Ссылка» возвращается zip-архив с подписями под страницами вложения. Архив содержит только файлы подписей. Порядок формирования имени подписи:
    • берется имя файла подписанной страницы;
    • если это не единственная подпись под файлом, добавляется номер подписи. Нумерация начинается с 1;
    • добавляется расширение *.sgn. Например, для архива страниц, который указан выше, в архиве подписей могли быть файлы: page1.jpg.sgn, page1.jpg.2.sgn, page1.jpg.3.sgn, page1(1).jpg.sgn, page2.jpg.sgn.
  5. Ссылки на вложения и электронные подписи, которые возвращаются методом, действительны один месяц. Затем попытка получить файл по ссылке приведет к ошибке HTTP 403 Forbidden.
  6. При вызове команды «СБИС.ПрочитатьДокумент» обрабатывается большой объем данных. Если количество вложений, событий или подписей в документе перегружает ресурсы Saby, может включиться ограничение на получение данных. В этом случае в ответе метода вернется поле «ЧастичныеДанные» со значением «Да». Недостающие данные можно получить методом «СБИС.СписокИзменений» с фильтром по документу или по его редакции и с дополнительным полем «СписокПоДокументу».

Примеры

Прочитать документ

Прочитать документ от владельца сертификата в состоянии «Ожидает подписания»

Прочитать документ с маркированным товаром

Получить период акта сверки

Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.
Продолжая пользоваться сайтом, вы даете согласие на обработку персональных данных. Если вы не согласны, покиньте сайт.