Получить список стран
Порядок работы для агента · Методы API и схема OpenAPI.
Назначение
Получите справочник стран, чтобы выбрать значение для поля страны в запросе.
Блоки запроса и ответов ниже сгенерированы из OpenAPI. Подстановки вроде
exampleпоказывают структуру JSON. Для вызова возьмите значения из сценария, справочников или предыдущих ответов API.
Request
GET
https://partner-test-yamagistrali.ru/api/dicts/countries/v0/countriesGet
Тестовый стенд
Responses
200 OK
OK
Body
application/json
{
"data": {
"countries": [
{
"countryCode": "example",
"defaultCurrencyISO": "example",
"defaultPosition": {
"lat": 0.5,
"long": 0.5
},
"defaultTimeZone": "example",
"title": "example"
}
]
}
}
|
Name |
Description |
|
data |
Type: DictsCountriesV0CountriesGetResponse Example |
CountriesGetDefaultPosition
|
Name |
Description |
|
lat |
Type: number |
|
long |
Type: number |
Example
{
"lat": 0.5,
"long": 0.5
}
CountryItem
|
Name |
Description |
|
countryCode |
Type: string Example: |
|
defaultCurrencyISO |
Type: string Example: |
|
defaultPosition |
Type: CountriesGetDefaultPosition Example |
|
defaultTimeZone |
Type: string Example: |
|
title |
Type: string Example: |
Example
{
"countryCode": "example",
"defaultCurrencyISO": "example",
"defaultPosition": {
"lat": 0.5,
"long": 0.5
},
"defaultTimeZone": "example",
"title": "example"
}
DictsCountriesV0CountriesGetResponse
|
Name |
Description |
|
countries |
Type: CountryItem[] | null Example |
Example
{
"countries": [
{
"countryCode": "example",
"defaultCurrencyISO": "example",
"defaultPosition": {
"lat": 0.5,
"long": 0.5
},
"defaultTimeZone": "example",
"title": "example"
}
]
}
400 Bad Request
Bad Request
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |
Error
|
Name |
Description |
|
info |
Type: object Example |
|
message |
Type: string Example: |
|
message_code |
Type: string Example: |
Example
{
"info": {},
"message": "example",
"message_code": "example"
}
403 Forbidden
Forbidden
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |
500 Internal Server Error
Internal Server Error
Body
application/json
{
"error": {
"info": {},
"message": "example",
"message_code": "example"
}
}
|
Name |
Description |
|
error |
Type: Error Example |