Skip to main content
POST

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
carrierId
integer<int64>
required

The railroad's carrier ID. Must match the carrierId query parameter.

message
string
required

The detector or OS traffic CSV, as text.

Maximum string length: 1000000
fileName
string

Optional bare file name (no folders), stored with the scan. TRAINID_YYYYMMDD_HHMMSS.csv also sets the train ID, unless trainId is sent.

Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$
trainId
string

Optional ID of the train the scan belongs to. OS traffic files are matched only to this train; detector passes are matched by their cars.

Maximum string length: 128
Pattern: ^[A-Za-z0-9][A-Za-z0-9._-]{0,127}$

Response

OK

aeiConsist
object

The scan ARMS created. Further fields may be added.