Skip to main content
POST
/
t
/
v1
/
depart-train
Depart train
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/depart-train \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "work_order_id": "12345",
  "auto_uncomplete_tasks": true,
  "exception": "Departure delayed due to equipment issue",
  "timestamp": "2024-01-15T14:30:00.000Z",
  "station_id": 11111
}
'
{}

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 departure from a station or location. Used when a train leaves to begin its journey or move to the next location.

Request message for recording a train departure from a station or location. Used when a train leaves to begin its journey or move to the next location.

​
workOrderId
string
required
​
autoCloseTasks
boolean

Automatically close open tasks as INCOMPLETE.

​
exception
string
​
timestamp
string<date-time>
​
stationId
string<int64>

Response

A successful response.

The response is of type object.