Электронный документооборот

Объект «Навигация» в API

Объект «Навигация» в API

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

  • номер страницы,
  • число записей на странице,
  • флаг варианта информирования о наличии страниц после запрошенной страницы.

Для команды «СБИС.СписокИзменений» используется «упрощенный» вариант объекта «Навигация».

Для всех команд
Для «СБИС.СписокИзменений»

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

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

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

Результат выполнения команды дополняется объектом «Навигация»:

Синие — поля, доступные только для чтения (т.е. в возвращаемых значениях с сервера).

  • ... (результат выполнения — объект, массив объектов)
  • "Навигация": объект:
    • "Страница": строка, указывает номер страницы, с которой осуществлена выборка
    • "ЕстьЕще": строка "Да"/"Нет"
    • "РазмерСписка": строка, содержит общее число записей в выборке

Значение параметра «РазмерСтраницы» находится в диапазоне от 1 до 200. По умолчанию — 25.

Значение параметра «Страница» исчисляется от нуля для самой первой страницы. По умолчанию подразумевается 0.

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

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

Значение параметра «РазмерСтраницы» находится в диапазоне от 1 до 50. По умолчанию — 25.

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

Результат выполнения команды дополняется объектом «Навигация»:

  • ... (результат выполнения — объект, массив объектов)
  • "Навигация": объект:
    • "РазмерСтраницы": строка, указывает число записей на странице, возвращенной в качестве результата
    • "ЕстьЕще": строка "Да"/"Нет"

Пример

Запрос

{
  "jsonrpc": "2.0",
  "method": "СБИС.СписокДокументов",
  "params": {
    "Фильтр": {
       "Тип": "ДокОтгрИсх",
       "Навигация": {
       "РазмерСтраницы": 25,
       "Страница": 1
     }
     }
   },
   "id": 0
}

Ответ

