Получает публичные пресеты.

Получает массив элементов, содержащих информацию о пресете и тело пресета.

HTTP-запрос

GET https://courier.yandex.ru/api/v1/reference-book/public/presets\
?types={string}\
&number={string}\
&page_token={string}\
&max_results={integer}\
&order_by={string}

Query-параметры

types	string Список типов запрашиваемых пресетов. Допустимые типы - "depot", "location", "options", "vehicle", "vehicle-shift".
number	string Название запрашиваемого пресета.
page_token	string Токен для постраничного получения результата. Может либо отсутствовать, либо быть равным next_page_token из тела предыдущего ответа. При использовании параметра page_token остальные параметры запроса будут проигнорированы.
max_results	integer Максимальное количество сущностей, которое должно быть возвращено.
order_by	string Поле для сортировки пресетов.

* Обязательный параметр

Ответы

Код 200

Пресеты успешно возвращены.

{
  "next_page_token": string,
  "results": [
    {
      "body": {},
      "history": {
        "created_at": string,
        "updated_at": string,
        "updated_by": string
      },
      "id": string,
      "number": string,
      "type": string,
      "x-description-en": string
    }
  ]
}
Скопировано

Представление

Свернуть всё

Развернуть всё

Поля

next_page_token	string Если присутствует, значит есть следующая страница, и данный url может быть вызван с page_token, который равен этому полю, для получения следующей страницы.
results[] *	array
results[].body	object Тело пресета в виде json, схема должна соответствовать типу пресета.
results[].history	object
results[].history.created_at	string Время создания пресета в формате YYYY-MM-DDThh:mm:ssZ.
results[].history.updated_at	string Время обновления пресета в формате YYYY-MM-DDThh:mm:ssZ.
results[].history.updated_by	string Кто произвел последние изменения.
results[].id	string Идентификатор пресета в справочнике.
results[].number	string Номер пресета. Не может начинаться с public_ и содержать символ запятой.
results[].type	string Тип пресета. Возможные значения depot location options vehicle vehicle-shift
results[].x-description-en	string Описание пресета.

* Обязательный параметр

Код 400

Недопустимые параметры были переданы.

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 500

Ошибка сервера при обработке запроса.