CARLOAD

Trip Plan - Returns list of significant events planned for a railcar equipment initial and number from origin to destination.

get/v1/trip-plan-carload

Request

Base URL
https://api.bnsf.com:6443
Auth
none declared
TypeScript
https://skmtc.dev/bnsf/apis/bnsf-trace-api/docs/v1/trip-plan-carload/get.ts
A function with typed inputs. Its response is checked against the schema.

Query parameters

equipmentInitialstring

Example:BNSF

Equipment Initial.

equipmentNumberstring

Example:12345

Equipment Number.

Response

The request has succeeded.

jobStatusinteger

jobStatusDescriptionstring

rowCountstring

Example response

{
  "jobStatus": 4,
  "jobStatusDescription": "Job is complete",
  "resultSet": [
    {
      "equipmentInitial": "BNSF",
      "equipmentNumber": "12345",
      "estimatedEventDatetimeIndicator": "Y",
      "eventDatetime": "2021-11-17 15.47.51",
      "eventDescription": "Train Departure",
      "eventLocation": "CLOVIS NM",
      "sequenceNumber": 110,
      "trainId": "S MEMSCO 1 15"
    }
  ],
  "rowCount": "1"
}

Changes

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