Список гражданств, доступных для найма курьеров Еды в заданном регионе
Получение списка гражданств исполнителей, доступных для найма Еды в данном регионе
Request
POST
https://fleet-api.taxi.yandex.net/v1/eats/citizenships/list
Headers
|
Name |
Description |
|
Accept-Language |
Type: string Предпочитаемый язык ответа Min length: Example: |
|
X-API-Key |
Type: string API-ключ Min length: Example: |
|
X-Client-ID |
Type: string Идентификатор клиента Min length: Example: |
|
X-Park-ID |
Type: string Идентификатор партнера Example: |
Body
application/json
{
"employment_type": "park_direct",
"geobase_id": 1
}
|
Name |
Description |
|
employment_type |
Type: string Тип занятости. Может быть park_direct (ПСМЗ) или courier_service (Парковый исполнитель в терминах Fleet) Enum: |
|
geobase_id |
Type: integer Идентификатор региона в геобазе. Гражданства, недоступные в данном регионе при выбранном типе занятости, не будут возвращены |
Responses
200 OK
Список гражданств, доступных для найма Еды
Body
application/json
{
"citizenships": [
{
"citizenship_code2": "RU",
"name": "Russian Federation"
}
]
}
|
Name |
Description |
|
citizenships |
Type: Citizenship[] Список гражданств исполнителей, доступных для найма Еды. Гражданства отсортированы по полю 'name' Example |
Citizenship
|
Name |
Description |
|
citizenship_code2 |
Type: string Код страны в формате ISO 3166-1 alpha-2 Pattern: Example: |
|
name |
Type: string Локализованное название гражданства Example: |
Example
{
"citizenship_code2": "RU",
"name": "Russian Federation"
}
400 Bad Request
Некорректные параметры запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |
422 Unprocessable Entity
Некорректные параметры запроса
Body
application/json
{
"code": "example",
"message": "Текстовое описание ошибки"
}
|
Name |
Description |
|
message |
Type: string Человекочитаемое сообщение об ошибке Example: |
|
code |
Type: string Машиночитаемый код ошибки Example: |