Получение списка условий работы

  1. HTTP-запрос
  2. Query-параметры
  3. Заголовки запроса
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
      1. Представление
      2. Поля
    3. Код 403
      1. Представление
      2. Поля
    4. Код 429
      1. Представление
      2. Поля
    5. Код 500
      1. Представление
      2. Поля
  5. Пример

Получение списка условий работы

HTTP-запрос

GET https://fleet-api.taxi.yandex.net/v1/parks/driver-work-rules?park_id={string}

Query-параметры

park_id *

string

Идентификатор партнера

park_id *

string

Идентификатор партнера

Заголовки запроса

X-Client-ID *

string

Идентификатор клиента

X-API-Key *

string

API-ключ

Accept-Language *

string

Предпочитаемый язык ответа

X-Client-ID *

string

Идентификатор клиента

X-API-Key *

string

API-ключ

Accept-Language *

string

Предпочитаемый язык ответа

Ответы

Код 200

Список условий работы

{
  "rules": [
    {
      "id": "06640a5568bf4c238324d34fd1769a64",
      "is_enabled": true,
      "name": "Штатный"
    }
  ]
}
Скопировано

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

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

Поля

rules[] *

array

rules[].id *

string

Идентификатор условия работы

rules[].is_enabled *

boolean

Включено ли условие работы

rules[].name *

string

Название условия работы

rules[] *

array

rules[].id *

string

Идентификатор условия работы

rules[].is_enabled *

boolean

Включено ли условие работы

rules[].name *

string

Название условия работы

Код 401

Отсутствуют параметры авторизации запроса

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

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

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

Поля

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

Код 403

Недостаточно прав для выполнения запроса

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

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

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

Поля

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

Код 429

Превышено допустимое число запросов

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

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

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

Поля

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

Код 500

Внутренняя ошибка сервера

{
  "code": "string",
  "message": "Текстовое описание ошибки"
}
Скопировано

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

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

Поля

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

code

string

Машиночитаемый код ошибки

message *

string

Человекочитаемое сообщение об ошибке

Пример

Request:

curl -X GET "https://fleet-api.taxi.yandex.net/v1/parks/driver-work-rules?park_id={string}" \
-H "X-Client-ID: <Идентификатор клиента>" \
-H "X-API-Key: <API-ключ>" \
-H "Accept-Language: ru"
Скопировано

Responses:

{
  "rules": [
    {
      "id": "06640a5568bf4c238324d34fd1769a64",
      "is_enabled": true,
      "name": "Штатный"
    }
  ]
}
Скопировано