Railcar API

Report wagon damage (full snapshot)

Report each wagon’s complete set of open defects. Each wagon in the body replaces everything ARMS shows for that wagon; ARMS never merges it with earlier messages.

Usage notes:

An empty defects list means the wagon has no open defects (repaired).
The wagon’s colour is its worst defect severity: red > blue > white.
A wagon whose defects already match what ARMS shows is a no-op: nothing is written, no wagon_damaged event is emitted, and the result has changed: false. Resending is always safe.
The whole request is one transaction: a validation error (400) writes nothing.
A wagon_damaged event is emitted only for changed wagons with exactly one inbound or online inventory record (equipmentKnown: true).
A missing permission returns 401.

POST

ims

equipment

wagon-damage

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/equipment/wagon-damage \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "wagons": [
    {
      "wagonNumber": "437443800606",
      "defects": [
        {
          "defectCode": "1.3.5.1",
          "defectDescription": "Krossår/håligheter/avskalning på löpytan > 60 mm",
          "defectRemark": "",
          "defectSeverity": "red"
        },
        {
          "defectCode": "6.1.7.3",
          "defectDescription": "Fotsteg skadat, fara säkerhet personal",
          "defectRemark": "",
          "defectSeverity": "blue"
        }
      ]
    }
  ]
}
'

{
  "items": [
    {
      "wagonNumber": "<string>",
      "damageStatus": "RED",
      "defectCount": 123,
      "changed": true,
      "equipmentKnown": true
    }
  ]
}

{
  "message": "<string>"
}

Authorizations

x-arms-api-key

string

header

required

Your ARMS API key

x-arms-assume-user

string

header

required

Email of a user assigned to the appropriate user group

Query Parameters

carrierId

integer

required

Carrier identifier; required for all endpoints

viewAsUserGroup

string

Optional user group context

Body

application/json

Request body for reporting wagon damage. The whole request is applied or rejected as one unit.

wagons

object[]

required

Each wagonNumber at most once; at most 5,000 defects across all wagons.

Required array length: 1 - 500 elements

Show child attributes

carrierId

integer

Carrier identifier. Optional here; the carrierId query parameter is required and takes precedence.

Response

items

object[]

One entry per wagon, in request order.

Show child attributes

⌘I

curl --request POST \
  --url https://api-lg.arms.cedarai.com/ims/equipment/wagon-damage \
  --header 'Content-Type: application/json' \
  --header 'x-arms-api-key: <api-key>' \
  --header 'x-arms-assume-user: <api-key>' \
  --data '
{
  "wagons": [
    {
      "wagonNumber": "437443800606",
      "defects": [
        {
          "defectCode": "1.3.5.1",
          "defectDescription": "Krossår/håligheter/avskalning på löpytan > 60 mm",
          "defectRemark": "",
          "defectSeverity": "red"
        },
        {
          "defectCode": "6.1.7.3",
          "defectDescription": "Fotsteg skadat, fara säkerhet personal",
          "defectRemark": "",
          "defectSeverity": "blue"
        }
      ]
    }
  ]
}
'

{
  "items": [
    {
      "wagonNumber": "<string>",
      "damageStatus": "RED",
      "defectCount": 123,
      "changed": true,
      "equipmentKnown": true
    }
  ]
}

{
  "message": "<string>"
}