Интеграция со СБИС

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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