Открытие шлагбаума или домофона

POST 
/v7/opengate

Запрос на открытие шлагбаума или домофона. Для шлагбаума ответ вернется после открытия шлагбаума, не раньше. Для домофона без возможности дистанционного открытия будет отправлена ссылка с кодом доступа. Запрос на открытие шлагбаума (и отображать кнопку для открытия) можно лишь в том случае если у курьера есть основание для открытия - заказ по данном адресу.

Request

application/json

Body

required

id stringrequired

Идентификатор шлагбаума (Required) (Шестнадцатеричная строка, 24 символа)

lat numberrequired

Координаты широты курьера в момент открытия шлагбаума [-90; 90]

lon numberrequired

Координаты долготы курьера в момент открытия шлагбаума [-180; 180]

driverPhone stringrequired

Последние 5 цифр номера телефона водителя - XXXXX

tenantPhone stringrequired

Последние 5 цифр номера телефона клиента - XXXXX

orderId string

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

orderCountry stringrequired

Адрес заказа (страна)

orderCity stringrequired

Адрес заказа (город)

orderStreet stringrequired

Адрес заказа (улица)

orderBuilding stringrequired

Адрес заказа (номер здания)

orderEntrance string

Адрес заказа (номер подъезда) для частного дома "0" строкой

orderApartment stringrequired

Адрес заказа (номер квартиры) для частного дома "0" строкой

driverId string

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

vehicleType

Possible values: [automobile, bicycle, pedestrian, truck]

Тип транспортного средства, по умолчанию automobile

carNumber string

Номер машины

Responses

200

Выполнено успешно

application/json

Schema

Schema

intrecomCodeLink string

Ссылка для получения кода доступа к домофону, возвращается для устройств типа intrecom

Example (from schema)

{
  "intrecomCodeLink": "https://demo-integration.tpsgate.com/intercom/code"
}

400

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

• lat_is_not_found - Широта не найдена
• lon_is_not_found - Долгота не найдена
• lat_is_not_valid - Широта не валидна
• lon_is_not_valid - Долгота не валидна
• id_is_not_found - id шлагбаума не найден
• id_is_not_valid - id шлагбаума не валиден
• driver_phone_is_not_found - Телефон водителя не найден
• driver_phone_is_invalid - Телефон водителя не валиден
• tenant_phone_is_not_found - Телефон жильца не найден
• tenant_phone_is_invalid - Телефон жильца не валиден
• invalid_request - Некорректный запрос
• opening_gate_error - Шлагбаум не открылся
• invalid_fleet - secretkey или интеграция автопарка не валидна
• gate_not_found - Шлагбаум не найден
• tenant_not_exists - Ошибка! Проезд по данному тел. номеру клиента запрещён
• vehicle_type_not_allowed - Ошибка! Тип данного транспортного средства запрещён для этого шлагбаума
• blocked_by_administrator - Ошибка! Проезд водителю заблокирован администратором TPS
• autopark_blocked_by_administrator - Ошибка! Проезд автопарку заблокирован администратором TPS
• too_far_from_gate - Ошибка! Вы слишком далеко от открываемого шлагбаума

application/json

Schema

Schema

code stringrequired

Possible values: [lat_is_not_found, lon_is_not_found, lat_is_not_valid, lon_is_not_valid, id_is_not_found, id_is_not_valid, driver_phone_is_not_found, driver_phone_is_invalid, tenant_phone_is_not_found, tenant_phone_is_invalid, invalid_request, opening_gate_error, invalid_fleet, gate_not_found]

Статус запроса

message stringrequired

Локализованное сообщение об ошибке

Example (from schema)

{
  "code": "lat_is_not_found",
  "message": "string"
}

401

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

• unauthorized - secretkey некорректный

application/json

Schema

Schema

code stringrequired

Possible values: [unauthorized]

Статус запроса

message stringrequired

Локализованное сообщение об ошибке

Example (from schema)

{
  "code": "unauthorized",
  "message": "string"
}

429

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

• too_many_requests - Превышение ежедневного или ежеминутного лимита

application/json

Schema

Schema

code stringrequired

Possible values: [too_many_requests]

Статус запроса

message stringrequired

Локализованное сообщение об ошибке

Example (from schema)

{
  "code": "too_many_requests",
  "message": "string"
}

Loading...