OTM Couple API (5.0)

The OTM Couple API provides REST endpoints to couple vehicles to trips

Couple a vehicle to a trip

Couple a vehicle from a carrier to a trip by providing an AssociationCreatedEvent. The AssociationCreatedEvent contains two entities: entity1(Trip) and entity2(Vehicle). These two entities are order-insensitive.

The vehicle-entity should contain the devicedetails and should be either a combination of externalSystemId and externalDeviceId or a combination of externalSystemId and licensePlate.

SecurityBearerAuth
Request
Request Body schema: application/json

The requestbody which is formatted as a valid OTM AssociationCreatedEvent with a Trip and Vehicle entity

id
required
string <url + uuid>

The id of the event

eventType
required
string

The type of the event

required
object (TripEntity)
entityType
required
string
associationType
required
string
required
object (TripRestriction)
required
object (TripExternalAttributes)
tripId
required
string
shipperCode
required
string

Simacan's unique code for a given shipper

required
object (VehicleEntity)
entityType
required
string
associationType
required
string
required
object (VehicleRestriction)
required
object (VehicleExternalAttributes)
externalSystemId
required
string

A combination of FMS brand name and account number.

externalDeviceId
string

The unique identifier used to recognize the device/vehicle in your source system

licensePlate
string
Responses
200

The post message was succesfully processed. Either the vehicle was coupled to the trip or the coupling already exists

400

The request was invalid or cannot be otherwise served. Possible causes are invalid JSON objects or missing required parameters. An accompanying error message will explain further.

401

Authentication credentials were missing or incorrect.

403

The request is understood, but it has been refused or access is not allowed. An accompanying error message will explain why.

404

The URI requested is invalid or the resource requested does not exists. Also returned when the requested format is not supported by the requested method.

500

An unexpected server error has occurred, which needs further investigation. Please contact support.

post/event
Request samples
application/json
{
  • "id": "https://api.opentripmodel.org/api/public/v5/event/27642184-558e-4d70-9ba6-1650d9f7213b",
  • "eventType": "AssociationCreated",
  • "entity1": {
    },
  • "entity2": {
    }
}