POST api/Edi/Railcar/SaveRailcar

Use this method to create or update a railcar record.

Request Information

URI Parameters

None.

Body Parameters

SaveEdiRailcarRequest
NameDescriptionTypeAdditional information
CompanyCode

This should be either "15" for Frontier Logistics or "73" for Mission Rail.

 string

None.
RawCustomerId

This should be the raw customer ID as received in the EDI t-set, CSV file, etc.

 string

None.
ActualCustomerId

If the RawCustomerId was able to be translated to an actual customer ID, then it should be specified here. Otherwise, this value should be left blank.

 string

None.
RailcarLabel

This is the identifier for the railcar.

 string

None.
RawEquipmentSubtype

If the EDI contains some kind of code to indicate what type of railcar is being shipped, then include it here. Otherwise, this value should be left blank.

 string

None.
EquipmentSubtypeIdNo

If the subtype of the railcar can be inferred from the RawEquipmentSubtype, then it should be included here. Otherwise, this value should be left blank.

 integer

None.
IsEmpty

If the EDI indicates that the railcar is empty, then set this value to true. Otherwise, set this value to false.

 boolean

None.
RawCarrierOrRoute

If the EDI indicates which railroad or railcar route the shipper will use for the railcar, it should be included here.

 string

None.
CarrierIdNo

If the RawCarrierOrRoute value can be translated to the CarrierIdNo value for the specific railroad, then specify it here.

 integer

None.
OriginDescription

Some railcar notifications include a description of the origin. This field is used to collect that information.

 string

None.
OnHoldReason

Rarely, a shipper will mark a railcar to be held post-arrival. If that is the case, this reason code for holding the railcar should be noted here.

 string

None.
CustomerOrderNo

The delivery number, shipment ID, etc. from the customer's system that is used to authorize the movement of the railcar.

 string

None.
DestinationDescriptionOrCode

Some customers have specific codes for our locations and others simply have a strong description. If a code is available, that is preferred. Otherwise, the description should be sent.

 string

None.
DestinationGeoLocationIdNo

The DestinationDescriptionOrCode should be translatable into a numeric value identifying the GeoLocation in our system which must be included here.

 integer

None.
DateTimeNotified

The Date/Time that the electronic communication was originally received.

 date

None.
DateTimeShipped

The shipper's notification should include the Date/Time when the railcar shipped (or will be shipped).

 date

None.
Priority

If the shipper has a prioritization for the railcar, it should be specified here. Otherwise, the system will set the railcar to a default priority of Normal - 3.

 EqPriority

None.

Request Formats

application/json, text/json

Sample: 
{
  "CompanyCode": "sample string 1",
  "RawCustomerId": "sample string 2",
  "ActualCustomerId": "sample string 3",
  "RailcarLabel": "sample string 4",
  "RawEquipmentSubtype": "sample string 5",
  "EquipmentSubtypeIdNo": 1,
  "IsEmpty": true,
  "RawCarrierOrRoute": "sample string 6",
  "CarrierIdNo": 1,
  "OriginDescription": "sample string 7",
  "OnHoldReason": "sample string 8",
  "CustomerOrderNo": "sample string 9",
  "DestinationDescriptionOrCode": "sample string 10",
  "DestinationGeoLocationIdNo": 11,
  "DateTimeNotified": "2025-06-18T10:17:50.9137111-05:00",
  "DateTimeShipped": "2025-06-18T10:17:50.9137111-05:00",
  "Priority": null
}

text/html

Sample: 
{"CompanyCode":"sample string 1","RawCustomerId":"sample string 2","ActualCustomerId":"sample string 3","RailcarLabel":"sample string 4","RawEquipmentSubtype":"sample string 5","EquipmentSubtypeIdNo":1,"IsEmpty":true,"RawCarrierOrRoute":"sample string 6","CarrierIdNo":1,"OriginDescription":"sample string 7","OnHoldReason":"sample string 8","CustomerOrderNo":"sample string 9","DestinationDescriptionOrCode":"sample string 10","DestinationGeoLocationIdNo":11,"DateTimeNotified":"2025-06-18T10:17:50.9137111-05:00","DateTimeShipped":"2025-06-18T10:17:50.9137111-05:00","Priority":null}

Response Information

Resource Description

SaveEdiRailcarResponse
NameDescriptionTypeAdditional information
EquipmentIdNo

Indicates the EquipmentIdNo of the railcar record that was created or updated by the Save method.

 integer

None.
ActionTaken

Returns either Created, Updated, or None depending on the action taken by the Save method.

 string

None.

Response Formats

application/json, text/json, text/html

Sample:

Sample not available.