Документооборот с контрагентами

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

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

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

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

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

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

Результат

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

Комментарий

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

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

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

{
   "jsonrpc": "2.0",
   "method": "СБИС.СписокСлужебныхЭтапов",
   "params": {
      "Фильтр": {
         "НашаОрганизация": {
            "СвЮЛ": {
               "ИНН": "7654321069",
               "КПП": "760401001"
            }
         }
      }
   },
   "id": 0
}
Скачать пример

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

{
   "jsonrpc": "2.0",
   "method": "СБИС.СписокСлужебныхЭтапов",
   "params": {
      "Фильтр": {
         "НашаОрганизация": {
            "СвЮЛ": {
               "ИНН": "7654321069",
               "КПП": "760401001"
            }
         },
         "Навигация": {
            "РазмерСтраницы": "15"
         }
      }
   },
   "id": 0
}
Скачать пример

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

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

{
   "jsonrpc": "2.0",
   "result": {
      "Документ": [],
      "Навигация": {
         "РазмерСтраницы": "10"
      }
   },
   "id": 0
}
Скачать пример

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

{
   "jsonrpc": "2.0",
   "result": {
      "Документ": [
         {
            "Идентификатор": "a98ff3c0-6315-11e8-95eb-005056b7582b",
            "Контрагент": {
               "ИдентификаторИС": "",
               "СвЮЛ": {
                  "ИНН": "7655432117",
                  "КПП": "760401001",
                  "КодСтраны": "643",
                  "Название": "ЮЛ2"
               }
            },
            "Название": "Реализация",
            "Направление": "Исходящий",
            "НашаОрганизация": {
               "СвЮЛ": {
                  "ИНН": "7654321069",
                  "КПП": "760401001",
                  "КодСтраны": "643",
                  "Название": "ЮЛ1"
               }
            },
            "Ответственный": {
               "Идентификатор": "",
               "Фамилия": "Иванов",
               "Имя": "Иван",
               "Отчество": "Иванович"
            },
            "Регламент": {
               "Идентификатор": "8861254e-4354-11e1-9d64-005056a63fed",
               "Название": "Реализация"
            },
            "Редакция": [
               {
                  "Актуален": "Да",
                  "ДатаВремя": "29.05.2018 10.55.32",
                  "Идентификатор": "7cff8295-7e22-42ed-97c2-fac83f6669e8",
                  "ПримечаниеИС": ""
               }
            ],
            "Тип": "ДокОтгрИсх",
            "Этап": [
               {
                  "Действие": [
                     {
                        "Идентификатор": "",
                        "Комментарий": "",
                        "Название": "Обработать служебное",
                        "ТребуетПодписания": "Да"
                     }
                  ],
                  "Идентификатор": "2d972673-50bf-4958-a67a-c296d593d87d_660015f6-5e05-4d54-8540-1e24a78dcf55",
                  "Название": "Извещение о получении Подтверждения даты получения",
                  "Служебный": "Да"
               }
            ]
         }
      ],
      "Навигация": {
         "РазмерСтраницы": "10"
      }
   },
   "id": 0
}
Скачать пример