Railcar API
Update equipment notes
Updates notes on one or more pieces of equipment.
Usage notes:
- Use equipmentIds + notes for bulk updates (same note on multiple equipment).
- Use the updates array for per-equipment notes (different note per equipment).
- Pass null for the note value to clear an existing note.
- Notes are limited to 280 characters.
- The response returns the updated equipment objects with third-party visible fields.
Permission required: inventoryManagement.equipment.updateNotes
POST
/
ims
/
equipment
/
notes
/
update
curl --request POST \
--url https://api-lg.arms.cedarai.com/ims/equipment/notes/update \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"carrierId": 1234,
"equipmentIds": [
100,
200,
300
],
"notes": "Needs inspection before loading"
}
'{
"equipment": [
{
"resourceType": "Equipment",
"resourceId": 123,
"uuid": "<string>",
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"aarCarType": "<string>",
"descriptionCode": "<string>",
"parentGroupings": [
{
"resourceType": "Grouping",
"resourceId": 123,
"uuid": "<string>",
"name": "<string>",
"groupingType": "<string>",
"sortOrder": 123,
"colorToken": "<string>",
"groupingIndex": 123
}
],
"waybill": {
"loadStatus": "<string>",
"commodityCode": "<string>",
"netWeightTons": 123,
"originCityName": "<string>",
"originStateOrProvince": "<string>",
"originFsac": "<string>",
"destinationCityName": "<string>",
"destinationStateOrProvince": "<string>",
"destinationFsac": "<string>",
"consignorCustomerName": "<string>",
"consigneeCustomerName": "<string>",
"originScac": "<string>",
"shipmentId": "<string>",
"customsDocumentationHandlingCode": "<string>",
"taxReasonCode": "<string>",
"referencedPatternIdentifier": "<string>",
"repetitivePatternNumber": 123,
"extendedReferenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"date": "<string>",
"timestamp": "<string>"
}
],
"crossReferenceEquipment": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"equipmentOwnerScac": "<string>",
"equipmentLength": "<string>",
"equipmentOperatorScac": "<string>",
"equipmentIsDamaged": true,
"checkDigit": 123
}
],
"equipmentDetails": [
{
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"netWeightLbs": 123,
"grossWeightLbs": 123,
"tareWeightLbs": 123,
"weightAllowance": 123,
"dunnage": 123,
"descriptionCode": "<string>",
"owningCarrierCode": "<string>",
"position": "<string>",
"lengthIn": 123,
"checkDigit": 123,
"heightIn": 123,
"widthIn": 123,
"isoContainerCode": "<string>",
"carrierCode": "<string>",
"aarCarType": "<string>",
"sealNumbers": [
"<string>"
],
"chassisInitial": "<string>",
"chassisNumber": 123,
"terminals": [
{
"locationIdentifier": "<string>",
"portName": "<string>"
}
],
"interchangeMoveAuthorities": [
{
"carrierCode": "<string>"
}
],
"shipmentInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"extendedReferenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"date": "<string>",
"timestamp": "<string>"
}
],
"lineItems": [
{
"quantity": 123,
"commodityDescription": "<string>",
"marksAndNumbers": "<string>",
"commodityCode": "<string>",
"customsShipmentValue": 123,
"weight": 123,
"cbpBarcodeNumber": "<string>",
"smallestExteriorPackageType": "<string>",
"originCountryCode": "<string>",
"destinationCountryCode": "<string>",
"currencyCode": "<string>"
}
]
}
]
}
],
"intermodalStatusDetails": {
"shipmentStatusTime": "<string>"
},
"specialHandlingCodes": [
"<string>"
],
"protectiveService": [
{
"ruleCode": "<string>",
"optimalTemperature": 123,
"scac": "<string>",
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"precooled": true,
"originTemperature": 123
}
],
"originStation": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"originJunction": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destinationStation": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destinationJunction": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"parties": [
{
"name": "<string>",
"idCode": "<string>",
"entitySubIdentifierRelationshipCode": "<string>",
"entitySubIdentifierCode": "<string>",
"additionalNames": [
"<string>"
],
"address": [
"<string>"
],
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"locationQualifier": "<string>",
"locationIdentifier": "<string>",
"countrySubdivisionCode": "<string>",
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
],
"route": [
{
"carrierCode": "<string>",
"junctionCode": "<string>",
"splc": "<string>",
"intermodalServiceCode": "<string>",
"additionalSwitchCarrierCodes": [
"<string>"
]
}
],
"emptyCarDispositions": [
{
"destinationConsigneeName": "<string>",
"destinationConsigneeIdQualifier": "<string>",
"destinationConsigneeId": "<string>",
"destinationCityName": "<string>",
"destinationStateOrProvince": "<string>",
"destinationPostalCode": "<string>",
"destinationCountryCode": "<string>",
"destinationAddress": "<string>",
"destinationRoute": [
{
"carrierCode": "<string>",
"junctionCode": "<string>",
"splc": "<string>",
"intermodalServiceCode": "<string>",
"additionalSwitchCarrierCodes": [
"<string>"
]
}
]
}
],
"lineItems": [
{
"number": 123,
"descriptions": [
{
"ladingDescription": "<string>",
"commodityCode": "<string>",
"packagingCode": "<string>",
"marksAndNumbers": "<string>",
"marksAndNumbersQualifier": "<string>",
"hazmatRatingCommodityCodeQualifier": "<string>",
"hazmatRatingCommodityCode": "<string>",
"compartmentIdCode": "<string>"
}
],
"quantity": {
"billedAsQuantity": 123,
"weight": 123,
"volume": 123,
"ladingQuantity": 123,
"packagingFormCode": "<string>",
"dunnageDescription": "<string>",
"weightUnitCode": "<string>",
"typeOfServiceCode": "<string>"
},
"measurements": [
{
"measurementReferenceIdCode": "<string>",
"measurementQualifier": "<string>",
"measurementValue": 123,
"rangeMinimum": 123,
"rangeMaximum": 123,
"measurementSignificanceCode": "<string>",
"measurementAttributeCode": "<string>",
"surfaceLayerPositionCode": "<string>",
"measurementMethodOrDevice": "<string>",
"codeListQualifier": "<string>",
"industryCode": "<string>"
}
],
"priceAuthorities": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"primaryPublicationAuthority": "<string>",
"regulatoryAgencyCode": "<string>",
"tariffAgencyCode": "<string>",
"issuingCarrierIdentifier": "<string>",
"suffix": "<string>",
"itemNumber": "<string>",
"supplementIdentifier": "<string>",
"sectionNumber": "<string>",
"itemNumberSuffix": "<string>",
"effectiveDate": "<string>",
"expirationDate": "<string>"
}
]
}
],
"hazardousInfo": [
{
"ladingUnitCode": "<unknown>",
"ladingQuantity": 123,
"unIdCode": "<string>",
"unPageNumber": "<string>",
"commodityCode": "<string>",
"unitCode": "<unknown>",
"quantity": 123,
"compartmentIdCode": "<string>",
"residueIndicatorCode": "<string>",
"packagingGroupCode": "<string>",
"interimHazmatRegulatoryNumber": "<string>",
"industryCode": "<string>",
"classificationInfo": [
{
"hazardousClass": "<string>",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>",
"reportableQuantityCode": "RQ",
"flashpointUnitCode": "<unknown>",
"flashpointTemperature": 123,
"controlUnitCode": "<unknown>",
"controlTemperature": 123,
"emergencyUnitCode": "<unknown>",
"emergencyTemperature": 123,
"netExplosiveWeightUnitCode": "<string>",
"netExplosiveWeight": 123
}
],
"hazmatShippingNameInfo": [
{
"hazmatShippingName": "<string>",
"nosIndicatorCode": "<string>",
"railSafetySensitiveMaterial": true
}
],
"hazmatAdditionalInfo": [
{
"hazmatShippingInfo": "<string>",
"hazmatShippingInfoOverflow": "<string>",
"hazardZoneCode": "<string>",
"radioactiveActivity": 123,
"radioactiveTransportIndex": 123,
"fumigationDate": "<string>"
}
],
"epaRequiredData": [
{
"epaWasteStreamNumberCode": "<string>",
"wasteCharacteristicsCode": "<string>",
"hazardousWasteNumberStateOrProvince": "<string>",
"hazardousWasteNumber": "<string>"
}
],
"canadianDangerousRequirements": [
{
"emergencyResponsePlanNumber": "<string>",
"communicationNumber": "<string>",
"packagingGroupCode": "<string>",
"firstSubsidiaryClassification": "<string>",
"secondSubsidiaryClassification": "<string>",
"thirdSubsidiaryClassification": "<string>",
"subsidiaryRiskIndicator": "<string>",
"netExplosiveQuantity": 123,
"canadianHazardousNotation": "<string>",
"specialCommodityIndicatorCode": "<string>",
"additionalCommunicationNumber": "<string>",
"netExplosiveQuantityUnitCode": "<unknown>",
"hazmatShipmentInfoQualifier": "<string>",
"hazmatQuantity": 123,
"hazmatQuantityUnitCode": "<unknown>"
}
],
"transborderHazardousRequirements": [
{
"hazardousClassification": "<string>",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>"
}
],
"hazmatReferenceNumbers": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"date": "<string>"
}
],
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"parties": [
{
"name": "<string>",
"idCode": "<string>",
"entitySubIdentifierRelationshipCode": "<string>",
"entitySubIdentifierCode": "<string>",
"additionalNames": [
"<string>"
],
"address": [
"<string>"
],
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"locationQualifier": "<string>",
"locationIdentifier": "<string>",
"countrySubdivisionCode": "<string>",
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
]
}
],
"hazardousCertifications": [
{
"name": "<string>"
}
],
"release": {
"releaseDate": "<string>",
"releaseTime": "<string>"
},
"defaultReceiver": "<string>",
"waybillTemplateId": 123,
"waybillTemplateName": "<string>",
"waybillNumberSuffix": "<string>",
"originCarrierCode": "<string>",
"consigneeLocationId": 123,
"shipperLocationId": 123,
"inCareOfLocationId": 123,
"freightBillPartyLocationId": 123,
"pickupPartyLocationId": 123,
"waybillNumber": 123,
"waybillDate": "<string>",
"billOfLadingNumber": "<string>",
"preparationDate": "<string>",
"preparationTime": "<string>",
"revisionNumber": 123,
"revisionTime": "<string>",
"armsTrackingId": "<string>",
"resourceType": "Waybill",
"resourceId": 123,
"uuid": "<string>",
"createdAt": "<string>",
"tags": {}
},
"umler": {
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"car": "<string>",
"mechanicalDesignation": "<string>",
"owner": "<string>",
"elementEquipmentGroup": "<string>",
"lessee": "<string>",
"markOwnerCategory": "<string>",
"outsideLength": 123,
"outsideLengthFt": 123,
"isIntl": true,
"grossRailWeight": 123,
"grossRailWeightLb": 123,
"loadLimit": 123,
"cubicFeetCapacity": 123,
"tareWeight": 123,
"tareWeightLb": 123,
"plateCode": "<string>",
"insideLength": 123,
"insideLengthFt": 123,
"insideHeight": 123,
"insideHeightFt": 123,
"outsideExtremeWidth": 123,
"outsideExtremeWidthFt": 123,
"outerExtremeHeight": 123,
"outerExtremeHeightFt": 123,
"outsideHeightExtremeWidth": 123,
"outsideHeightExtremeWidthFt": 123,
"sideDoorType": "<string>",
"sideDoorHeight": 123,
"sideDoorHeightFt": 123,
"sideDoorWidth": 123,
"sideDoorWidthFt": 123,
"boxSideDoorOrientation": "<string>",
"axleCount": 123,
"brakeShoeType": "<string>",
"bodyMaterial": "<string>",
"operatingBrakes": 123,
"floorStrengthClassification": "<string>",
"poolNumber": "<string>",
"endOfTrainOnly": "<string>",
"shoveCarToRest": "<string>",
"shoveAdjCarToRest": "<string>",
"trainPositionSensitive": "<string>",
"couplerStyle": "<string>",
"unitEquipmentGroup": "<string>",
"abtDueDate": "<string>",
"carGrade": "<string>",
"lengthFt": 123,
"brakeWeightLb": 123,
"netWeightLb": 123,
"allowedSpeed": "<string>",
"regionCode": "<string>",
"vkm": "<string>",
"vkmValidTo": "2023-12-25",
"resp": "<string>",
"responsibleValidTo": "2023-12-25",
"damages": [
{
"reportId": "<string>",
"damageStatus": 123,
"damageCode": "<string>",
"damageDescription": "<string>",
"damageIsNew": true,
"eventTimestamp": "2023-11-07T05:31:56Z"
}
]
},
"notes": "<string>",
"intermodalUnits": [
{
"resourceType": "IntermodalUnit",
"resourceId": 123,
"uuid": "<string>"
}
],
"ichrTime": "2023-11-07T05:31:56Z",
"workOrder": {
"resourceId": 123,
"uuid": "<string>",
"workOrderId": "<string>",
"trainId": "<string>",
"inTransit": true,
"lastEventId": 123,
"hasBeenDeparted": true
},
"workOrders": [
{
"resourceId": 123,
"uuid": "<string>",
"workOrderId": "<string>",
"trainId": "<string>",
"inTransit": true,
"lastEventId": 123,
"hasBeenDeparted": true
}
]
}
]
}{
"message": "<string>"
}Authorizations
Your ARMS API key
Email of a user assigned to the appropriate user group
Query Parameters
Carrier identifier; required for all endpoints
Optional user group context
Body
application/json
Request body for updating equipment notes. Provide either (equipmentIds + notes) for bulk updates, or an updates array for per-equipment notes.
Carrier identifier.
List of equipment IDs to update with the same note. Used with the notes field.
Note text to apply to all equipmentIds.
Maximum string length:
280Per-equipment note updates. Use this for setting different notes on different equipment.
Show child attributes
Show child attributes
Response
OK
Response after updating equipment notes.
Updated equipment objects with new notes.
Show child attributes
Show child attributes
Related topics
API IntroductionUpdate a noteUpdate railcar inventory (move equipment)NotesUpdate bill of ladingWas this page helpful?
⌘I
curl --request POST \
--url https://api-lg.arms.cedarai.com/ims/equipment/notes/update \
--header 'Content-Type: application/json' \
--header 'x-arms-api-key: <api-key>' \
--header 'x-arms-assume-user: <api-key>' \
--data '
{
"carrierId": 1234,
"equipmentIds": [
100,
200,
300
],
"notes": "Needs inspection before loading"
}
'{
"equipment": [
{
"resourceType": "Equipment",
"resourceId": 123,
"uuid": "<string>",
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"aarCarType": "<string>",
"descriptionCode": "<string>",
"parentGroupings": [
{
"resourceType": "Grouping",
"resourceId": 123,
"uuid": "<string>",
"name": "<string>",
"groupingType": "<string>",
"sortOrder": 123,
"colorToken": "<string>",
"groupingIndex": 123
}
],
"waybill": {
"loadStatus": "<string>",
"commodityCode": "<string>",
"netWeightTons": 123,
"originCityName": "<string>",
"originStateOrProvince": "<string>",
"originFsac": "<string>",
"destinationCityName": "<string>",
"destinationStateOrProvince": "<string>",
"destinationFsac": "<string>",
"consignorCustomerName": "<string>",
"consigneeCustomerName": "<string>",
"originScac": "<string>",
"shipmentId": "<string>",
"customsDocumentationHandlingCode": "<string>",
"taxReasonCode": "<string>",
"referencedPatternIdentifier": "<string>",
"repetitivePatternNumber": 123,
"extendedReferenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"date": "<string>",
"timestamp": "<string>"
}
],
"crossReferenceEquipment": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"equipmentOwnerScac": "<string>",
"equipmentLength": "<string>",
"equipmentOperatorScac": "<string>",
"equipmentIsDamaged": true,
"checkDigit": 123
}
],
"equipmentDetails": [
{
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"netWeightLbs": 123,
"grossWeightLbs": 123,
"tareWeightLbs": 123,
"weightAllowance": 123,
"dunnage": 123,
"descriptionCode": "<string>",
"owningCarrierCode": "<string>",
"position": "<string>",
"lengthIn": 123,
"checkDigit": 123,
"heightIn": 123,
"widthIn": 123,
"isoContainerCode": "<string>",
"carrierCode": "<string>",
"aarCarType": "<string>",
"sealNumbers": [
"<string>"
],
"chassisInitial": "<string>",
"chassisNumber": 123,
"terminals": [
{
"locationIdentifier": "<string>",
"portName": "<string>"
}
],
"interchangeMoveAuthorities": [
{
"carrierCode": "<string>"
}
],
"shipmentInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"extendedReferenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>",
"date": "<string>",
"timestamp": "<string>"
}
],
"lineItems": [
{
"quantity": 123,
"commodityDescription": "<string>",
"marksAndNumbers": "<string>",
"commodityCode": "<string>",
"customsShipmentValue": 123,
"weight": 123,
"cbpBarcodeNumber": "<string>",
"smallestExteriorPackageType": "<string>",
"originCountryCode": "<string>",
"destinationCountryCode": "<string>",
"currencyCode": "<string>"
}
]
}
]
}
],
"intermodalStatusDetails": {
"shipmentStatusTime": "<string>"
},
"specialHandlingCodes": [
"<string>"
],
"protectiveService": [
{
"ruleCode": "<string>",
"optimalTemperature": 123,
"scac": "<string>",
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"precooled": true,
"originTemperature": 123
}
],
"originStation": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"originJunction": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destinationStation": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destinationJunction": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"parties": [
{
"name": "<string>",
"idCode": "<string>",
"entitySubIdentifierRelationshipCode": "<string>",
"entitySubIdentifierCode": "<string>",
"additionalNames": [
"<string>"
],
"address": [
"<string>"
],
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"locationQualifier": "<string>",
"locationIdentifier": "<string>",
"countrySubdivisionCode": "<string>",
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
],
"route": [
{
"carrierCode": "<string>",
"junctionCode": "<string>",
"splc": "<string>",
"intermodalServiceCode": "<string>",
"additionalSwitchCarrierCodes": [
"<string>"
]
}
],
"emptyCarDispositions": [
{
"destinationConsigneeName": "<string>",
"destinationConsigneeIdQualifier": "<string>",
"destinationConsigneeId": "<string>",
"destinationCityName": "<string>",
"destinationStateOrProvince": "<string>",
"destinationPostalCode": "<string>",
"destinationCountryCode": "<string>",
"destinationAddress": "<string>",
"destinationRoute": [
{
"carrierCode": "<string>",
"junctionCode": "<string>",
"splc": "<string>",
"intermodalServiceCode": "<string>",
"additionalSwitchCarrierCodes": [
"<string>"
]
}
]
}
],
"lineItems": [
{
"number": 123,
"descriptions": [
{
"ladingDescription": "<string>",
"commodityCode": "<string>",
"packagingCode": "<string>",
"marksAndNumbers": "<string>",
"marksAndNumbersQualifier": "<string>",
"hazmatRatingCommodityCodeQualifier": "<string>",
"hazmatRatingCommodityCode": "<string>",
"compartmentIdCode": "<string>"
}
],
"quantity": {
"billedAsQuantity": 123,
"weight": 123,
"volume": 123,
"ladingQuantity": 123,
"packagingFormCode": "<string>",
"dunnageDescription": "<string>",
"weightUnitCode": "<string>",
"typeOfServiceCode": "<string>"
},
"measurements": [
{
"measurementReferenceIdCode": "<string>",
"measurementQualifier": "<string>",
"measurementValue": 123,
"rangeMinimum": 123,
"rangeMaximum": 123,
"measurementSignificanceCode": "<string>",
"measurementAttributeCode": "<string>",
"surfaceLayerPositionCode": "<string>",
"measurementMethodOrDevice": "<string>",
"codeListQualifier": "<string>",
"industryCode": "<string>"
}
],
"priceAuthorities": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"primaryPublicationAuthority": "<string>",
"regulatoryAgencyCode": "<string>",
"tariffAgencyCode": "<string>",
"issuingCarrierIdentifier": "<string>",
"suffix": "<string>",
"itemNumber": "<string>",
"supplementIdentifier": "<string>",
"sectionNumber": "<string>",
"itemNumberSuffix": "<string>",
"effectiveDate": "<string>",
"expirationDate": "<string>"
}
]
}
],
"hazardousInfo": [
{
"ladingUnitCode": "<unknown>",
"ladingQuantity": 123,
"unIdCode": "<string>",
"unPageNumber": "<string>",
"commodityCode": "<string>",
"unitCode": "<unknown>",
"quantity": 123,
"compartmentIdCode": "<string>",
"residueIndicatorCode": "<string>",
"packagingGroupCode": "<string>",
"interimHazmatRegulatoryNumber": "<string>",
"industryCode": "<string>",
"classificationInfo": [
{
"hazardousClass": "<string>",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>",
"reportableQuantityCode": "RQ",
"flashpointUnitCode": "<unknown>",
"flashpointTemperature": 123,
"controlUnitCode": "<unknown>",
"controlTemperature": 123,
"emergencyUnitCode": "<unknown>",
"emergencyTemperature": 123,
"netExplosiveWeightUnitCode": "<string>",
"netExplosiveWeight": 123
}
],
"hazmatShippingNameInfo": [
{
"hazmatShippingName": "<string>",
"nosIndicatorCode": "<string>",
"railSafetySensitiveMaterial": true
}
],
"hazmatAdditionalInfo": [
{
"hazmatShippingInfo": "<string>",
"hazmatShippingInfoOverflow": "<string>",
"hazardZoneCode": "<string>",
"radioactiveActivity": 123,
"radioactiveTransportIndex": 123,
"fumigationDate": "<string>"
}
],
"epaRequiredData": [
{
"epaWasteStreamNumberCode": "<string>",
"wasteCharacteristicsCode": "<string>",
"hazardousWasteNumberStateOrProvince": "<string>",
"hazardousWasteNumber": "<string>"
}
],
"canadianDangerousRequirements": [
{
"emergencyResponsePlanNumber": "<string>",
"communicationNumber": "<string>",
"packagingGroupCode": "<string>",
"firstSubsidiaryClassification": "<string>",
"secondSubsidiaryClassification": "<string>",
"thirdSubsidiaryClassification": "<string>",
"subsidiaryRiskIndicator": "<string>",
"netExplosiveQuantity": 123,
"canadianHazardousNotation": "<string>",
"specialCommodityIndicatorCode": "<string>",
"additionalCommunicationNumber": "<string>",
"netExplosiveQuantityUnitCode": "<unknown>",
"hazmatShipmentInfoQualifier": "<string>",
"hazmatQuantity": 123,
"hazmatQuantityUnitCode": "<unknown>"
}
],
"transborderHazardousRequirements": [
{
"hazardousClassification": "<string>",
"hazardousPlacardNotation": "<string>",
"hazardousEndorsement": "<string>"
}
],
"hazmatReferenceNumbers": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"date": "<string>"
}
],
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"parties": [
{
"name": "<string>",
"idCode": "<string>",
"entitySubIdentifierRelationshipCode": "<string>",
"entitySubIdentifierCode": "<string>",
"additionalNames": [
"<string>"
],
"address": [
"<string>"
],
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"locationQualifier": "<string>",
"locationIdentifier": "<string>",
"countrySubdivisionCode": "<string>",
"administrativeContacts": [
{
"contactFunctionCode": "<string>",
"name": "<string>",
"communicationNumbers": [
{
"qualifier": "<string>",
"number": "<string>"
}
],
"contactInquiryReference": "<string>"
}
],
"billingInfo": [
{
"origin": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"destination": {
"fsac": "<string>",
"cityName": "<string>",
"stateOrProvince": "<string>",
"postalCode": "<string>",
"countryCode": "<string>",
"splc": "<string>"
},
"carrierCodes": [
"<string>"
]
}
],
"referenceInfo": [
{
"referenceIdQualifier": "<string>",
"referenceId": "<string>",
"description": "<string>"
}
]
}
]
}
],
"hazardousCertifications": [
{
"name": "<string>"
}
],
"release": {
"releaseDate": "<string>",
"releaseTime": "<string>"
},
"defaultReceiver": "<string>",
"waybillTemplateId": 123,
"waybillTemplateName": "<string>",
"waybillNumberSuffix": "<string>",
"originCarrierCode": "<string>",
"consigneeLocationId": 123,
"shipperLocationId": 123,
"inCareOfLocationId": 123,
"freightBillPartyLocationId": 123,
"pickupPartyLocationId": 123,
"waybillNumber": 123,
"waybillDate": "<string>",
"billOfLadingNumber": "<string>",
"preparationDate": "<string>",
"preparationTime": "<string>",
"revisionNumber": 123,
"revisionTime": "<string>",
"armsTrackingId": "<string>",
"resourceType": "Waybill",
"resourceId": 123,
"uuid": "<string>",
"createdAt": "<string>",
"tags": {}
},
"umler": {
"equipmentInitial": "<string>",
"equipmentNumber": 123,
"car": "<string>",
"mechanicalDesignation": "<string>",
"owner": "<string>",
"elementEquipmentGroup": "<string>",
"lessee": "<string>",
"markOwnerCategory": "<string>",
"outsideLength": 123,
"outsideLengthFt": 123,
"isIntl": true,
"grossRailWeight": 123,
"grossRailWeightLb": 123,
"loadLimit": 123,
"cubicFeetCapacity": 123,
"tareWeight": 123,
"tareWeightLb": 123,
"plateCode": "<string>",
"insideLength": 123,
"insideLengthFt": 123,
"insideHeight": 123,
"insideHeightFt": 123,
"outsideExtremeWidth": 123,
"outsideExtremeWidthFt": 123,
"outerExtremeHeight": 123,
"outerExtremeHeightFt": 123,
"outsideHeightExtremeWidth": 123,
"outsideHeightExtremeWidthFt": 123,
"sideDoorType": "<string>",
"sideDoorHeight": 123,
"sideDoorHeightFt": 123,
"sideDoorWidth": 123,
"sideDoorWidthFt": 123,
"boxSideDoorOrientation": "<string>",
"axleCount": 123,
"brakeShoeType": "<string>",
"bodyMaterial": "<string>",
"operatingBrakes": 123,
"floorStrengthClassification": "<string>",
"poolNumber": "<string>",
"endOfTrainOnly": "<string>",
"shoveCarToRest": "<string>",
"shoveAdjCarToRest": "<string>",
"trainPositionSensitive": "<string>",
"couplerStyle": "<string>",
"unitEquipmentGroup": "<string>",
"abtDueDate": "<string>",
"carGrade": "<string>",
"lengthFt": 123,
"brakeWeightLb": 123,
"netWeightLb": 123,
"allowedSpeed": "<string>",
"regionCode": "<string>",
"vkm": "<string>",
"vkmValidTo": "2023-12-25",
"resp": "<string>",
"responsibleValidTo": "2023-12-25",
"damages": [
{
"reportId": "<string>",
"damageStatus": 123,
"damageCode": "<string>",
"damageDescription": "<string>",
"damageIsNew": true,
"eventTimestamp": "2023-11-07T05:31:56Z"
}
]
},
"notes": "<string>",
"intermodalUnits": [
{
"resourceType": "IntermodalUnit",
"resourceId": 123,
"uuid": "<string>"
}
],
"ichrTime": "2023-11-07T05:31:56Z",
"workOrder": {
"resourceId": 123,
"uuid": "<string>",
"workOrderId": "<string>",
"trainId": "<string>",
"inTransit": true,
"lastEventId": 123,
"hasBeenDeparted": true
},
"workOrders": [
{
"resourceId": 123,
"uuid": "<string>",
"workOrderId": "<string>",
"trainId": "<string>",
"inTransit": true,
"lastEventId": 123,
"hasBeenDeparted": true
}
]
}
]
}{
"message": "<string>"
}