Получение шлагбаумов по списку заказов

POST 
/v7/parking

Запрос по списку заказов

Request

application/json

Body

required

orders object[]
Список заказов
Array [
orderId stringrequired
Уникальный номер заказа (генерируется на стороне клиента)
lat numberrequired
Координаты адреса заказа (lat) [-90; 90]
lon numberrequired
Координата адреса заказа (lon) [-180; 180]
address string
Адрес заказа одной строкой
country stringrequired
Страна заказа ['Беларусь', 'Россия']
city stringrequired
Город заказа
street stringrequired
Улица заказа
building stringrequired
Номер дома заказа
entrance stringrequired
Номер подъезда заказа, если подъезда нет, то "0"
apartment stringrequired
Номер квартиры заказа, если квартиры нет, то "0"
tenantPhone stringrequired
Последние цифры в номере тел. клиента (мин. 5 цифр - XXXXX)
leaveatDoor booleanrequired
Оставить заказ у двери
]

Responses

200

Выполнено успешно, коды ошибок позиций.

• order_id_in_orders_is_not_found - Поле orderId в одном из заказов отсутствует
• lat_in_orders_is_not_found - Поле lat в одном из заказов отсутствует
• lon_in_orders_is_not_found - Поле lon в одном из заказов отсутствует
• country_in_orders_is_not_found - Поле country в одном из заказов отсутствует
• city_in_orders_is_not_found - Поле city в одном из заказов отсутствует
• street_in_orders_is_not_found - Поле street в одном из заказов отсутствует
• building_in_orders_is_not_found - Поле building в одном из заказов отсутствует
• tenant_phone_in_orders_is_not_found - Поле tenantPhone в одном из заказов отсутствует
• tenant_phone_in_orders_is_invalid - Поле tenantPhone в одном из заказов не соответствует формату XXXXX
• country_in_orders_is_invalid - Поле country в одном из заказов имеет не соответсвует одному из двух значений - "Беларусь" или "Россия"
• parking_not_found - Не удалось найти парковку
• all_gates_unavailable_or_dont_exist - Все шлагбаумы данной парковки отсутствуют или в данный момент недоступны

application/json

Schema

Schema

• Array [
orderId stringrequired

Уникальный номер заказа

id stringrequired

Id парковки

address objectrequired

country stringrequired

Страна заказа

city stringrequired

Город заказа

street stringrequired

Улица заказа

building stringrequired

Номер дома заказа

rules stringrequired

Правила парковки

gates object[]required
Array [
id stringrequired
Id устройства
name stringrequired
Название устройства
lat numberrequired
Координата lat устройства
lon numberrequired
Координата lon устройства
photo stringrequired
Ссылка на картинку шлагбаума
number string
Номер шлагбаума
objectType stringrequired
Тип устройства (шлагбаум, домофон)
]
success booleanrequired

Заказ обработан успешно или нет

errorCode string

Код ошибки, если ошибка

errorMessage string

Читабельное сообщение об ошибке

• ]

Example (from schema)

[
  {
    "orderId": "4342354363",
    "id": "60be42ffc0c9ce85465b2416",
    "address": {
      "country": "Россия",
      "city": "Москва",
      "street": "Тарутинская",
      "building": "1"
    },
    "rules": "string",
    "gates": [
      {
        "id": "616e62c9e2f5b58c2377c103",
        "name": "Тарутинская 1",
        "lat": 55.731951,
        "lon": 37.471812,
        "photo": "https://storage.yandexcloud.net/tpsgate-images/gates-images-full/60be3c82c0c9ce80945b23f1.jpg",
        "number": "2",
        "objectType": "barrier"
      }
    ],
    "success": true,
    "errorCode": "string",
    "errorMessage": "string"
  }
]

400

Не корректный запрос. Значение кодов ошибок:

• orders_are_not_found - Список заказов не найден
• error - Ошибка, повторите запрос позже

application/json

Schema

Schema

code stringrequired

Possible values: [wrong_format, orders_are_not_found, error]

Коды ошибок

message stringrequired

Читабельное сообщение об ошибке

Example (from schema)

{
  "code": "wrong_format",
  "message": "Не верный формат данных"
}

401

Ошибка авторизации. Значение кодов ошибок:

• unauthorized - Не авторизован

application/json

Schema

Schema

code stringrequired

Possible values: [unauthorized]

Коды ошибок

message stringrequired

Читабельное сообщение об ошибке

Example (from schema)

{
  "code": "unauthorized",
  "message": "Не верный формат данных"
}

Loading...