Skip to main content
POST
/
t
/
v1
/
pickup-cars
Pickup cars
curl --request POST \
  --url https://api-lg-k-h1.arms.cedarai.com/t/v1/pickup-cars \
  --header 'Carrier: <carrier>' \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "exceptions": [],
  "items": [
    {
      "pickup_task_id": "task_003"
    },
    {
      "equipment_id": 66666
    }
  ],
  "train_consist_equipment_uuids": [
    "uuid_car1",
    "uuid_car2",
    "uuid_car3",
    "uuid_car4"
  ],
  "work_order_id": "12345"
}
'
{}

Documentation Index

Fetch the complete documentation index at: https://docs.cedarai.com/llms.txt

Use this file to discover all available pages before exploring further.

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 completing Pickup tasks.

Request message for completing Pickup tasks.

​
items
object[]
required

List of the items to Pickup. The associated Pickup tasks will be closed on success.

​
trainConsistEquipmentUuids
string[]
required

Ordered list of equipment UUIDs representing the new consist sequence of the train after Pickup.

​
workOrderId
string
required
​
exceptions
object[]
​
taskIds
string[]

Deprecated. Use items instead.

​
timestamp
string<date-time>

Response

A successful response.

The response is of type object.