Class: RouteReportsService

Extends

• alk.service.Service

Methods

get(opts_or_callback, responseCallback)

This function performs a request for a alkx.RouteReportsServiceResponse from the options and defaults set on this alk.service.RouteReportsService object.

The response is handled by a asynchronous callback.

Name	Type	Description
opts_or_callback	alkx.RouteReportsServiceOptions | null | function	Options override, if not the callback. Attribute Type Description apiKey string This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers. dataset alk.val.Dataset | number | string The option contains the Dataset parameter for the Service. This option specifies an area dataset that may be pertinent to the request. path string This option is the path part of the URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used. region alk.val.Region | number | string This option tells the service in which region the retrieved data is to pertain. Some ALK Services switch underlying services due to this option. For instance, traffic data for North America and Europe may come from different underlying services. srs alk.val.SRS | number | string This option tells the service the particular projection that is used any GIS data given to the service. routeId string | undefined TODO: write description stops Array.<Array.<number>> This option contains the stops that the route is to travel along. It is supplied in Spherical Mercator unless, specified by the 'srs' option. It contains an ordered array of coordinates from origin to destination. stopCosts Array.<(alkx.StopCost|string)> | string | undefined TODO: write description vehicleType alk.val.VehicleType | number | string This option tells the service the type of vehicle that is requesting the route. routeType alk.val.RouteType | number | string This option tells the service the type of the route requested. It can be alk.val.RouteType.Practical or alk.val.RouteType.Shortest. highwayOnly boolean | number | string This option tells the service to generate a route that will travel mostly along highways. customRoadSpeeds string | undefined TODO: write description avoidFavors boolean | number | string This option tells the service whether or not to use avoids and favors while routing. overrideClass Array.<(alk.val.OverrideClass|number)> | string This option tells the service the classes of vehicle travel. Such as alk.val.OverrideClass.NationalNetwork or alk.val.OverrideClass.FiftyThreeFoot. distanceUnits alk.val.DistanceUnits | number | string This option tells the service that any distance measurements will be delivered in these units, such as alk.val.DistanceUnits.Kilometers or alk.val.DistanceUnits.Miles. fuelUnits alk.val.FuelUnits | number | string | undefined TODO: write description avoidTolls boolean | number | string This option tells the service to avoid toll roads and bridges while creating the route. includeFerryDistance boolean | number | string | undefined TODO: write description openBorders boolean | number | string This option tells the service if the borders are open for travel. overrideRestrict boolean | number | string This option tells the service whether to override truck restrictions. hazMat alk.val.HazMat | number | string This option tells the service the hazardous material type. routeOptimization alk.val.RouteOptimization | number | string This option tells the service what level of route optimization to perform. Use 'routeOpt'. language alk.val.Language | string This option tells the service the particular language for the results. hubRouting boolean | number | string This option tells the service if 'hub routing' is in effect. This means that the starting stop is the hub. The last stop is in effect, not a destination, but a turn around point. vehicleDimensionUnits alk.val.VehicleDimensionUnits | number | string This option tells the service in what units, metric or otherwise, the vehicle measurements are presented. Can be either alk.val.VehicleDimensionUnits.English 12'6", 12.0 (feet) alk.val.VehicleDimensionUnits.Metric 4.114 (meters) vehicleHeight number | string This option contains the height measurement of the vehicle. vehicleLength number | string This option contains the length measurement of the vehicle. vehicleWidth number | string This option contains the width measurement of the vehicle. vehicleWeight number | string This option contains the weight measurement of the vehicle. axles number | string This option contains the number of axles on the vehicle. truckConfig alk.val.TruckConfig | number | string This option specifies the particular vehicle configuration, such as alk.val.TruckConfig.FullSizeVan, etc. lcv boolean | number | string This option tells whether the truck is a multi-trailer or longer combination vehicle. reports Array.<(alk.val.Report|number)> | string | undefined TODO: write description condenseDirections boolean | number | string | undefined TODO: write description reportFormat alk.val.ReportFormat | number | string | undefined TODO: write description includeTollData boolean | number | string | undefined TODO: write description fuelEconomyLoad number | string | undefined TODO: write description fuelEconomyEmpty number | string | undefined TODO: write description costPerFuelUnit number | string | undefined TODO: write description costGreenHouseGas number | string | undefined TODO: write description costMaintenanceLoad number | string | undefined TODO: write description costMaintenanceEmpty number | string | undefined TODO: write description costTimeLoad number | string | undefined TODO: write description costTimeEmpty number | string | undefined TODO: write description tollCurrency alk.val.TollCurrency | number | string | undefined TODO: write description exchangeRate number | string | undefined TODO: write description tollPlan Array.<(alk.val.TollPlan|number)> | string | undefined TODO: write description citeInterval number | string | undefined TODO: write description estimatedTimeOpts string This option contains the parameter for the estimated time optimizations. This option only affects routing when roads have time based restrictions. Format is described by this BNF notation: fmt ::= DA ('|' Time)? Time :: = DayTime | SpecificDateTime DA ::= 'Depart' | 'Arrive' DayOfWeek ::= 'Monday' | 'Tuesday' | ... | 'Sunday'; DayTime ::= DayOfWeek '|' TimeOfDay ('|' TimeZone)? SpecificDateTime ::= YYYY-MM-DDTHH:MM:SS ('|' TimeZone)? Examples are: -- Arrive|Monday|18:53|Local -- Depart|2016-04-23T09:43:20|Local -- Arrive (meaning system time) breakInterval number | string | undefined TODO: write description breakLength number | string | undefined TODO: write description borderWait number | string | undefined TODO: write description remainingHoursOfService number | string | undefined TODO: write description useTraffic boolean | number | string | undefined TODO: write description tHoursWithSeconds number | string | undefined TODO: write description urgency alk.val.Urgency | number | string This option specifies a search filter on the Urgency. Default is alk.val.Urgency.All. severity alk.val.Severity | number | string This option specifies a search filter on the Severity. Default is alk.val.Severity.All. certainty alk.val.Certainty | number | string This option specifies a search filter on the Certainty. Default is alk.val.Certainty.All. eventNames Array.<string> | string This option specifies a search filter on the event names, such as ["Winter Storm Warning", "Flood Watch"]. elevationLimit number | string This option tells the service the distance above sea level to keep the route. Its value is interpreted according to the 'distanceUnits' option. ferryDiscourage boolean | number | string This option tells the service to avoid ferries when creating the route. hosEnabled boolean | number | string This option enables insertion of Hours Of Service Stops. hosRemDriveTimeUntilBreak number | string This option indicates the available driving hours at the origin before the driver needs to take a rest break. hosRemDriveTime number | string This option indicates the available driving hours at the origin until the end of the workday. hosRemOnDutyTime number | string This option indicates the available 'On-Duty' hours at the origin until the end of the work day. hosRemCycleDutyTime number | string This option indicates the available 'Cycle Time Duty' hours available at the origin until a cycle reset. sideOfStreetAdherence number | string This option indicates the strictness in avoiding the opposite side of the street at the destination. TODO: What is the number range? 0-1? governorSpeedLimit number | string This option tells the service the maximum average road speed to use in route calculations that overrides all other road speeds when the are above this value. Default is disabled and valid values are between 1 and 100mph. TODO: Is this always in MPH when distanceUnits is Kilometers?
responseCallback	function	The callback that handles the response.

getAttribution(opts_or_callback, responseCallback){*|undefined} inherited

This method performs a request to this configured service using the supplied options, options set on the constructor, and defaults to get the service's attribution, should it have one. This call results in Object, which may be a parsed JSON response.

Name	Type	Description
opts_or_callback	Object | function	This parameter contains any options that override options that are set on this object for this particular request.
responseCallback	function	This parameter is the function that handles the response.

getServiceOptions(options){Object} inherited

This method returns the base options that was used to create this Service object and override them with the given options;

Name	Type	Description
options	Object

Returns:

The combined options.

getURL(opt_options){string} inherited

Returns the URL for the service based on the given options, options set on the constructor, and defaults.

Name	Type	Description
options	Object	These options override any relevant options that are set on the object at its construction.

processResponse(options, obj){Object} inherited

This method processes the response from the server before it gives it to the callback. The default is to pass through.

NOTE

This intercept point will only be called if the request was initiated with the get call.

Name	Type	Description
options	Object	The call options combined with the base options used for the call.
obj	Object	The object received from the server.