СБИС.СПИСОКСЛУЖЕБНЫХЭТАПОВ

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

Внимание!

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

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

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

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

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

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

Внимание!

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

Комментарий

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

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

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

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

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

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

{
    "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",
            "Контрагент":
            {
                "Email": "",
                "ИдентификаторИС": "",
                "СвЮЛ":
                {
                    "ИНН": "7655432117",
                    "КПП": "760401001",
                    "Название": "ЮЛ2"
                },
                "Телефон": ""
            },
            "Название": "Реализация",
            "Направление": "Исходящий",
            "НашаОрганизация":
            {
                "СвЮЛ":
                {
                    "ИНН": "7654321069",
                    "КПП": "760401001",
                    "Название": "ЮЛ1"
                }
            },
            "Ответственный":
            {
                "Идентификатор": "",
                "Фамилия": "Иванов",
                "Имя": "Иван",
                "Отчество": "Иванович"
            },
            "Регламент":
            {
                "Идентификатор": "8861254e-4354-11e1-9d64-005056a63fed",
                "Название": "Реализация"
            },
            "Редакция": [
            {
                "Актуален": "Да",
                "ДатаВремя": "29.05.2018 10.55.32",
                "Идентификатор": "7cff8295-7e22-42ed-97c2-fac83f6669e8",
                "ПримечаниеИС": ""
            }],
            "Тип": "ДокОтгрИсх",
            "Этап": [
            {
                "Действие": [
                {
                    "Идентификатор": "",
                    "Комментарий": "",
                    "Название": "Обработать служебное",
                    "Сертификат": [
                    {
                        "ДвоичныеДанные": "",
                        "ДействителенПо": "04.06.2019 15.22.29",
                        "ДействителенС": "04.03.2018 15.12.29",
                        "Должность": "Директор",
                        "ИНН": "7654321069",
                        "Издатель": "test-tensor-ca2, ООО 'УЦ ТЕНЗОР', г. Ярославль, 76 Ярославская область, 007604094283, 1067604081710, ca_tensor@tensor.ru, RU, Московский проспект д.12, Удостоверяющий центр",
                        "Квалифицированный": "Да",
                        "Ключ":
                        {
                            "Активирован": "Да",
                            "СпособАктивации": "Активирован",
                            "Тип": "Серверный"
                        },
                        "Название": "ЮЛ1",
                        "Отпечаток": "843E3ADCEFF9A205216B8B99A2D2A5668F95F27E",
                        "СерийныйНомер": "012D6FB75650006B95E811A61FA9EE0EB0",
                        "ФИО": "Иванов Иван Иванович"
                    }],
                    "ТребуетПодписания": "Да"
                }],
                "Идентификатор": "2d972673-50bf-4958-a67a-c296d593d87d_660015f6-5e05-4d54-8540-1e24a78dcf55",
                "Название": "Извещение о получении Подтверждения даты получения",
                "Служебный": "Да"
            }]
        }],
        "Навигация":
        {
            "РазмерСтраницы": "10"
        }
    },
    "id": 0
}
 

Скачать пример

 

0
0
Оставьте свой отзыв:
ОТПРАВИТЬ