Device

Register gateway to vehicle

Register gateway to vehicle

post/fleet/{fleetId}/gateway/register

Request

  • Base URL: https://api.revvo.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.revvo.ai/fleet/{fleetId}/gateway/register
  • Auth: one of:
    • Bearer (a scheme the document does not define)
    • HTTP bearer

Path parameters

fleetIdstring required

Unique identifier for the fleet. Typically formatted as revvo-XXXX. This can be found in your admin / integrations / revvo API setup page

Request body

gatewayIdstring nullable

ID of the gateway

assetIdstring nullable required

Vehicle asset identifier

gatewayLocation'TRUCK_FRONT_LEFT_UNDER_DASHBOARD' | 'TRUCK_FRONT_CENTER_UNDER_DASHBOARD' | 'TRUCK_FRONT_RIGHT_UNDER_DASHBOARD' | 'TRUCK_FRONT_LEFT_BEHIND_DRIVER_SEAT' | 'TRUCK_FRONT_RIGHT_BEHIND_DRIVER_SEAT' | 'CAR_FRONT_LEFT_OBD2' | 'CAR_FRONT_CENTER_OBD2' | 'CAR_FRONT_RIGHT_OBD2' | 'CAR_REAR_LEFT_TRUNK' | 'CAR_REAR_CENTER_TRUNK' | 'CAR_REAR_RIGHT_TRUNK' | 'TRAILER_FRONT_LEFT_TOP' | 'TRAILER_FRONT_CENTER_TOP' | 'TRAILER_FRONT_RIGHT_TOP' | 'TRAILER_REAR_LEFT_TOP' | 'TRAILER_REAR_CENTER_TOP' | 'TRAILER_REAR_RIGHT_TOP' | 'TRAILER_MIDDLE_LEFT_UNDERSIDE' | 'TRAILER_MIDDLE_CENTER_UNDERSIDE' | 'TRAILER_MIDDLE_RIGHT_UNDERSIDE' | 'TRAILER_REAR_LEFT_UNDERSIDE' | 'TRAILER_REAR_CENTER_UNDERSIDE' | 'TRAILER_REAR_RIGHT_UNDERSIDE' | 'TRUCK_LEFT_SLEEPER_BERTH' | 'TRUCK_CENTER_SLEEPER_BERTH' | 'TRUCK_RIGHT_SLEEPER_BERTH' | 'TRUCK_EXTERNAL_REAR_LEFT' | 'TRUCK_EXTERNAL_REAR_RIGHT' | 'BUS_LUGGAGE_COMPARTMENT_FRONT_LEFT' | 'BUS_LUGGAGE_COMPARTMENT_FRONT_RIGHT' | 'BUS_LUGGAGE_COMPARTMENT_REAR_LEFT' | 'BUS_LUGGAGE_COMPARTMENT_REAR_RIGHT' | 'BUS_FRONT_LEFT_BEHIND_DRIVER_SEAT' | 'BUS_FRONT_RIGHT_BEHIND_DRIVER_SEAT' | 'BUS_FRONT_LEFT_SERVICE_PANEL_BY_DRIVER_SEAT' | 'BUS_FRONT_RIGHT_SERVICE_PANEL_BY_DRIVER_SEAT' required

Location of the gateway installation

Example request

{
  "gatewayId": "T1161230000",
  "assetId": "Vehicle 1",
  "gatewayLocation": "TRUCK_FRONT_LEFT_UNDER_DASHBOARD"
}

Response

Registered gateway

valuestring required

Get value

successboolean

true

Example response

{
  "success": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.