Class: Service

This option lists the avoid/favor sets to the route.

This option contains the ALK ApiKey that gives you permission to extract data from ALK Servers.

This option tells the service whether or not to use avoids and favors while routing.

This option tells the service to avoid toll roads and bridges while creating the route.

This option contains the number of axles on the vehicle.

This option holds the bounding box, or extent in which the items are requested.

This option contains the center of the search.

This option specifies a search filter on the Certainty. Default is alk.val.Certainty.All.

This option specifies the city that will be used to search.

This option specifies the city search filter to use. TODO: Various values?

This option tells the service the travel class overrides. Use 'classOverrides'.

This option specifies the FIPS codes for counties in the search.

This options specifies the coordinates with which to restrict the search. The projection must be EPSG:4356.

This option specifies the countries for the search. They must be in the form specified by the countryType parameter.

This option specifies the country type abbreviation the countries parameter is using.

This option specifies speed of the vehicle in Miles Per Hour.

The option contains the Dataset parameter for the Service. This option specifies an area dataset that may be pertinent to the request.

This option tells the service the display type in which to return image data or tiles.

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.

The DrawerGroups parameter for the Service.

This option tells the service the distance above sea level to keep the route. Its value is interpreted according to the 'distanceUnits' option.

The time before which to search for weather alerts. Use standard formats such as ISO8601("2015-08-29T13:45:30-07:00") or RFC1123("Sat, 29 Aug 2015 20:45:30 GMT").

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)

This option specifies a search filter on the event names, such as ["Winter Storm Warning", "Flood Watch"].

This option specifies the search types to exclude when analysing the query of the search. Their values must come from the alk.service.SearchTypesSingleSearchService.

This option tells the service to avoid ferries when creating the route.

This option tells the Service in which format to deliver its image data.

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?

This option tells the service the hazardous material type.

This option tells the service the HazMat conditions in effect. Use 'hazMat'.

This option specifies heading. The value is in degrees counter clockwise from East. East = 0, North = 90, West = 180 , South = 270.

This option tells the service the height in which to return image data or tiles. The value is in pixels.

This option tells the service to generate a route that will travel mostly along highways.

This option tells the service the history in which to return image data or tiles. TODO: Better description.

This option tells the service the history in which to return image data or tiles. TODO: Better description.

This option tells the service the history in which to return image data or tiles. TODO: Better description.

This option enables insertion of Hours Of Service Stops.

This option indicates the available 'Cycle Time Duty' hours available at the origin until a cycle reset.

This option indicates the available driving hours at the origin until the end of the workday.

This option indicates the available driving hours at the origin before the driver needs to take a rest break.

This option indicates the available 'On-Duty' hours at the origin until the end of the work day.

This option indicates the hours of service rule to use. Valid values are alk.val.HosRuleType.USFed607H or alk.val.HosRuleType.USFed708H for US Federal Long Haul rules.

This option contains the the host and port URL for the particular service. This option is not set by the user, but is automatically generated from the particular service being used.

This option tells the service the hour offset in which to return image data or tiles. TODO: Better description.

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.

The string that identifies the camera.

This option tells the service which way to deliver the image data. Available values are 'Background', 'Foreground', and 'Both'.

This option tells the service from where to get its image data. The available names, such as 'Sat1' and 'Sat2', have specific designations with ALK. Please see {TODO: Need Reference Here} for a current description.

This option specifies the response to include link identifier information.

This option specifies the response to include the posted speed limit information. Good only for ALK licenses that include speed limit.

This option tells the service the particular language for the results.

This option tells whether the truck is a multi-trailer or longer combination vehicle.

This option tells the service how many results to return.

This option is tells the service that when it is looking up coordinates to force reverse geocoding to match named roads only.

This option is tells the service that when it is looking up coordinates sets maximum radius in which to find the closest matching road.

This option specifies the max number of results to return. It must be between 1 and 100, inclusive.

This option contains the number of driving minutes, with which to size the polygon.

The results will be filtered by a likeness to this name;

This option tells the service if the borders are open for travel.

This option tells the service the classes of vehicle travel. Such as alk.val.OverrideClass.NationalNetwork or alk.val.OverrideClass.FiftyThreeFoot.

