Cedarai Equipment History API
The Equipment History API from Cedarai — 1 operation(s) for equipment history.
The Equipment History API from Cedarai — 1 operation(s) for equipment history.
openapi: 3.0.1
info:
title: protobuf/arms/charge.proto ChargeService Equipment History API
version: version not set
servers:
- description: Production (US)
url: https://api-lg-k-h1.arms.cedarai.com
- description: Production (EU)
url: https://api-lg-k-h1.arms.cedarai.se
security:
- ApiKeyAuth: []
AssumeUserAuth: []
tags:
- name: Equipment History
paths:
/equipment-history/:
post:
summary: List railcar history
description: Retrieves equipment history records, filterable by equipment, time range, and flags.
operationId: listEquipmentHistory
parameters:
- $ref: '#/components/parameters/CarrierId'
- $ref: '#/components/parameters/ViewAsUserGroup'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ListEquipmentHistoryInput'
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: '#/components/schemas/ListEquipmentHistoryOutput'
'400':
description: Bad Request
'401':
description: Unauthorized
'500':
description: Internal Server Error
default:
description: Error
content:
application/json:
schema:
$ref: '#/components/schemas/Error'
tags:
- Equipment History
components:
schemas:
HistoryGroupingNameFilter:
type: object
properties:
groupingType:
type: string
title: Grouping Type
name:
type: string
title: Name
required:
- groupingType
- name
LineItem:
type: object
properties:
number:
type: integer
descriptions:
type: array
items:
$ref: '#/components/schemas/LineItemDescription'
quantity:
$ref: '#/components/schemas/LineItemQuantity'
measurements:
type: array
items:
$ref: '#/components/schemas/Measurement'
priceAuthorities:
type: array
items:
$ref: '#/components/schemas/PriceAuthority'
HazmatReferenceNumber:
type: object
properties:
referenceIdQualifier:
type: string
referenceId:
type: string
date:
type: string
InterchangeMoveAuthority:
type: object
description: Interchange move authority on equipment (X12 IMA).
properties:
movementAuthorityCode:
type: string
enum:
- A
- B
- C
- D
- DS
- E
- G
- HM
- I
- L
- N
- NC
- NU
- O
- OA
- OS
- P
- R
- RB
- S
- W
- X
carrierCode:
type: string
terminalTariffApplicationCode:
type: string
enum:
- D
- E
- F
stateTariffApplicationCode:
type: string
enum:
- N
- S
rejectReasonCode:
type: string
enum:
- AD
- BA
- BC
- BD
- BG
- BL
- BO
- BV
- BW
- CN
- CR
- CW
- DD
- DR
- DS
- DV
- ER
- FD
- FR
- HB
- HH
- HX
- LK
- OG
- OV
- RF
- RH
- SU
- ZZ
GroupingRule:
type: object
description: Optional grouping rule configuration.
additionalProperties: true
Station:
type: object
properties:
fsac:
type: string
cityName:
type: string
stateOrProvince:
type: string
postalCode:
type: string
countryCode:
type: string
splc:
type: string
EmptyCarDisposition:
type: object
properties:
destinationConsigneeName:
type: string
destinationConsigneeIdQualifier:
type: string
destinationConsigneeId:
type: string
destinationCityName:
type: string
destinationStateOrProvince:
type: string
destinationPostalCode:
type: string
destinationCountryCode:
type: string
destinationAddress:
type: string
destinationRoute:
type: array
items:
$ref: '#/components/schemas/RouteEntry'
CommunicationNumber:
type: object
properties:
qualifier:
type: string
number:
type: string
Umler:
allOf:
- $ref: '#/components/schemas/UmlerCommon'
WorkOrderResource:
type: object
properties:
resourceId:
type: integer
uuid:
type: string
description: UUID that complements the legacy numeric resourceId.
workOrderId:
type: string
status:
type: string
enum:
- PENDING
- ACTIVE
- CLOSED
trainId:
type: string
inTransit:
type: boolean
lastEventId:
type: integer
hasBeenDeparted:
type: boolean
CanadianDangerousRequirements:
type: object
properties:
emergencyResponsePlanNumber:
type: string
communicationNumber:
type: string
packagingGroupCode:
type: string
firstSubsidiaryClassification:
type: string
secondSubsidiaryClassification:
type: string
thirdSubsidiaryClassification:
type: string
subsidiaryRiskIndicator:
type: string
netExplosiveQuantity:
type: number
canadianHazardousNotation:
type: string
specialCommodityIndicatorCode:
type: string
additionalCommunicationNumber:
type: string
netExplosiveQuantityUnitCode: cc0c4147-6a4a-4816-bee4-7ffe00fb1d06
hazmatShipmentInfoQualifier:
type: string
hazmatQuantity:
type: number
hazmatQuantityUnitCode: ba996b62-4cc6-44f9-bd5f-8e435efc6e36
IntermodalUnitResource:
type: object
properties:
resourceType:
type: string
enum:
- IntermodalUnit
resourceId:
type: integer
uuid:
type: string
description: UUID that complements the legacy numeric resourceId.
RouteEntry:
type: object
properties:
carrierCode:
type: string
junctionCode:
type: string
routingSequenceCode:
type: string
enum:
- '1'
- '2'
- '3'
- '4'
- '5'
- '6'
- '7'
- '8'
- '9'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '20'
- A
- D
- H
- I
- JD
- JI
- JO
- M
- R
- S
- V
splc:
type: string
intermodalServiceCode:
type: string
additionalSwitchCarrierCodes:
type: array
items:
type: string
LineItemQuantity:
type: object
properties:
billedAsQuantity:
type: number
billedAsQualifier:
type: string
enum:
- DM
- GL
- NC
- ND
- NP
- NU
- NV
weight:
type: number
weightQualifier:
type: string
enum:
- A3
- B
- C
- E
- G
- J
- K
- M
- N
- O
- S
- X
volume:
type: number
volumeUnitQualifier:
type: string
enum:
- B
- C
- D
- E
- F
- G
- H
- L
- M
- N
- R
- S
- T
- U
- V
- X
ladingQuantity:
type: number
packagingFormCode:
type: string
dunnageDescription:
type: string
weightUnitCode:
type: string
typeOfServiceCode:
type: string
RelaxedEquipment:
allOf:
- $ref: '#/components/schemas/Equipment'
LineItemDescription:
type: object
properties:
ladingDescription:
type: string
commodityCode:
type: string
commodityCodeQualifier:
type: string
enum:
- '3'
- J
- L
- T
packagingCode:
type: string
marksAndNumbers:
type: string
marksAndNumbersQualifier:
type: string
hazmatRatingCommodityCodeQualifier:
type: string
hazmatRatingCommodityCode:
type: string
compartmentIdCode:
type: string
EquipmentShipmentInformation:
type: object
description: Per-equipment customs and tariff block (Carta Porte). Required on cross-border US–Mexico waybills; attach under waybill.equipmentDetails[], not waybill.lineItems[].
properties:
referenceIdQualifier:
type: string
description: Reference identification qualifier (X12 REF01). Use "UNC" for UNSPSC-classified Carta Porte commodities.
referenceId:
type: string
description: Reference value (X12 REF02). For Carta Porte, the UNSPSC code when referenceIdQualifier is UNC.
description:
type: string
extendedReferenceInfo:
type: array
description: Extended references on this shipment-info block. Carta Porte requires MTC (Mexico tariff) entries; hazardous shipments also require MHC.
items:
$ref: '#/components/schemas/ExtendedReferenceInformation'
lineItems:
type: array
items:
$ref: '#/components/schemas/EquipmentLineItem'
HazardousCertification:
type: object
properties:
name:
type: string
IntermodalStatusDetails:
type: object
properties:
shipmentStatusCode:
type: string
enum:
- A
- AE
- AI
- AL
- AO
- AR
- B
- BO
- CA
- CB
- CC
- CS
- CT
- D
- DA
- DC
- DP
- DR
- DS
- DT
- EA
- ER
- G
- GI
- I
- J
- K
- L
- LE
- MA
- MD
- ME
- MI
- MO
- MR
- MT
- N
- NC
- ND
- NF
- NG
- NH
- 'NO'
- NP
- NS
- NT
- O
- OA
- OH
- P
- PA
- PB
- PC
- PD
- PE
- PF
- PG
- PH
- PI
- PJ
- PK
- PL
- PM
- PN
- PO
- PP
- R
- RF
- RL
- RN
- RY
- SA
- SC
- SF
- SO
- T
- TE
- UR
- UV
- WH
- WR
- YR
shipmentStatusTime:
type: string
WagonDamage:
type: object
properties:
reportId:
type: string
description: Report identifier for the damage.
damageStatus:
type: integer
description: Status code for the damage.
damageCode:
type: string
description: Damage code.
damageDescription:
type: string
description: Description of the damage.
damageIsNew:
type: boolean
description: Whether the damage is new.
eventTimestamp:
type: string
format: date-time
description: Timestamp of the damage event.
ProtectiveService:
type: object
properties:
ruleCode:
type: string
serviceCode:
type: string
enum:
- D
- HDN
- HDNC
- HSC
- M
- MN
- MNU
temperatureUnit:
type: string
enum:
- CE
- FA
optimalTemperature:
type: number
scac:
type: string
fsac:
type: string
cityName:
type: string
stateOrProvince:
type: string
precooled:
type: boolean
heaterLocation:
type: string
enum:
- Y
- N
commodityType:
type: string
enum:
- Y
- N
doorwaySpace:
type: string
enum:
- Y
- N
originTemperature:
type: number
PriceAuthority:
type: object
properties:
referenceIdQualifier:
type: string
referenceId:
type: string
primaryPublicationAuthority:
type: string
regulatoryAgencyCode:
type: string
tariffAgencyCode:
type: string
issuingCarrierIdentifier:
type: string
suffix:
type: string
itemNumber:
type: string
supplementIdentifier:
type: string
sectionNumber:
type: string
itemNumberSuffix:
type: string
effectiveDate:
type: string
expirationDate:
type: string
HazardousInformation:
type: object
properties:
ladingUnitCode: a14d81c2-807b-443c-b776-a08508622fa1
ladingQuantity:
type: number
unIdCode:
type: string
unPageNumber:
type: string
commodityCode:
type: string
unitCode: 0bb40fcf-51c2-4e87-bd9b-74ef671f9ba6
quantity:
type: number
compartmentIdCode:
type: string
residueIndicatorCode:
type: string
packagingGroupCode:
type: string
interimHazmatRegulatoryNumber:
type: string
industryCode:
type: string
classificationInfo:
type: array
items:
$ref: '#/components/schemas/HazardousClassificationInformation'
hazmatShippingNameInfo:
type: array
items:
$ref: '#/components/schemas/HazmatShippingNameInformation'
hazmatAdditionalInfo:
type: array
items:
$ref: '#/components/schemas/HazmatFreeFormInformation'
epaRequiredData:
type: array
items:
$ref: '#/components/schemas/EPARequiredData'
canadianDangerousRequirements:
type: array
items:
$ref: '#/components/schemas/CanadianDangerousRequirements'
transborderHazardousRequirements:
type: array
items:
$ref: '#/components/schemas/TransborderHazardousRequirements'
hazmatReferenceNumbers:
type: array
items:
$ref: '#/components/schemas/HazmatReferenceNumber'
administrativeContacts:
type: array
items:
$ref: '#/components/schemas/AdministrativeContact'
parties:
type: array
items:
$ref: '#/components/schemas/Party'
ExtendedReferenceInformation:
type: object
description: Extended reference information from the waybill. Production notes are entries where referenceIdQualifier is "ZZ" and description is "TrpNotes"; the note text is in referenceId.
properties:
referenceIdQualifier:
type: string
description: Reference identification qualifier (e.g. "ZZ" for mutually defined references).
referenceId:
type: string
description: Reference value. For production notes (ZZ/TrpNotes), this contains the note text.
description:
type: string
description: Description of the reference (e.g. "TrpNotes" for production notes).
date:
type: string
timestamp:
type: string
HazardousClassificationInformation:
type: object
properties:
hazardousClass:
type: string
hazardousClassQualifier:
type: string
enum:
- P
- S
hazardousPlacardNotation:
type: string
hazardousEndorsement:
type: string
reportableQuantityCode:
type: string
enum:
- RQ
flashpointUnitCode: 1a248ad4-8c6e-47e2-9757-02942eb582cb
flashpointTemperature:
type: number
controlUnitCode: 2cf8c761-7ddb-4c62-a8a8-5775c800bb4f
controlTemperature:
type: number
emergencyUnitCode: e12f4109-5e55-4d76-871a-77a85ec711fd
emergencyTemperature:
type: number
netExplosiveWeightUnitCode:
type: string
netExplosiveWeight:
type: number
EquipmentLineItem:
type: object
description: Per-commodity line on equipment shipment information (X12 417 N1 loop). Used for Carta Porte on cross-border waybills; quantity is a flat number, not the nested LineItemQuantity on waybill.lineItems[].
properties:
quantity:
type: number
description: Commodity quantity (X12 N1001).
commodityDescription:
type: string
marksAndNumbers:
type: string
commodityCodeQualifier:
type: string
enum:
- '3'
- J
- L
- T
commodityCode:
type: string
customsShipmentValue:
type: integer
weightUnitCode:
type: string
enum:
- E
- K
- L
- S
- T
weight:
type: number
description: Commodity weight (X12 N1008).
cbpBarcodeNumber:
type: string
smallestExteriorPackageType:
type: string
description: Required for Carta Porte shipmentInfo line items (X12 N1010).
originCountryCode:
type: string
destinationCountryCode:
type: string
currencyCode:
type: string
Waybill:
type: object
properties:
loadStatus:
type: string
commodityCode:
type: string
netWeightTons:
type: number
originCityName:
type: string
originStateOrProvince:
type: string
originFsac:
type: string
destinationCityName:
type: string
destinationStateOrProvince:
type: string
destinationFsac:
type: string
consignorCustomerName:
type: string
consigneeCustomerName:
type: string
originScac:
type: string
trafficType:
type: string
enum:
- LOCAL
- ORIGINATING
- TERMINATING
- STORAGE
- BRIDGE
- UNKNOWN
shipmentPaymentMethod:
type: string
enum:
- '11'
- CC
- MX
- NC
- NR
- PP
transportationMethod:
type: string
enum:
- R
- X
shipmentId:
type: string
weightUnitCode:
type: string
enum:
- E
- K
- L
- S
- T
shipmentQualifier:
type: string
enum:
- '1'
- '6'
- '7'
- '8'
- B
- C
- E
- F
- G
- H
- I
- M
- N
- S
- W
- X
capacityLoadCode:
type: string
enum:
- C
- F
- G
- M
- V
customsDocumentationHandlingCode:
type: string
confidentialBillingRequestCode:
type: string
enum:
- C
- M
- N
- R
taxReasonCode:
type: string
shipmentWeightCode:
type: string
enum:
- A3
- B
- C
- E
- G
- J
- K
- M
- N
- O
- S
- X
referencedPatternIdentifier:
type: string
billingCode:
type: string
enum:
- A
- D
- E
- G
- H
- M
- P
- S
- U
- V
- W
- X
- Y
repetitivePatternNumber:
type: integer
extendedReferenceInfo:
type: array
items:
$ref: '#/components/schemas/ExtendedReferenceInformation'
crossReferenceEquipment:
type: array
items:
$ref: '#/components/schemas/CrossReferenceEquipment'
equipmentDetails:
type: array
items:
$ref: '#/components/schemas/EquipmentDetails'
intermodalStatusDetails:
$ref: '#/components/schemas/IntermodalStatusDetails'
specialHandlingCodes:
type: array
items:
type: string
protectiveService:
type: array
items:
$ref: '#/components/schemas/ProtectiveService'
originStation:
$ref: '#/components/schemas/Station'
originJunction:
$ref: '#/components/schemas/Station'
destinationStation:
$ref: '#/components/schemas/Station'
destinationJunction:
$ref: '#/components/schemas/Station'
parties:
type: array
items:
$ref: '#/components/schemas/Party'
route:
type: array
items:
$ref: '#/components/schemas/RouteEntry'
emptyCarDispositions:
type: array
items:
$ref: '#/components/schemas/EmptyCarDisposition'
lineItems:
type: array
items:
$ref: '#/components/schemas/LineItem'
hazardousInfo:
type: array
items:
$ref: '#/components/schemas/HazardousInformation'
hazardousCertifications:
type: array
items:
$ref: '#/components/schemas/HazardousCertification'
release:
$ref: '#/components/schemas/Release'
defaultReceiver:
type: string
waybillTemplateId:
type: integer
waybillTemplateName:
type: string
waybillNumberSuffix:
type: string
originCarrierCode:
type: string
consigneeLocationId:
type: integer
shipperLocationId:
type: integer
inCareOfLocationId:
type: integer
freightBillPartyLocationId:
type: integer
pickupPartyLocationId:
type: integer
waybillNumber:
type: integer
waybillDate:
type: string
billOfLadingNumber:
type: string
originSystem:
type: string
enum:
- ARMS
- EDI
- BRAVO
preparationDate:
type: string
preparationTime:
type: string
revisionNumber:
type: integer
revisionTime:
type: string
revisionSourceType:
type: string
enum:
- WAYBILL
- CONSIST
- BILL_OF_LADING
- ADVANCE_CAR_DISPOSITION
- LOAD
- EMPTY
- REBILL
- CLM
armsTrackingId:
type: string
resourceType:
type: string
enum:
- Waybill
resourceId:
type: integer
uuid:
type: string
description: UUID that complements the legacy numeric resourceId.
waybillStatus:
type: string
enum:
- PENDING
- ACTIVE
- ARCHIVED
createdAt:
type: string
Release:
type: object
properties:
releaseCode:
type: string
enum:
- B
- R
releaseDate:
type: string
releaseTime:
type: string
EPARequiredData:
type: object
properties:
epaWasteStreamNumberCode:
type: string
wasteCharacteristicsCode:
type: string
hazardousWasteNumberStateOrProvince:
type: string
hazardousWasteNumber:
type: string
Error:
type: object
properties:
message:
type: string
ListEquipmentHistoryOutput:
type: object
properties:
nextToken:
type: string
title: Next Token
prevToken:
type: string
title: Prev Token
items:
type: array
items:
$ref: '#/components/schemas/EquipmentHistoryItem'
title: Items
required:
- items
Equipment:
type: object
properties:
resourceType:
type: string
enum:
- Equipment
resourceId:
type: integer
uuid:
type: string
description: UUID that complements the legacy numeric resourceId.
equipmentInitial:
type: string
equipmentNumber:
type: integer
aarCarType:
type: string
equipmentType:
type: string
enum:
- CAR
- LOCOMOTIVE
- CABOOSE
- TRAIN_DEVICE
descriptionCode:
type: string
arrivalState:
type: string
enum:
- INBOUND
- ONLINE
- OUTBOUND
parentGroupings:
type: array
items:
$ref: '#/components/schemas/EquipmentParentGrouping'
waybill:
$ref: '#/components/schemas/Waybill'
umler:
$ref: '#/components/schemas/UmlerCommon'
notes:
type: string
intermodalUnits:
type: array
items:
$ref: '#/components/schemas/IntermodalUnitResource'
loadStatus:
type: string
enum:
- LOAD
- EMPTY
- UNKNOWN
ichrTime:
type: string
format: date-time
workOrder:
$ref: '#/components/schemas/WorkOrderResource'
workOrders:
type: array
items:
$ref: '#/components/schemas/WorkOrderResource'
EquipmentParentGrouping:
type: object
properties:
resourceType:
type: string
enum:
- Grouping
resourceId:
type: integer
uuid:
type: string
description: UUID that complements the legacy numeric resourceId.
name:
type: string
groupingType:
type: string
sortOrder:
type: integer
colorToken:
type: string
groupingIndex:
type: integer
CrossReferenceEquipment:
type: object
properties:
referenceIdQualifier:
type: string
referenceId:
type: string
equipmentInitial:
type: string
equipmentNumber:
type: integer
crossReferenceTypeCode:
type: string
enum:
- A
- B
- C
- F
- G
- K
- L
- M
- T
equipmentOwnerScac:
type: string
equipmentLength:
type: string
equipmentOperatorScac:
type: string
equipmentIsDamaged:
type: boolean
checkDigit:
type: integer
AdministrativeContact:
type: object
properties:
contactFunctionCode:
type: string
name:
type: string
communicationNumbers:
type: array
items:
$ref: '#/components/schemas/CommunicationNumber'
contactInquiryReference:
type: string
Party:
type: object
properties:
partyType:
type: string
enum:
- '11'
- AO
- AP
- AQ
- BN
- BT
- C1
- CB
- CD
- CE
- CH
- CN
- CV
- DH
- DM
- FW
- HW
- HX
- HZ
- IM
- MC
- N1
- OH
- OM
- PF
- PU
- PV
- RP
- SF
- SH
- SS
- ST
- SU
- TR
- UC
- XB
- XQ
- XR
- XU
- ZS
name:
type: string
idCodeQualifier:
type: string
enum:
- '1'
- '2'
- '9'
- '12'
- '17'
- '20'
- AB
- AI
- BF
- BN
- C5
- FI
- IN
- M5
- '93'
idCode:
type: string
entitySubIdentifierRelationshipCode:
type: string
entitySubIdentifierCode:
type: string
additionalNames:
type: array
items:
type: string
address:
type: array
items:
type: string
cityName:
type: string
stateOrProvince:
type: string
postalCode:
type: string
countryCode:
type: string
locationQualifier:
type: string
locationIdentifier:
type: string
countrySubdivisionCode:
type: string
administrativeContacts:
type: array
items:
$ref: '#/components/schemas/AdministrativeContact'
billingInfo:
type: array
items:
$ref: '#/components/schemas/BillingInformation'
referenceInfo:
type: array
items:
$ref: '#/components/schemas/ReferenceInfo'
BillingInformation:
type: object
properties:
rebillReasonCode:
type: string
enum:
- RC
- RD
origin:
$ref: '#/components/schemas/Station'
destination:
$ref: '#/components/schemas/Station'
carrierCodes:
type: array
items:
type: string
HazmatShippingNameInformation:
type: object
properties:
hazmatShippingName:
type: string
hazmatShippingNameQualifier:
type: string
enum:
- C
- D
- I
nosIndicatorCode:
type: string
railSafetySensitiveMaterial:
type: boolean
TransborderHazardousRequirements:
type: object
properties:
hazardousClassification:
type: string
hazardousPlacardNotation:
type: string
hazardousEndorsement:
type: string
Terminal:
type: object
description: Port or terminal location on equipment (X12 R4).
properties:
terminalFunctionCode:
type: string
enum:
- '1'
- '5'
- '6'
- '7'
- D
- E
- I
- L
- M
- P
- R
locationQualifier:
type: string
enum:
- CS
-
# --- truncated at 32 KB (51 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/cedarai/refs/heads/main/openapi/cedarai-equipment-history-api-openapi.yml