Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Authorization - для передачи токена. Передается в формате: Bearer <access_token>.

Доп. Параметры запроса:

ИмяТипЗначение по умолчаниюОписание
page[offset]int0Пропустить несколько первых записей
page[limit]int200Количество объектов в выводе
fields[driverParams]string

Фильтрация полей отображаемых в объектах.

filter[driverParams]string

Фильтрация списка объектов.

sortstring
Сортировка (поддерживается только для полей Driver и Id)
includestring
Добавить связанные объекты в ответ.
with_defaultsbool1При отсутствии установленного параметра у объекта отображать значение по умолчанию.

Ответ:

       Ответ присылается в формате JSON API.

ПолеОписание
links

Поле links содержит ссылки на ресурсы.

Минимально он должен содержать ссылку на текущий ресурс (self).

Если Всех Водителей не удалось поместить в одном ответе то также будет содержаться

next - следующая страница (если есть)

prev - предыдущая страница (если есть)

first - первая страница с результатами

last - последняя страница с результатами


metaСодержит total_count - количество водителей у пользователя
data

Содержит массив объектов Параметров Водителей в формате JSON API.

Каждый объект  содержит

ПолеТипОписание
idintИдентификатор  (передаётся как строка для соответствия JSON API)
typestringТип ресурса (всегда "driverIdParams")
attributesobjectДанные объекта (см. Описание атрибутов)
relationshipsobject

Ссылки на связанные объекты



Описание атрибутов:

Список атрибутов соответствует списку параметров объектов с типом "driver" в методе Список параметров объектов .

...