This option tells the service whether to override truck restrictions.

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.

This options specifies the Points of Interest categories with which to restrict the search. Their values must come from the alk.service.POICategoriesSingleSearchService.

TODO: What does point mean for WeatherAlerts.

This option contains the postal code to use in the search.

This option contains the postal code filter to use in the search. The service uses this option to filter zip codes by country. For example, use 'US' to indicate US zip codes only. Use 'EM' to indicate Mexican postal codes only. Use a sequence of country codes for multiple. TODO: Are they separated by commas?

This option tells the service the provider in which to return image data or tiles. The options are Default or RC1.

This option pertains to only those services that return single images where the options pt1 and pt2 represent the NorthWest and SouthEast coordinates,respectively. This option holds the NorthWest coordinate.

This option pertains to only those services that return single images where the options pt1 and pt2 represent the NorthWest and SouthEast coordinates,respectively. This option holds the SouthEast coordinate.

This option contains the radius in radiusUnits of the search.

This option contains the units with which to interpret the radius option.

This option tells the service whether to reduce the number of response points.

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.

This option contains a caller provided id that will be residing on the options when the call is returned. This parameter helps identify the request. It does not get transmitted to the server.

This option tells the service the duration route for which to get the road conditions.

This option tells the service the level of route optimization to use.

This option tells the service what level of route optimization to perform. Use 'routeOpt'.

This option tells the service the route for which to get the road conditions.

This option contains the full route path request to give to the alk.service.RoutePathService. It can be an object, which is the request, or a JSON.stringified version of it.

This option tells the service the type of the route requested. It can be alk.val.RouteType.Practical or alk.val.RouteType.Shortest.

This option tells the route type. See alkx.RouteServiceOptions#routeType.

This option contains the setId that names to which the subsequent calls will pertain.

This option specifies a search filter on the Severity. Default is alk.val.Severity.All.

This option indicates the strictness in avoiding the opposite side of the street at the destination. TODO: What is the number range? 0-1?

This option contains the Standard Point Lookup Code. It is used in place of using street/city/state/zip.

This option tells the service the particular projection that is used any GIS data given to the service.

The time after which to search for weather alerts. Use standard formats such as ISO8601("2015-08-29T13:45:30-07:00") or RFC1123("Sat, 29 Aug 2015 20:45:30 GMT").

This option contains the state (or provence) to use in the search.

This option specifies the states with which to restrict the search. Their values must come from the "Abbrev" attribute of states returned from the alk.service.StatesSingleSearchService.

This option contains an ordered array or indexed object map of the types of each stop given in the 'stops' option.

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.

This option tells the service that all stops in between the origin and the destination are to be treated as not a stop, but a via point.

This option contains the state (or provence) to use in the search.

This option tells the service the stroke width to use in drawing the traffic.

This option tells the service the style of map that is requested. ALK has a number of different map styles, such as alk.val.Style.Night, and alk.val.Style.Terrain.

This option tells the service the offset in time in which to return image weather data or tiles.

TODO: Format?

This option tells the service to avoid tolls. Use 'avoidTolls'.

This option contains the number of axles on the vehicle. Use 'axles'.

This option contains the height of the vehicle. Use 'vehicleHeight'.

This option indicates whether the vehicle is a multi-trailer or longer combination. Use 'lcv'.

This option contains the length of the vehicle. Use 'vehicleLength'.

This option contains the measurement units for the vehicle. Use 'vehicleDimensionUnits'.

This option contains the weight of the vehicle. Use 'vehicleHeight'.

This option contains the width of the vehicle. Use 'vehicleWidth'.

This option specifies the particular vehicle configuration, such as alk.val.TruckConfig.FullSizeVan, etc.

This option specifies that the search is in an urban area.

This option specifies a search filter on the Urgency. Default is alk.val.Urgency.All.

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)

This option contains the height measurement of the vehicle.

This option contains the length measurement of the vehicle.

This option tells the service the type of vehicle that is requesting the route.

This option contains the weight measurement of the vehicle.

This option contains the width measurement of the vehicle.

This option tells the service the width in which to return image data or tiles. The value is in pixels.

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description

TODO: write description