Requests

Haul Away Gate Exit Request – Allow truckers and/or dispatchers to submit load details AT outgate.

post/v1/exit-request

Request

Request body

carrierScacstring required

SCAC (Standard Carrier Alpha Code) consists of a two to four character alpha abbreviation used to designate a transportation company. SCACs are assigned by NMFTA (National Motor Freight Traffic Association).

driverLicensestring required

A value assigned to identify a haulaway truck driver. Value may be a Driver License Number or a value assigned by a haulaway carrier itself.

gatePassCodestring required

Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique.

loadNumberstring required

Identification of a specific load as assigned by the haulaway carrier itself. As the value is assigned externally it may or may not be unique.

outGateLocationstring required

Code assigned by the AAR (Association Of American Railroads) that uniquely identifies automotive ramps used in loading and unloading trains throughout North America.

trailerNumberstring required

Identification number assigned to a Trailer (part of a tractor trailer) as supplied by the haulaway carrier.

truckNumberstring required

Identification number assigned to a Truck (part of a tractor trailer) as supplied by the haulaway carrier.

Example request

{
  "carrierScac": "SPMA",
  "driverLicense": "16435",
  "gatePassCode": "552IRB",
  "loadNumber": "389772",
  "loadedVehicles": [
    {
      "damages": [
        {
          "location": "25",
          "severity": "2",
          "type": "2"
        }
      ],
      "vin": "4JGFB4FB0TB515072"
    }
  ],
  "outGateLocation": "CA052",
  "trailerNumber": "PLANOBM",
  "truckNumber": "1102"
}

Response

OK

The request has succeeded.

haulPassstring

The gate pass ID is assigned by a haulaway carrier. As there are multiple haulaway carriers, this value is not guaranteed to be unique across all haulers, therefore duplicate values are possible.

Example response

{
  "errors": [
    {
      "code": "0000",
      "message": "Vin is valid and present in table",
      "vin": "4JGFB4FB0TB515072"
    }
  ],
  "gateExitRequestFromHaulaway": {
    "carrierScac": "SPMA",
    "driverLicense": "16435",
    "gatePassCode": "552IRB",
    "loadNumber": "389772",
    "loadedVehicles": [
      {
        "damages": [
          {
            "location": "25",
            "severity": "2",
            "type": "2"
          }
        ],
        "vin": "4JGFB4FB0TB515072"
      }
    ],
    "outGateLocation": "CA052",
    "trailerNumber": "PLANOBM",
    "truckNumber": "1102"
  },
  "haulPass": "AIL6YJ"
}

Changes

No recorded changes to this operation across all 1 revision of this API.