Skip to main content
POST
Record Train Event

Authorizations

x-arms-api-key
string
header
required
x-arms-assume-user
string
header
required

Headers

Carrier
string
required

Carrier ID

Body

application/json

Request message for recording a train event.

Request message for recording a train event.

eventLocation
Event Location · object

Information about where the event occurred.

eventMessage
string

A human-readable message for the event. This will override the default event message.

externalSystemEvent
External System Event · object

Event that originated from an external system.

finalApprovalEventDetails
Final Approval Event Details · object

Details for a final approval event.

notes
string

Free-form notes about the event.

otherEventDetails
Other Event Details · object

Empty message - just serves as a discriminator

safetyCheckEventDetails
Safety Check Event Details · object

Details for a safety check event.

workOrderId
string

The work order ID associated with this event.

Response

A successful response.

The response is of type object.