{
  "jsonrpc": "2.0",
  "result": {
    "Документ": [
      {
        "Вложение": [
          {
            "ВерсияФормата": "5.01",
            "Дата": "02.11.2021",
            "Зашифрован": "Нет",
            "Идентификатор": "fa9f16c6-3dd8-4a07-b216-836c9d03fb01",
            "КоличествоОшибок": "0",
            "Название": "Фактура 02.11.21 № 02112400000269 на сумму 0 р., в т.ч. НДС 0 р.",
            "Направление": "Исходящий",
            "Номер": "02112400000269",
            "ПодверсияФормата": "",
            "Подтип": "1115131",
            "Редакция": {
              "ДатаВремя": "02.11.2021 13.44.25",
              "Номер": "1"
            },
            "Служебный": "Нет",
            "СсылкаВКабинет": "
https://fix-online.sbis.ru/opendoc.html?guid=b97dc2c0-6408-4c4d-abfb-5f1fa8a5425f&org=127&f3=127&file=fa9f16c6-3dd8-4a07-b216-836c9d03fb01&ver=1",

            "СсылкаНаHTML": "
https://fix-online.sbis.ru/service/?method=%D0%A4%D0%AD%D0%94.DisplayInHTML&params=eyLQmNC00J4iOiI5NzA3NzMiLCLQmNC80Y%2FQntCx0YrQtdC60YLQsCI6ItCU0L7QutGD0LzQ%0AtdC90YIiLCLQn9GA0LXQtNGB0YLQsNCy0LvQtdC90LjQtSI6ItCf0YDQvtGB0LzQvtGC0YAs%0A0J%2FQtdGH0LDRgtGMIiwi0JjQvNGP0JzQtdGC0L7QtNCwIjoi0JLQvdC10YjQvdC40LnQlNC%2B%0A0LrRg9C80LXQvdGCLlJlYWRTdGFtcEluZm8iLCLQn9Cw0YDQsNC80LXRgtGA0YvQnNC10YLQ%0AvtC00LAiOnsiZCI6WyI5NzA3NzMiXSwicyI6W3sibiI6ItCY0LTQniIsInQiOiLQodGC0YDQ%0AvtC60LAifV0sIl90eXBlIjoicmVjb3JkIn0sItCf0LDRgNCw0LzQtdGC0YDRiyI6eyJkIjpb%0AdHJ1ZSwi0JLQvdC10YjQvdC40LnQlNC%2B0LrRg9C80LXQvdGCLlJlYWRTdGFtcEluZm8iLHsi%0AZCI6WyI5NzA3NzMiXSwicyI6W3sibiI6ItCY0LTQniIsInQiOiLQodGC0YDQvtC60LAifV0s%0AIl90eXBlIjoicmVjb3JkIn1dLCJzIjpbeyJuIjoi0J3QvtGA0LzQsNC70LjQt9C%2B0LLQsNGC%0A0YwiLCJ0Ijoi0JvQvtCz0LjRh9C10YHQutC%2B0LUifSx7Im4iOiLQmNC80Y%2FQnNC10YLQvtC0%0A0LAiLCJ0Ijoi0KHRgtGA0L7QutCwIn0seyJuIjoi0J%2FQsNGA0LDQvNC10YLRgNGL0JzQtdGC%0A0L7QtNCwIiwidCI6ItCX0LDQv9C40YHRjCJ9XSwiX3R5cGUiOiJyZWNvcmQifX0%3D&protocol=3&id=0&srv=1",

            "СсылкаНаPDF": "
https://fix-online.sbis.ru/pdfservicepublic/service/?method=%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81PDF.%D0%A1%D0%B8%D0%BD%D1%85%D1%80%D0%BE%D0%BD%D0%BD%D0%B0%D1%8F%D0%9F%D0%B5%D1%87%D0%B0%D1%82%D1%8C&params=eyJEb2N1bWVudHMiOnsicyI6W3sibiI6ItCY0LTQniIsInQiOiLQp9C40YHQu9C%2BINGG0LXQ%0Au9C%2B0LUifSx7Im4iOiLQoNCw0LfQtNC10LsiLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1%0AIn0seyJ0Ijp7Im4iOiLQnNCw0YHRgdC40LIiLCJ0Ijoi0KLQtdC60YHRgiJ9LCJuIjoi0KHQ%0Av9C40YHQvtC60JLQktCUIn1dLCJkIjpbWzIzNDQwMixudWxsLFs5NzA3NzNdXV19LCJPYmpl%0AY3ROYW1lIjoiRG9jUHJpbnQiLCJNZXRob2ROYW1lIjoiTWFzc0xpc3QiLCJQYXJhbXMiOnsi%0AcyI6W3sibiI6Ik91dHB1dEZpbGVOYW1lIiwidCI6ItCh0YLRgNC%2B0LrQsCJ9LHsibiI6IlJl%0AcUlkIiwidCI6ItCh0YLRgNC%2B0LrQsCJ9LHsibiI6IlVuc3VwcG9ydGVkRmlsZUluZm8iLCJ0%0AIjoi0JvQvtCz0LjRh9C10YHQutC%2B0LUifV0sImQiOlsiT05fTlNDSEZET1BQUl8yQkU5NDdm%0AMWRhYWFlZjYxMWUxOGY4MmJiMjhkODcxNTg1Zl8yQkVkZWI5Mjg2N2VlMWY0ZjI1ODgwYmY2%0AYzI1Njc5NDk5YV8yMDIxMTEwMl9kOTMyYTFiNC0zYmM5LTExZWMtODI4NC0wMDUwNTZhMDMx%0AMmQucGRmIiwiODYxMjYxMjk4NzM1NTg0Mzg2OSIsZmFsc2VdfX0%3D&protocol=3&id=0&srv=1",

            "Сумма": "0.00",
            "СуммаБезНДС": "",
            "Тип": "СчФктр",
            "ТипШифрования": "Отсутствует",
            "Удален": "Нет",
            "Упакован": "Нет",
            "Файл": {
              "Имя": "ON_NSCHFDOPPR_2BE947f1daaaef611e18f82bb28d871585f_2BEdeb92867ee1f4f25880bf6c25679499a_20211102_d932a1b4-3bc9-11ec-8284-005056a0312d.xml",
              "Ссылка": "
https://fix-disk.sbis.ru/disk/api/v1/6729b4ed-ad84-4e94-a69f-0cb735854154_6abe9825-e6c2-464b-b36c-cbaa0347714d?object=simple_file_sd&uuid=a452ce88-b89a-4a9b-bf09-69d1fe3142f5&diskhmac=I572ivfHsMmYQgGkGni9bb9X%2F88%3D",

              "Хеш": ""
            }
          }
        ],
        "Дата": "02.11.2021",
        "ДатаВремяСоздания": "02.11.2021 13.41.34",
        "Идентификатор": "46452369-78e8-4035-a6b1-8e6dd0b2f0e7",
        "ИдентификаторСеанса": "3487a78a1f4e430b96c72a4e8c823d62",
        "Контрагент": {
          "Email": "",
          "ИдентификаторИС": "",
          "ИдентификаторСПП": "",
          "Описание": "",
          "СвЮЛ": {
            "АдресЮридический": "г.Псков, ул.Яна Фабрициуса, д.14, к.1, 180004",
            "ИНН": "6000000114",
            "КПП": "600101002",
            "КодСтраны": "643",
            "КодФилиала": "2",
            "Название": "покупательфикс"
          },
          "Телефон": ""
        },
        "Название": "Реализация № 02112400000269 от 02.11.2021 на сумму 0.00",
        "Направление": "Исходящий",
        "НашаОрганизация": {
          "ИдентификаторИС": "",
          "ИдентификаторСПП": "64008981",
          "ПодписаниеОграничено": "Да",
          "СвЮЛ": {
            "АдресЮридический": "",
            "ИНН": "6000000001",
            "КПП": "770501001",
            "КодСтраны": "643",
            "Название": "ПоставщикФикс(6000000001/770501001)1"
          }
        },
        "Номер": "02112400000269",
        "Ответственный": {
          "Идентификатор": "799979997",
          "Имя": "Юрий",
          "Отчество": "Владмирович",
          "Фамилия": "Шепитонов"
        },
        "Подтип": "",
        "Примечание": "",
        "Расширение": {
          "ЗакрытОтИзменений": "Нет",
          "ОтметкаПлюсом": "Нет"
        },
        "Регламент": {
          "Идентификатор": "8861254e-4354-11e1-9d64-005056a63fed",
          "Название": "Реализация"
        },
        "Редакция": [
          {
            "Актуален": "Да",
            "ДатаВремя": "02.11.2021 13.41.34",
            "Идентификатор": "0c1e69a1-e32d-40c4-bf7d-e7ad550a4dac",
            "ПримечаниеИС": ""
          }
        ],
        "Состояние": {
          "Код": "4",
          "Название": "Доставлен",
          "НеполнаяОбработка": "Нет",
          "Описание": "Ожидается утверждение",
          "Примечание": "",
          "Сложное": "Нет"
        },
        "Срок": "",
        "СсылкаДляКонтрагент": "
https://fix-online.sbis.ru/svrd/v2/inc_pack/3487a78a-1f4e-430b-96c7-2a4e8c823d62",

        "СсылкаДляНашаОрганизация": "
https://fix-online.sbis.ru/opendoc.html?guid=b97dc2c0-6408-4c4d-abfb-5f1fa8a5425f&org=127&f3=127",

        "СсылкаНаPDF": "
https://fix-online.sbis.ru/pdfservicepublic/service/?method=%D0%A1%D0%B5%D1%80%D0%B2%D0%B8%D1%81PDF.%D0%A1%D0%B8%D0%BD%D1%85%D1%80%D0%BE%D0%BD%D0%BD%D0%B0%D1%8F%D0%9F%D0%B5%D1%87%D0%B0%D1%82%D1%8C&params=eyJEb2N1bWVudHMiOnsicyI6W3sibiI6ItCY0LTQniIsInQiOiLQp9C40YHQu9C%2BINGG0LXQ%0Au9C%2B0LUifSx7Im4iOiLQoNCw0LfQtNC10LsiLCJ0Ijoi0KfQuNGB0LvQviDRhtC10LvQvtC1%0AIn1dLCJkIjpbWzIzNDQwMixudWxsXV19LCJPYmplY3ROYW1lIjoiRG9jUHJpbnQiLCJNZXRo%0Ab2ROYW1lIjoiTWFzc0xpc3QiLCJQYXJhbXMiOnsicyI6W3sibiI6IlJlcUlkIiwidCI6ItCh%0A0YLRgNC%2B0LrQsCJ9XSwiZCI6WyIxMTEwOTQzMTA4MDY0Njc2NzgxNiJdfX0%3D&protocol=3&id=0&srv=1",

        "СсылкаНаАрхив": "
https://fix-online.sbis.ru/service/?method=%D0%94%D0%BE%D0%BA%D0%9E%D1%82%D0%B3%D1%80%D0%98%D1%81%D1%85.%D0%A1%D0%BE%D1%85%D1%80%D0%B0%D0%BD%D0%B8%D1%82%D1%8C%D0%9D%D0%B0%D0%94%D0%B8%D1%81%D0%BA%D0%A0%D0%B5%D0%B4%D0%B0%D0%BA%D1%86%D0%B8%D1%8E&params=eyLQmNC00J4iOiIyMzQ0MDIifQ%3D%3D&protocol=3&id=0&srv=1",

        "Сумма": "0.00",
        "Тип": "ДокОтгрИсх",
        "Удален": "Нет"
      }
    ],
    "Навигация": {
      "ЕстьЕще": "Да",
      "РазмерСтраницы": "25",
      "Страница": "1"
    }
  },
  "id": 0
}
Нашли неточность? Выделите текст с ошибкой и нажмите ctrl + enter.