POST Derived Route Reports

Contents

A derived route is the estimated route a vehicle took based on a series of latitude/longitude pings. This API can return either a Mileage or a Detailed report for the route.

POST /derivedRoute/routeReports?dataset={dataset} #

Request Element #

The PostDerivedRouteReports request requires a JSON formatted ReduceTripRequestBody object in the POST body.

Element Definition Required
ReduceTripRequestBody A ReduceTripRequestBody System Object. It contains a collection of trip pings, value for the off route miles, value indicating highway only options, and the report type to return. Y
RegionalDataSet For users licensed for multiple regional datasets, this parameter will allow you to choose between Current (default), PCM_EU, PCM_OC, PCM_SA, PCM_AF, PCM_AS, PCM_ME, PCM_GT, PCM_WW and PCM_NA. Y

Sample JSON POST Body #

{
  "ExtendedOptions": {
    "EstimatedTimeOptions": {
      "ETAETD": 1,
      "DateOption": 1,
      "DateAndTime": {
        "CalendarDate": "4/23/2014",
        "DayOfWeek": 0,
        "TimeOfDay": "6:00 AM",
        "TimeZone": 0
      }
    },
    "TruckStyle": 0,
    "UseTraffic": true
  },
  "HighwayOnly": false,
  "OffRouteMiles": 0,
  "Region": 4,
  "ReportType": {
    "__type": "MileageReportType:http://pcmiler.alk.com/APIs/v1.0",
    "THoursWithSeconds": false
  },
  "RoutePings": [
    {"Lat": "33.714154", "Lon": "-118.309434"},
    {"Lat": "33.721061", "Lon": "-118.316631"}
  ],
  "RoutingOptions": {
    "AFSetIDs": null,
    "BordersOpen": true,
    "ClassOverrides": 0,
    "DistanceUnits": 0,
    "ElevLimit": null,
    "FerryDiscourage": false,
    "FuelRoute": false,
    "HazMatType": 0,
    "HighwayOnly": false,
    "HoSOptions": null,
    "HubRouting": false,
    "OverrideRestrict": false,
    "RouteOptimization": 0,
    "RoutingType": 0,
    "TollDiscourage": false,
    "TruckCfg": {
      "Axles": 5,
      "Height": "13'6\"",
      "LCV": false,
      "Length": "48'0\"",
      "Units": 0,
      "Weight": "80000",
      "Width": "96\""
    },
    "UseAvoidsAndFavors": false,
    "VehicleType": 0,
    "SideOfStreetAdherence": 0
  }
}

Sample Response #

{
  "Reports": [
    {
      "__type": "MileageReport:http://pcmiler.alk.com/APIs/v1.0",
      "RouteID": null,
      "ReportLines": [
        {
          "Stop": {
            "Address": {
              "StreetAddress": "1413 West Paseo Del Mar",
              "City": "San Pedro",
              "State": "CA",
              "Zip": "90731",
              "County": "Los Angeles",
              "Country": null,
              "SPLC": null,
              "CountryPostalFilter": 0,
              "AbbreviationFormat": 0,
              "CountryAbbreviation": "US"
            },
            "Coords": {
              "Lat": "33.714154",
              "Lon": "-118.309434"
            },
            "Region": 4,
            "Label": "",
            "PlaceName": "",
            "TimeZone": null,
            "Errors": null,
            "SpeedLimitInfo": null,
            "ConfidenceLevel": null,
            "DistanceFromRoad": null
          },
          "LMiles": "0.0",
          "TMiles": "0.0",
          "LCostMile": "0.00",
          "TCostMile": "0.00",
          "LHours": "0:00",
          "THours": "0:00",
          "LTolls": "0.00",
          "TTolls": "0.00",
          "LEstghg": "0.0",
          "TEstghg": "0.0",
          "EtaEtd": "4/23/2014 6:00 AM"
        },
        {
          "Stop": {
            "Address": {
              "StreetAddress": "3536 South Western Avenue",
              "City": "San Pedro",
              "State": "CA",
              "Zip": "90732",
              "County": "Los Angeles",
              "Country": null,
              "SPLC": null,
              "CountryPostalFilter": 0,
              "AbbreviationFormat": 0,
              "CountryAbbreviation": "US"
            },
            "Coords": {
              "Lat": "33.721061",
              "Lon": "-118.316631"
            },
            "Region": 4,
            "Label": "",
            "PlaceName": "",
            "TimeZone": null,
            "Errors": null,
            "SpeedLimitInfo": null,
            "ConfidenceLevel": null,
            "DistanceFromRoad": null
          },
          "LMiles": "3.6",
          "TMiles": "3.6",
          "LCostMile": "6.09",
          "TCostMile": "6.09",
          "LHours": "0:07",
          "THours": "0:07",
          "LTolls": "0.00",
          "TTolls": "0.00",
          "LEstghg": "12.3",
          "TEstghg": "12.3",
          "EtaEtd": "4/23/2014 6:07 AM"
        }
      ],
      "TrafficDataUsed": false
    }
  ]
}
Last updated December 18, 2019.