ALK.PCM.Model Namespace Reference

Namespaces
namespace	BusinessModels
	This namespace contains the data structures used by the PC*Miler Web Services.
namespace	ServiceModels
	This namespace contains the Request/Response structures used by the PC*Miler Web Services.

Classes
class	AbstractJsonConverter
	AbstractJsonConverter can be extended to create type specific converters to handle the deserialization process in a customized fashion. More...
class	Constants
	Represents constants used internally within the PCMiler application and processing layers. More...
class	PcmwsException
	Represents an exception which contains an error code and other error specific information. More...
class	ReportTypeConverter
	ReportTypeConverter is used to Deserialize the ReportType Json object which is an abstract class. More...

Enumerations
enum	ActionType { Save, Delete }
	Represents an action to perform when setting avoids/favors and custom places. More...
enum	ETAETDType { Arrival, Depart }
	Represents the type of estimated time. More...
enum	TimeZone { Local = 0, System, Hawaii, Alaska, Pacific, Arizona, Mountain, Central, Eastern, Atlantic, Newfoundland, GMT, UTC }
	Represents a time zone. More...
enum	DateOption { Current, Specific, DayOfWeek }
	Represents what a type of time to use for estimated time options. More...
enum	TruckStyle { None, TwentyEightDoubleTrailer, FortyStraightTruck, FortyEightSemiTrailer, FiftyThreeSemiTrailer, FullSizeVan, TwentySixStraightTruck, ConventionalSchoolBus, SmallSchoolBus }
	Represents vehicle dimensions of a truck trailer to use for ALK.PCM.Model.BusinessModels.RouteCosts More...
enum	Currency {   US = ALK.Interop.Trip.TCurrency.TC_USD, CDN = ALK.Interop.Trip.TCurrency.TC_CAD, ALL = ALK.Interop.Trip.TCurrency.TC_ALL, AMD = ALK.Interop.Trip.TCurrency.TC_AMD, AZN = ALK.Interop.Trip.TCurrency.TC_AZN, BAM = ALK.Interop.Trip.TCurrency.TC_BAM, BGN = ALK.Interop.Trip.TCurrency.TC_BGN, BYR = ALK.Interop.Trip.TCurrency.TC_BYR, CHF = ALK.Interop.Trip.TCurrency.TC_CHF, CZK = ALK.Interop.Trip.TCurrency.TC_CZK, DKK = ALK.Interop.Trip.TCurrency.TC_DKK, EUR = ALK.Interop.Trip.TCurrency.TC_EUR, GBP = ALK.Interop.Trip.TCurrency.TC_GBP, GEL = ALK.Interop.Trip.TCurrency.TC_GEL, HRK = ALK.Interop.Trip.TCurrency.TC_HRK, HUF = ALK.Interop.Trip.TCurrency.TC_HUF, ISK = ALK.Interop.Trip.TCurrency.TC_ISK, MDL = ALK.Interop.Trip.TCurrency.TC_MDL, MKD = ALK.Interop.Trip.TCurrency.TC_MKD, NOK = ALK.Interop.Trip.TCurrency.TC_NOK,   PLN = ALK.Interop.Trip.TCurrency.TC_PLN, RON = ALK.Interop.Trip.TCurrency.TC_RON, RSD = ALK.Interop.Trip.TCurrency.TC_RSD, RUB = ALK.Interop.Trip.TCurrency.TC_RUB, SEK = ALK.Interop.Trip.TCurrency.TC_SEK, TRY = ALK.Interop.Trip.TCurrency.TC_TRY, UAH = ALK.Interop.Trip.TCurrency.TC_UAH }
	Represents monetary currency. More...
enum	RouteOptimizeType { None, ThruAll, DestinationFixed }
	Represents the type of stop optimization to use. More...
enum	CountryCodeFormat { FIPS, ISO2, ISO3, GENC2, GENC3 }
	Enumerates the abbreviation formats used for country code designators. More...
enum	VehicleType { Truck, LightTruck, Auto, MidsizeTruck, Bus }
	Represents the type of vehicle. More...
enum	ReportTypeFlag { None = 0x0, Mileage = 0x1, Detail = 0x2, CalcMiles = 0x4, Directions = 0x8, Fuel = 0x10, Geotunnel = 0x20, LeastCost = 0x40, Road = 0x80, State = 0x200, WeatherAlerts = 0x400, TollDetail = 0x800, RoutePath = 0x1000 }
	Indicates the types of reports. This is specific to the REST interface only. More...
enum	ReportFormat { Text, Html, XML, JSON }
	Represent a report format. This is specific to the REST interface only. More...
enum	PinType { PDW_BMP, PDW_CIRCLE, PDW_SQUARE, PDW_DIAMOND }
	Represents the type of pin to draw on the map. More...
enum	PinColor { Blue, Green, Pink, Yellow }
	Represents the type of pin to draw on the map. More...
enum	ErrorType { Warning, Exception }
	Represents the type of error, whether a warning or an exception. More...
enum	LayerType { BaseMap, ScaleOfMiles, RouteLegend, RoadLegend, HazMatLegend, TrafficLegend, PointMap }
	Represents the content of an image layer within a ALK.PCM.Model.BusinessModels.RenderedMap which contains one or more ALK.PCM.Model.BusinessModels.Layer objects. More...
enum	DataVersion {   Current, PCM_EU, PCM_OC, PCM_SA, PCM_GT, PCM_AF, PCM_AS, PCM_ME, PCM_NA, PCM_WW, PCM_JP, PCM_NASL, PCM_MX, PCM18 = 18, PCM19 = 19, PCM20 = 20, PCM21 = 21, PCM22 = 22, PCM23 = 23, PCM24 = 24,   PCM25 = 25, PCM26 = 26, PCM27 = 27, PCM28 = 28, PCM29 = 29, PCM30 = 30, PCM31 = 31, PCM32 = 32, PCM33 = 33, PCM34 = 34 }
	Represents the data version that a request should be sent to for REST methods that support MVS. More...
enum	RegionalDataSet { Current, PCM_EU, PCM_OC, PCM_SA, PCM_GT, PCM_AF, PCM_AS, PCM_ME, PCM_NA, PCM_WW, PCM_JP, PCM_NASL, PCM_MX, PCM_NA_13Q2, PCM_NA_17Q1 }
	Represents the regional dataset a request should be sent to for REST methods that don't support MVS. More...
enum	MapRegion { NA, Bermuda, Canada, Mexico, PuertoRico, US, EU, OC, ME, AF, SA, AS }
	Represents the region to frame when generating a map when no center point, corners, route or pins are supplied. More...
enum	MapStyle { Default, Classic, Monochrome, RoadAtlas, Darkness, Modern, Contemporary, Night, Satellite, Lightness, Smooth, Terrain }
	Represents the visual look and feel of a map. More...
enum	VectorMapStyle { Transportation = 100, DataLight = 101, DataDark = 102, Satellite = 103, Terrain = 104, Basic = 105 }
	Represents the visual look and feel of an ALK vector map. More...
enum	MapImageOption { Both, Background, Foreground }
	Determines map drawing options. More...
enum	DrawerType {   Airports, AvoidFavor, City, CityLarge, CommerciallyProhibited, CountryBoundaries, CountyBoundaries, HazMat, Land, LinkLabel, MilitaryBases, Network, OrthoImage, Parks, Place, PointDrawerWeb, Railroads, Route, Shield, ShieldInterstate,   StaaDesignation, StateBoundaries, Stop, TimeZone, TruckRestrictions, UrbanAreas, Water, ExitLabel, PolygonLabel, Edge }
	Represents the types of layers that can be draw on a map. More...
enum	DrawerGroups { Cities = 0x0001, Labels = 0x0002, Roads = 0x0004, Commercial = 0x0008, Borders = 0x0010, Areas = 0x0020 }
	Represents the types of layers that can be draw on a map. More...
enum	ImageFormat { Png, Jpeg }
	Represents the supported image formats for map and satellite. More...
enum	ProjectionType { Default, FixedLat, Mercator }
	Represents the type of projection used for maps More...
enum	LegendType { ScaleOfMiles, RouteLegend, RoadLegend, HazMatLegend, TrafficLegend }
	Represents the type of legends available when requesting a map. More...
enum	POISearchType { FuelStop = 1, HoS = 2, Generic = 4 }
	Type of POI search for POIs along route More...
enum	POIHosType { All, TruckServiceHoS = 1600, RestAreaHoS = 1510 }
	The POI categories for HoS POIs along route More...
enum	POIGenericType : ushort { All, WeightStation = 146, CatScale = 110, LCVLot = 149, Hotel = 25, IntermodalRamp = 52, Parking = 34, RestAreaHoS = 1510, TruckStop = 151, TruckServiceHoS = 1600, HighwayExit = 1607, MajorAirport = 101, EventFacility = 18, DistributionCenter = 1800 }
	The POI generic categories for POIs along route More...
enum	POIType : ulong {   All = 0x0, City = 0x1, Zip = 0x2, Place = 0x4, Airport = 0x8, Automotive = 0x10, WeighStation = 0x20, Dining = 0x40, Education = 0x80, Emergency = 0x100, Government = 0x200, Gas = 0x400, Lodging = 0x800, Parks = 0x1000, Retail = 0x2000, RVServices = 0x4000, SportsRec = 0x8000, Travel = 0x10000, TruckServices = 0x20000, Attractions = 0x40000,   OilAndGas = 0x80000, AutoDealership = 0x100000, Bank = 0x200000, BridgesAndTunnels = 0x400000, BusTaxiLimo = 0x800000, CATScales = 0x1000000, CityHall = 0x2000000, DieselExhaustFluid = 0x4000000, Entertainment = 0x8000000, EventFacility = 0x10000000, FerryTerminal = 0x20000000, GeographicFeature = 0x40000000, GroceryStore = 0x80000000, GuestHouse = 0x100000000, HighwayExit = 0x200000000, IntermodalRampLarge = 0x400000000, IntermodalRampMedium = 0x800000000, IntermodalRampSmall = 0x1000000000, LCVLot = 0x2000000000, Marina = 0x4000000000,   Municipal = 0x8000000000, HighwayIntersection = 0x10000000000, Other = 0x20000000000, Parking = 0x40000000000, PlaceOfWorship = 0x80000000000, PoliceStation = 0x100000000000, RailwayStation = 0x200000000000, RentACar = 0x400000000000, RestArea = 0x800000000000, ATM = 0x1000000000000, DistributionCenter = 0x2000000000000, IntermodalRamp = 0x4000000000000 }
	Specified the different categories of POIs. More...
enum	PolygonType { Shape, Region }
	Specifies the type of polygon for the geometry drawer. More...
enum	ShapeType { None, Line, Circle, Rect, Ellipse, Polygon }
	Specifies the polygon shapes to draw on the time. More...
enum	PointGroupDensity { Few, Average, Most }
	Specifies the number of groups to be displayed on the map. More...
enum	PointSpread { Most, Average, Cluster }
	Specifies the distance between each point within a group. More...
enum	StopLabelType { Name, Number, Both, None }
	Specifies the label type for stops on the map. More...
enum	MapLayering { MapAndPointsOneLayer = 0, MapLayer = 1, PointsLayer = 2, MapAndPointsTwoLayers = 3, BackgroundOnly = 4, NoBackground = 5 }
	Specifies the layer options for a map: 0: Map plus points on one layer. 1: Map only 2: Points only 3: Map and points on different layers. More...
enum	TrafficType { Congestion = 0, RoadSpeed, Neither }
	Specifies the category of speed displayed. More...
enum	TrafficTime { Actual = 1, Historic = 2, Default = 4 }
	Specifies the Time type of speed data. More...
enum	AmPmType { Military, AM, PM }
	Specified the AM / PM value for the time. More...
enum	OutOfRouteCompliance { Strict, Moderate, None }
	Specifies the RouteSync out of route compliance level. More...
enum	WeatherType { Radar, Satellite }
	Represents the type of a weather image. More...
enum	WeatherAlertCertainty { Observed = 0, Likely = 1, Possible = 2, Unlikely = 3, Unknown = 4 }
	Allows client to request all or one particular certainty level. More...
enum	WeatherAlertSeverity { Extreme = 0, Severe = 1, Moderate = 2, Minor = 3, Unknown = 4 }
	Allows client to request all or one particular severity level. More...
enum	WeatherAlertUrgency { Immediate = 0, Expected = 1, Future = 2, Past = 3, Unknown = 4 }
enum	JurisdictionType { County = 1, State, Zip }
	Enum for distinguishing the jurisdiction type used to get the border polygons More...
enum	BackgroundImageProvider { Default, Sat1, Sat2, Sat3, Sat4, Sat5, Sat6, ALKCurated }
	Tile image provider More...
enum	RoadSurfaceProvider { Default, RC1 }
	Road Surface Provider More...
enum	SpeedLimitType { Default, Historic, Premium, Navteq, LinkBased, JWR }
	Speed Limit Type for ReverseGeocoding posted speed limit More...
enum	RouteSyncMessageVersion { Default = 0, V3 = 1, JSON = 2 }
	RouteSync message version More...
enum	TrafficCameraImgResolution { HalfJpeg, FullJpeg, HugeJpeg }
	Traffic camera image resolution More...
enum	GeocodeConfidenceLevel { Exact = ALK.Interop.Geo.GeoConfidenceLevel.Exact, Good = ALK.Interop.Geo.GeoConfidenceLevel.Good, Uncertain = ALK.Interop.Geo.GeoConfidenceLevel.Uncertain, Failed = ALK.Interop.Geo.GeoConfidenceLevel.Failed }
	Geocoding Confidence Level More...
enum	GeocodeCitySearchFilter { CitiesWithZips = ALK.Interop.Geo.GeoCitySearchFilter.City_Or_City_With_Zip, CityCentersOnly = ALK.Interop.Geo.GeoCitySearchFilter.City_With_No_Zip }
	Geocoding City Search Filter More...
enum	MapTileOverlay { TruckRestrictions }
	Represents the map tile overlay. More...
enum	RoutingLevel { StreetLevel = 0, HighwayLevel = 1 }
	Represents type of RoutingLevel. More...
enum	PoiSearchWindowUnits { Miles, Minutes }
	Represents the type of estimated time. More...
enum	SideOfStreetAdherenceLevel { Off = ALK.Interop.Trip.SideOfStreetAdherenceLevel.Off, Minimal = ALK.Interop.Trip.SideOfStreetAdherenceLevel.Minimal, Moderate = ALK.Interop.Trip.SideOfStreetAdherenceLevel.Moderate, Average = ALK.Interop.Trip.SideOfStreetAdherenceLevel.Average, Strict = ALK.Interop.Trip.SideOfStreetAdherenceLevel.Strict, Adhere = ALK.Interop.Trip.SideOfStreetAdherenceLevel.Adhere, StronglyAdhere = ALK.Interop.Trip.SideOfStreetAdherenceLevel.StronglyAdhere }
	Represents the levels of adherence that apply a cost to a route if its destination is on the opposite side of the street. More...
enum	TrailerType { None = ALK.Interop.Link.TollTrailerClass.TTC_NONE, Trailer = ALK.Interop.Link.TollTrailerClass.TTC_TRAILER, Caravan = ALK.Interop.Link.TollTrailerClass.TTC_CARAVAN }
	Represents the type of Trailer for toll reports More...
enum	EngineEmissionType { Euro0 = ALK.Interop.Link.TollEmissionClass.TEC_EURO_0, EuroI = ALK.Interop.Link.TollEmissionClass.TEC_EURO_I, EuroII = ALK.Interop.Link.TollEmissionClass.TEC_EURO_II, EuroIII = ALK.Interop.Link.TollEmissionClass.TEC_EURO_III, EuroIV = ALK.Interop.Link.TollEmissionClass.TEC_EURO_IV, EuroV = ALK.Interop.Link.TollEmissionClass.TEC_EURO_V, EuroVI = ALK.Interop.Link.TollEmissionClass.TEC_EURO_VI, EuroEEV = ALK.Interop.Link.TollEmissionClass.TEC_EURO_EEV }
	Represents the type of Engine Emission for toll reports More...
enum	TimeWindowSequenceMethodType { Optimize = 1, ETA = 2 }
	Represents the optimization process on an TimeWindowSequence. More...
enum	TimeWindowFormatType { Hour24 = 1, Minutes = 2, Hour12 = 3 }
	Represents the time format for an TimeWindowSequence. More...
enum	TimeWindowUniqueClusterStrictnessLevel { Off = ALK.Interop.Trip.UniqueClusterStrictnessLevel.Off, On = ALK.Interop.Trip.UniqueClusterStrictnessLevel.On, Only = ALK.Interop.Trip.UniqueClusterStrictnessLevel.Only }
	Decide how to handle unique cluster IDs provided in time window stops. More...
enum	TimeWindowHistoricSpeedDay { Current = -1, Sunday = 0, Monday = 1, Tuesday = 2, Wednesday = 3, Thursday = 4, Friday = 5, Saturday = 6 }
	Chooses whether time window routing uses the current historic speed data or a fixed day of the week. More...
enum	TimeWindowDeliveryType { Unknown = ALK.Interop.Trip.DeliveryPickupType.Unknown, Delivery = ALK.Interop.Trip.DeliveryPickupType.Delivery, Pickup = ALK.Interop.Trip.DeliveryPickupType.Pickup }
	Describes if a time window stop is a delivery or a pickup/collection. More...
enum	RoadClass { Closed = TRoadClass.RC_CLOSED, Interstate = TRoadClass.RC_INTERSTATE, InterstateNoRamps = TRoadClass.RC_INTERSTATE_NORAMPS, Divided = TRoadClass.RC_DIVIDED, Primary = TRoadClass.RC_PRIMARY, Ferry = TRoadClass.RC_FERRY, Secondary = TRoadClass.RC_SECONDARY, Ramp = TRoadClass.RC_RAMP, Local = TRoadClass.RC_LOCAL, SubLocal = TRoadClass.RC_SUBLOCAL, Pathway = TRoadClass.RC_PATHWAY }
	Road class corresponding to core TRoadClass More...
enum	SpeedCongestionRatio { Unknown, Closed, Heavy, Light, Open }
	Speed Congestion Ratio for a Traffic Path More...
enum	TileImageRatio { OneX = 1, TwoX = 2 }
	Image ratios for vector maps raster tiles. More...
enum	TileSize { Standard256 = 256, Large512 = 512 }
	Tile size for vector maps raster tiles. More...
enum	EPortalLanguages {   DATA_LANGUAGE = -2, ERR_LANGUAGE = -1, USENGLISH = 0, UKENGLISH = 1, GERMAN = 2, FRENCH = 3, SPANISH = 4, ITALIAN = 5, AUSTRALIAN = 6, DUTCH = 7, SWEDISH = 8, CZECH = 9, DANISH = 10, PORTUGUESE = 11, NORWEGIAN = 12, FINNISH = 13, GREEK = 14, TURKISH = 15, POLISH = 16, RUSSIAN = 17,   ARABIC = 18, HUNGARIAN = 19, SLOVENIAN = 20, CATALAN = 21, BULGARIAN = 22, ROMANIAN = 23, SMPCHINESE = 24, CHINESE = 25, CROATIAN = 26, BRZPORTUGUESE = 27, SERBIAN = 28, SLOVAK = 29, LATAMSPANISH = 30, RESERVED = 31, ALBANIAN = 32, BASQUE = 33, BELARUSIAN = 34, BOSNIAN = 35, CHINESE_CANTONESE = 36, ESTONIAN = 37,   GALICIAN = 38, INDONESIAN_BAHASA = 39, KOREAN = 40, LATVIAN = 41, LITHUANIAN = 42, MACEDONIAN_SLAVIC = 43, MALAY = 44, MOLDOVAN = 45, MONTENEGRIN = 46, THAI = 47, UKRAINIAN = 48, WELSH = 49, PINYIN = 50, ICELANDIC = 51, MALTESE = 52, HAWAIIAN = 53, HEBREW = 54, HINDI = 55, VIETNAMESE = 56, JAPANESE = 57,   TRANSCRIBED = 58, FILIPINO = 59, FLEMISH = 60, BENGALI = 61, WORLDENGLISH = 62, GEORGIAN = 63, ASSAMESE = 64, GUJARATI = 65, KANNADA = 66, MALAYALAM = 67, MARATHI = 68, ORIYA = 69, PUNJABI = 70, TELUGU = 71, TAMIL = 72, MONGOLIAN = 73, URDU = 74, ARMENIAN = 75, AZERI = 76, FAROESE = 77,   UZBEK = 78, KAZAKH = 79, GUARANI = 80, PERSIAN = 81, LANGCOUNT = 82 }
	E Portal Languages. More...
enum	PcmwsExceptionCode {   SUCCESS = 0, LEGACY_ERROR, INTRNL_FAIL, INVLD_PROFILE_VER, TRIP_LIMIT_EXCEEDED, INVLD_LOGIN, LOGIN_DISABLED, INVLD_PROFILE, INVLD_PROFILE_ARRAY, INVLD_PROFILE_CANADIAN, INVLD_PROFILE_DETAIL, INVLD_PROFILE_COND, INVLD_PROFILE_DIRECTIONS, INVLD_PROFILE_ROAD, INVLD_PROFILE_STATE, INVLD_PROFILE_FUEL, INVLD_PROFILE_HUB, INVLD_PROFILE_SPLC, INVLD_PROFILE_PLACE_NAME, INVLD_PROFILE_STREETS,   INVLD_PROFILE_STREETS_GEO, INVLD_PROFILE_FASTEST, INVLD_PROFILE_TRK_CFG, INVLD_PROFILE_TOLLDATA, INVLD_PROFILE_VEHICLE_TYPE, INVLD_ADDR, CITY_STATE_ZIP_MISMATCH, INVLD_ZIP, INVLD_STATE, INVLD_CITY_JURIS, INVLD_PLACE_NAME, NO_CITY_ZIP, INVLD_CITY, INVLD_STATE_ABBR, PO_BOX_NO_ALLOWED, FIND_MTCH_FAILED, MISSING_TRIP_ORIGIN, MISSING_TRIP_DEST, MISSING_VARIABLE, INVLD_AF_TYPE,   INVLD_ROUTE_NAME, INVLD_CITE_INT, INVLD_FUEL_OPT_COND, INVLD_DEPART_TIME, INVLD_INT, INVLD_DBL, INVLD_INPUT_PLACE, INVLD_METRIC_VAL, INVLD_MET_LGTH, INVLD_MET_HEIGHT, INVLD_MET_WEIGHT, INVLD_MET_WIDTH, INVLD_ENG_HEIGHT, INVLD_ENG_WEIGHT, INVLD_ENG_WIDTH, INVLD_ENG_LENGTH, INVLD_TOLL_DISCOUNT, INVLD_STOP_INFO, INVLD_DATE, INVLD_TIME,   INVLD_RADIUS, MISSING_FUEL_OPTIONS, MISSING_FUEL_INFO, MISSING_STOP_INFO, MISSING_DATE_TIME, MISSING_DAY_OF_WEEK, INVLD_LAT, INVLD_LNG, INVLD_COORDS, FUEL_OPT_ERR, INVLD_TRIP, PARITY_MISMATCH, NO_STREET_NUMBER, DIRECTIONAL_MISMATCH, STREET_TYPE_MISMATCH, STREET_NAME_MISSPELL, MULTIPLE_MATCHES, NO_STREET_NAME, ADDR_OUT_OF_RANGE, STREET_NOT_IN_ZIP,   COORDS_ZIPCENTROID, EXTRA_FUEL_OPTIONS, EXTRA_TRUCK_CONFIG, EXTRA_DATE, EXTRA_REPORT, INVLD_DATA_VER, DEPCREATED_TOLL_TAG, INVLD_GEO_LIST_CNT, GEOCODE_ERROR, GEOCODE_WARN, INVLD_TILE_INDEX, EXTRA_ROUTE, EXTRA_DATA, INVLD_ROUTE_OPTIONS, INVLD_VAL, DEPRECATED, GEOCODE_LIMIT_EXCEEDED, UNAVAILABLE_FEATURE, STOP_LIMIT_EXCEEDED, NO_ALLOWED_INTERPS,   INVALID_INTERP, INVALID_FUEL_CONSUMPTION, INVLD_COUNTRY_ABBR, HOS_SERVICE_ERR }
	Represents exception codes within a PcmwsException class. More...

Enumeration Type Documentation

ActionType

enum ActionType

strong

Represents an action to perform when setting avoids/favors and custom places.

Enumerator
Save	Perform a save.
Delete	Perform a delete.

ETAETDType

enum ETAETDType

strong

Represents the type of estimated time.

Enumerator
Arrival	Indicates the time is an estimated time of arrival.
Depart	Indicates the time is an estimated time of departure.

TimeZone

enum TimeZone

strong

Represents a time zone.

Enumerator
Local	Indicates that the timezone should be local.
System	Indicates that the timezone be that of the server.
Hawaii	Indicates the time zone for Hawaii.
Alaska	Indicates the time zone for Alaska.
Pacific	Indicates the Pacific time zone.
Arizona	Indicates the time zone for the state of Arizona.
Mountain	Indicates the Mountain time zone.
Central	Indicates the Central time zone.
Eastern	Indicates the Eastern time zone.
Atlantic	Indicates the Atlantic time zone.
Newfoundland	Indicates the time zone for Newfoundland.
GMT	Indicates GMT.
UTC	Indicates UTC.

DateOption

enum DateOption

strong

Represents what a type of time to use for estimated time options.

Enumerator
Current	Indicates that the current system time should be used.
Specific	Indicates that a specific supplied time should be used.
DayOfWeek	Indicates that a day of the week should be used.

TruckStyle

enum TruckStyle

strong

Represents vehicle dimensions of a truck trailer to use for ALK.PCM.Model.BusinessModels.RouteCosts

Enumerator
None	Indicates that no particular truck style is chosen.
TwentyEightDoubleTrailer	Indicates that a 28' double trailer should be used.
FortyStraightTruck	Indicates that a Heavy Duty Straight trailer should be used.
FortyEightSemiTrailer	Indicates that a Heavy Duty Semitrailer (48' x 96") should be used.
FiftyThreeSemiTrailer	Indicates that a Heavy Duty Semitrailer should be used.
FullSizeVan	Indicates a full-size van
TwentySixStraightTruck	Indicates a Medium Duty Straight
ConventionalSchoolBus	Indicates a conventional school bus.
SmallSchoolBus	Indicates a small school bus.

Currency

enum Currency

strong

Represents monetary currency.

Enumerator
US	Indicates that the currency should be United States dollars.
CDN	Indicates that the currency should be Canadian dollars.
ALL	Indicates that the currency should be Albanian lek.
AMD	Indicates that the currency should be Aremenian dram.
AZN	Indicates that the currency should be Azerbaijani manat.
BAM	Indicates that the currency should be Bosnia and Herzegovina convertible mark.
BGN	Indicates that the currency should be Bulgarian lev.
BYR	Indicates that the currency should be Belarusian ruble.
CHF	Indicates that the currency should be Swiss franc.
CZK	Indicates that the currency should be Czech koruna.
DKK	Indicates that the currency should be Danish krone.
EUR	Indicates that the currency should be Euros (default for Toll Detail Reports).
GBP	Indicates that the currency should be Pound sterling.
GEL	Indicates that the currency should be Georgian lari.
HRK	Indicates that the currency should be Croatian kuna.
HUF	Indicates that the currency should be Hungarian forint.
ISK	Indicates that the currency should be Icelandic króna: second króna.
MDL	Indicates that the currency should be Moldovan leu.
MKD	Indicates that the currency should be Second Macedonian denar.
NOK	Indicates that the currency should be Norwegian krone.
PLN	Indicates that the currency should be Polish złoty.
RON	Indicates that the currency should be Fourth Romanian leu.
RSD	Indicates that the currency should be Serbian dinar.
RUB	Indicates that the currency should be Russian ruble.
SEK	Indicates that the currency should be Swedish krona.
TRY	Indicates that the currency should be Turkish lira.
UAH	Indicates that the currency should be Ukrainian hryvnia.

RouteOptimizeType

enum RouteOptimizeType

strong

Represents the type of stop optimization to use.

Enumerator
None	Indicates to not use any stop optimization.
ThruAll	Indicates that all of the input stops should be resequenced for the most optimal sequence.
DestinationFixed	Indicates that the destination remain fixed, but all other input stops should be resequenced for the most optimal sequence.

CountryCodeFormat

enum CountryCodeFormat

strong

Enumerates the abbreviation formats used for country code designators.

Enumerator
FIPS	Geopolitical codes used by US government. See FIPS PUB 10-4.
ISO2	Two-letter code format, based on ISO 3166-1 "Country Codes".
ISO3	Three-letter code format used by UN Statistics Division.
GENC2	Two-letter code format for Geopolitical Entities and Codes.
GENC3	Three-letter code format for Geopolitical Entities and Codes.

VehicleType

enum VehicleType

strong

Represents the type of vehicle.

Enumerator
Truck	Indicates a truck.
LightTruck	Indicates a light truck.
Auto	Indicates an automobile.
MidsizeTruck	Indicates a medium duty truck.
Bus	Indicates a school bus.

ReportTypeFlag

enum ReportTypeFlag

strong

Indicates the types of reports. This is specific to the REST interface only.

Note that this enumeration supports flags, meaning that more than one value can be set.

Enumerator
None	Indicates no report.
Mileage	Indicates a mileage report.
Detail	Indicates a detailed report.
CalcMiles	Indicates a calculate miles report.
Directions	Indicates a driving directions report.
Fuel	Indicates a fuel report.
Geotunnel	Indicates a geotunneling report.
LeastCost	Indicates a least cost report. Provides comparison of toll and routing type effects on route cost.
Road	Indicates a road report.
State	Indicates a state report.
WeatherAlerts	Indicates a weather alerts report.
TollDetail	Indicates a toll detail report.
RoutePath	Indicates a route path report.

ReportFormat

enum ReportFormat

strong

Represent a report format. This is specific to the REST interface only.

Enumerator
Text	Indicates the report format should be plain text.
Html	Indicates the report format should be HTML.
XML	Indicates the report format should be XML.
JSON	Indicates the report format should be JSON.

PinType

enum PinType

strong

Represents the type of pin to draw on the map.

Enumerator
PDW_BMP	Indicates that the pin should be an image.
PDW_CIRCLE	Indicates that the pin should be drawn as a circle.
PDW_SQUARE	Indicates that the pin should be drawn as a square.
PDW_DIAMOND	Indicates that the pin should be drawn as a diamond.

PinColor

enum PinColor

strong

Represents the type of pin to draw on the map.

Enumerator
Blue	Indicates that the pin should be blue.
Green	Indicates that the pin should be green.
Pink	Indicates that the pin should be pink.
Yellow	Indicates that the pin should be yellow.

ErrorType

enum ErrorType

strong

Represents the type of error, whether a warning or an exception.

Enumerator
Warning	Indicates a warning.
Exception	Indicates an error.

LayerType

enum LayerType

strong

Represents the content of an image layer within a ALK.PCM.Model.BusinessModels.RenderedMap which contains one or more ALK.PCM.Model.BusinessModels.Layer objects.

Enumerator
BaseMap	Indicates that the image layer is the base map.
ScaleOfMiles	Indicates that the image layer is the scale of miles (or kms) legend.
RouteLegend	Indicates that the image layer is the route legend.
RoadLegend	Indicates that the image layer is the road class legend.
HazMatLegend	Indicates that the image layer is the hazardous materials restrictions legend.
TrafficLegend	Indicates that the image layer is the traffic congestion legend.
PointMap	Indicates that the image layer contains only the points that would be overlayed on the base map.

DataVersion

enum DataVersion

strong

Represents the data version that a request should be sent to for REST methods that support MVS.

Enumerator
Current
PCM_EU
PCM_OC
PCM_SA
PCM_GT
PCM_AF
PCM_AS
PCM_ME
PCM_NA	</summary>
PCM_WW	</summary>
PCM_JP	</summary>
PCM_NASL	sub local data set version
PCM_MX	</summary>
PCM18	</summary>
PCM19	</summary>
PCM20	</summary>
PCM21	</summary>
PCM22	</summary>
PCM23	</summary>
PCM24	</summary>
PCM25	</summary>
PCM26	</summary>
PCM27	</summary>
PCM28	</summary>
PCM29	</summary>
PCM30	</summary>
PCM31	</summary>
PCM32	</summary>
PCM33	</summary>
PCM34	current data set version

RegionalDataSet

enum RegionalDataSet

strong

Represents the regional dataset a request should be sent to for REST methods that don't support MVS.

Enumerator
Current
PCM_EU
PCM_OC
PCM_SA
PCM_GT
PCM_AF
PCM_AS
PCM_ME
PCM_NA	</summary>
PCM_WW	</summary>
PCM_JP	</summary>
PCM_NASL	sub local data set version
PCM_MX	</summary>
PCM_NA_13Q2	</summary>
PCM_NA_17Q1	</summary>

MapRegion

enum MapRegion

strong

Represents the region to frame when generating a map when no center point, corners, route or pins are supplied.

Enumerator
NA	Indicates the North American continent.
Bermuda	Indicates Bermuda.
Canada	Indicates Canada.
Mexico	Indicates Mexico.
PuertoRico	Indicates Puerto Rico.
US	Indicates the United States.
EU	Indicates Europe.
OC	Indicates Oceania.
ME	Indicates the Middle East.
AF	Indicates Africa.
SA	Indicates South America.
AS	Indicates Asia

MapStyle

enum MapStyle

strong

Represents the visual look and feel of a map.

Enumerator
Default	Indicates the default map style.
Classic	Indicates a classic motif style.
Monochrome	Indicates a monochrome style.
RoadAtlas	Indicates a style that mimics a road atlas look and feel.
Darkness	Indicates a dark style: currently discontinued, use Night instead.
Modern	Indicates a modern style: currently discontinued, ue Default instead.
Contemporary	Indicates a contemporary style.
Night	Indicates a style optimized for night viewing.
Satellite	Indicates the style for satellite imagery.
Lightness	Indicates the style for lightness style.
Smooth	Indicates the style for smooth style.
Terrain	Indicates the style for terrain imagery.

VectorMapStyle

enum VectorMapStyle

strong

Represents the visual look and feel of an ALK vector map.

Enumerator
Transportation	Indicates the default map style.
DataLight	Indicates the data light style.
DataDark	Indicates the data dark style.
Satellite	Indicates the style for satellite imagery.
Terrain	Indicates the style for terrain imagery.
Basic	Indicates the basic style.

MapImageOption

enum MapImageOption

strong

Determines map drawing options.

Enumerator
Both	Basemap is overlayed on background image.
Background	Pure image underlay with no basemap overlay.
Foreground	Pure basemap transparent image with no underlay.

DrawerType

enum DrawerType

strong

Represents the types of layers that can be draw on a map.

Enumerator
Airports	Indicates airports.
AvoidFavor	Indicates that avoids and favors should be shown on the map.
City	Indicates cities.
CityLarge	Indicates large cities.
CommerciallyProhibited	Indicates commercially prohibited roads.
CountryBoundaries	Indicates county boundaries.
CountyBoundaries	Indicates county boundaries.
HazMat	Indicates hazardous material restrictions.
Land	Indicates land masses and in general this should always be included.
LinkLabel	Indicates road names.
MilitaryBases	Indicates military bases.
Network	Indicates roads.
OrthoImage	Indicates satellite imagery.
Parks	Indicates parks.
Place	Indicates points of interest.
PointDrawerWeb	Indicates user supplied points.
Railroads	Indicates rail roads.
Route	Indicates user supplied routes.
Shield	Indicates road shields.
ShieldInterstate	Indicates interstate road shields.
StaaDesignation	Indicates truck designations.
StateBoundaries	Indicates state and country boundaries.
Stop	Indicates the name of stops along a route.
TimeZone	Indicates time zone dividers.
TruckRestrictions	Indicates truck restrictions.
UrbanAreas	Indicates urban areas.
Water	Indicates water bodies such as oceans, lakes, rivers, etc.
ExitLabel	Indicates exit labels for roads
PolygonLabel	Indicates polygon labels
Edge	Shows supertile edges - debugging only

DrawerGroups

enum DrawerGroups

strong

Represents the types of layers that can be draw on a map.

Note that this enum supports flags, meaning more than one value can be set.

Enumerator
Cities	Indicates city
Labels	Indicates linklabel, shield
Roads	Indicates network, railroad
Commercial	Indicates truckrestrictions, staadesignation, hazmat
Borders	Indicates stateboundaries, countyboundaries
Areas	Indicates parks, militarybases, airports, urbanareas

ImageFormat

enum ImageFormat

strong

Represents the supported image formats for map and satellite.

Note that this enum supports flags, meaning more than one value can be set.

Enumerator
Png	Indicates png image
Jpeg	Indicates Jpeg image

ProjectionType

enum ProjectionType

strong

Represents the type of projection used for maps

Enumerator
Default	Indicates the default projection.
FixedLat	Indicates the fixed latitude projection, ie. ESPG:4326.
Mercator	Indicates the mercator projection, ie. ESPG:900913.

LegendType

enum LegendType

strong

Represents the type of legends available when requesting a map.

Enumerator
ScaleOfMiles	Indicates a Scale of miles (or kms) legend.
RouteLegend	Indicates a route legend.
RoadLegend	Indicates a road class legend.
HazMatLegend	Indicates a hazardous materials restrictions legend.
TrafficLegend	Indicates a traffic congestion legend.

POISearchType

enum POISearchType

strong

Type of POI search for POIs along route

Enumerator
FuelStop	</summary>
HoS	</summary>
Generic	</summary>

POIHosType

enum POIHosType

strong

The POI categories for HoS POIs along route

Enumerator
All	</summary>
TruckServiceHoS	</summary>
RestAreaHoS	</summary>

POIGenericType

enum POIGenericType : ushort

strong

The POI generic categories for POIs along route

Enumerator
All	</summary>
WeightStation	</summary>
CatScale	</summary>
LCVLot	</summary>
Hotel	</summary>
IntermodalRamp	</summary>
Parking	</summary>
RestAreaHoS	</summary>
TruckStop	</summary>
TruckServiceHoS	</summary>
HighwayExit	</summary>
MajorAirport	</summary>
EventFacility	</summary>
DistributionCenter	</summary>

POIType

enum POIType : ulong

strong

Specified the different categories of POIs.

Enumerator
All	Indicates to include all POITypes as the point of interest.
City	Indicates a city as the point of interest.
Zip	Indicates a zip as the point of interest.
Place	Indicates a custom place as the point of interest.
Airport	Indicates to include airports as the point of interest.
Automotive	Indicates to include automotive / vehicle repair facility as the point of interest.
WeighStation	Indicates to include weigh stations as the point of interest.
Dining	Indicates to include restaurants as the point of interest.
Education	Indicates to include schools and universities as the point of interest.
Emergency	Indicates to include emergency and medical facilities as the point of interest.
Government	Indicates to include government facilities as the point of interest.
Gas	Indicates to include gas stations as the point of interest.
Lodging	Indicates to include hotels and/or motels as the point of interest.
Parks	Indicates to include parks as the point of interest.
Retail	Indicates to include retial facilities as the point of interest.
RVServices	Indicates to include RV Services as the point of interest.
SportsRec	Indicates to include sports and recreation facilities as the point of interest.
Travel	Indicates to include travel and transportation as the point of interest.
TruckServices	Indicates to include truck services as the point of interest.
Attractions	Indicates to include attractions as the point of interest.
OilAndGas	Indicates to include GeoTrac Oil and Gas points of interest.
AutoDealership	</summary>
Bank	</summary>
BridgesAndTunnels	</summary>
BusTaxiLimo	</summary>
CATScales	</summary>
CityHall	</summary>
DieselExhaustFluid	</summary>
Entertainment	</summary>
EventFacility	</summary>
FerryTerminal	</summary>
GeographicFeature	</summary>
GroceryStore	</summary>
GuestHouse	</summary>
HighwayExit	</summary>
IntermodalRampLarge	</summary>
IntermodalRampMedium	</summary>
IntermodalRampSmall	</summary>
LCVLot	</summary>
Marina	</summary>
Municipal	</summary>
HighwayIntersection	</summary>
Other	</summary>
Parking	</summary>
PlaceOfWorship	</summary>
PoliceStation	</summary>
RailwayStation	</summary>
RentACar	</summary>
RestArea	</summary>
ATM	</summary>
DistributionCenter	</summary>
IntermodalRamp	</summary>

PolygonType

enum PolygonType

strong

Specifies the type of polygon for the geometry drawer.

Enumerator
Shape	Indicates a shape polygon.
Region	Indicates a region polygon.

ShapeType

enum ShapeType

strong

Specifies the polygon shapes to draw on the time.

The default value is None.

Enumerator
None	Indicates that no shape type is specified; this is the default value and should not be modified in order to draw a shape.
Line	Indicates the shape type is a line.
Circle	Indicates the shape type is a circle.
Rect	Indicates the shape type is a rectangle.
Ellipse	Indicates the shape type is an ellipse.
Polygon	Indicates the shape type is a polygon.

PointGroupDensity

enum PointGroupDensity

strong

Specifies the number of groups to be displayed on the map.

The default value is Average.

Enumerator
Few	Indicates a low density. This mean that the groups will be large and few.
Average	Indicates an average density. This is the default value.
Most	Indicates a high density. This means that the groups will be small and numerous.

PointSpread

enum PointSpread

strong

Specifies the distance between each point within a group.

The default value is average.

Enumerator
Most	Indicates a most spread between the points. This indicates the farther the images in a group will be drawn.
Average	Indicates that the system will define the points spread.
Cluster	Indicates a most cluster between the points.

StopLabelType

enum StopLabelType

strong

Specifies the label type for stops on the map.

The default value is Name.

Enumerator
Name	Indicates that the stop label displayed contains only the name.
Number	Indicates that the stop label displayed contains only the number.
Both	Indicates that the stop label displayed contains both the number and name.
None	Indicates that no stop label be displayed.

MapLayering

enum MapLayering

strong

Specifies the layer options for a map: 0: Map plus points on one layer. 1: Map only 2: Points only 3: Map and points on different layers.

Enumerator
MapAndPointsOneLayer	Indicates that the map and points layer is returned as one layer.
MapLayer	Indicates that only the map layer is returned.
PointsLayer	Indicates that only the points layer is returned.
MapAndPointsTwoLayers	Indicates that the map and points layer are returned on separate layers.
BackgroundOnly	Indicates that only the background layer is returned.
NoBackground	Indicates that no background layer is returned as part the map.

TrafficType

enum TrafficType

strong

Specifies the category of speed displayed.

The default is congestion.

Enumerator
Congestion	Indicates that the traffic information is for congestion data.
RoadSpeed	Indicates that the traffic information is of road speed data.
Neither	Indicates that no traffic information is requested.

TrafficTime

enum TrafficTime

strong

Specifies the Time type of speed data.

These can be combined. No base?

Enumerator
Actual	Indicates that the traffic feed is using real time data.
Historic	Indicates that the traffic information is using historical data.
Default	Indicates that the traffic information is using default data. This value is not valid when the TrafficType is Congestion.

AmPmType

enum AmPmType

strong

Specified the AM / PM value for the time.

The default is Military.

Enumerator
Military	Indicates the time is in 24-hour clock, also known as military format.
AM	Indicates the time in the AM period of the 12-hour clock.
PM	Indicates the time in the PM period of the 12-hour clock.

OutOfRouteCompliance

enum OutOfRouteCompliance

strong

Specifies the RouteSync out of route compliance level.

Enumerator
Strict	Strict RouteSync out of route compliance
Moderate	Moderate RouteSync out of route compliance
None	No RouteSync out of route compliance

WeatherType

enum WeatherType

strong

Represents the type of a weather image.

Enumerator
Radar	Radar weather image.
Satellite	Visible satellite weather image.

WeatherAlertCertainty

enum WeatherAlertCertainty

strong

Allows client to request all or one particular certainty level.

Enumerator
Observed	Request weather alerts for "Observed". Observed: Determined to have occurred or to be ongoing.
Likely	Request weather alerts for "Likely". Likely: Possibility is greater than 50% to occur.
Possible	Request weather alerts for "Possible" Possible: Is possible, but not likely to occur.
Unlikely	Request weather alerts for "Unlikely". Unlikely: Is not expected to occur.
Unknown	Request weather alerts for "Unknown". Unknown: Certainty is unknown.

WeatherAlertSeverity

enum WeatherAlertSeverity

strong

Allows client to request all or one particular severity level.

Enumerator
Extreme	Request weather alerts for "Extreme". Extreme: Extraordinary threat to life or property.
Severe	Request weather alerts for "Severe". Severe: Significant threat to life or property.
Moderate	Request weather alerts for "Moderate". Moderate: Possible threat to life or property.
Minor	Request weather alerts for "Minor". Minor: Minimal threat to life or property.
Unknown	Request weather alerts for "Unknown". Unknown: Severity is unknown.

WeatherAlertUrgency

enum WeatherAlertUrgency

strong

Allows client to request all or one particular urgency level.

Enumerator
Immediate	Request weather alerts for "Immediate". Immediate: Responsive action should be taken immediately.
Expected	Request weather alerts for "Expected". Expected: Responsive action should be taken soon.
Future	Request weather alerts for "Future". Future: Responsive action should be taken in the near future.
Past	Request weather alerts for "Past". Past: Responsive action is no longer required.
Unknown	Request weather alerts for "Unknown". Unknown: Urgency is unknown.

JurisdictionType

enum JurisdictionType

strong

Enum for distinguishing the jurisdiction type used to get the border polygons

Enumerator
County	County type
State	State type
Zip	Zip code

BackgroundImageProvider

enum BackgroundImageProvider

strong

Tile image provider

Enumerator
Default	Default image provider
Sat1	Premium satellite image provider for tiles and single image requests
Sat2	Premium satellite image provider for tiles and single image requests
Sat3	Premium satellite image provider for tiles and single image requests
Sat4	Premium satellite image provider for tiles and single image requests
Sat5	Premium satellite image provider for tiles and single image requests
Sat6	Premium satellite image provider for tiles and single image requests
ALKCurated	Standard satellite image provider for tiles and single image requests

RoadSurfaceProvider

enum RoadSurfaceProvider

strong

Road Surface Provider

Enumerator
Default	Default road surface provider
RC1	Alternate road surface provider 1

SpeedLimitType

enum SpeedLimitType

strong

Speed Limit Type for ReverseGeocoding posted speed limit

Enumerator
Default	Default road speed based on road classification
Historic	Historic road speed
Premium	TomTom data
Navteq	Navteq data
LinkBased	Speed from link data in NA
JWR	Jurisdiction Wide Rules

RouteSyncMessageVersion

enum RouteSyncMessageVersion

strong

RouteSync message version

Enumerator
Default	Default Version (V2), Serialized, Compressed
V3	Version 3, Compressed JSON
JSON	Uncompressed JSON

TrafficCameraImgResolution

enum TrafficCameraImgResolution

strong

Traffic camera image resolution

Enumerator
HalfJpeg	Half-sized JPEGs are in QCIF resolution (176x120 pixels).
FullJpeg	Full-sized JPEGs are in CIF resolution (352 x 240 pixels).
HugeJpeg	Huge-sized JPEGs are in 4CIF resolution (704 x 480 pixels).

GeocodeConfidenceLevel

enum GeocodeConfidenceLevel

strong

Geocoding Confidence Level

Enumerator
Exact	Exact match
Good	Good match
Uncertain	Uncertain match
Failed	No match

GeocodeCitySearchFilter

enum GeocodeCitySearchFilter

strong

Geocoding City Search Filter

Enumerator
CitiesWithZips	City searches should return the city centers and all associated zips for the city.
CityCentersOnly	City searches should return city centers only without all associated zips.

MapTileOverlay

enum MapTileOverlay

strong

Represents the map tile overlay.

Enumerator
TruckRestrictions	Truck Restrictions

RoutingLevel

enum RoutingLevel

strong

Represents type of RoutingLevel.

Enumerator
StreetLevel	Use street level geocoding and routing.
HighwayLevel	Use highway level geocoding and routing.

PoiSearchWindowUnits

enum PoiSearchWindowUnits

strong

Represents the type of estimated time.

Enumerator
Miles	Search window is miles based
Minutes	Search window is minutes based

SideOfStreetAdherenceLevel

enum SideOfStreetAdherenceLevel

strong

Represents the levels of adherence that apply a cost to a route if its destination is on the opposite side of the street.

Enumerator
Off	Will not reroute according to the side of the street.
Minimal	Adds a cost of a quarter of a mile to ending up on the wrong side of the street.
Moderate	Adds a cost of half a mile to ending up on the wrong side of the street.
Average	Adds a cost of one mile to ending up on the wrong side of the street.
Strict	Adds a cost of five miles to ending up on the wrong side of the street.
Adhere	Adds a cost of 10 miles to ending up on the wrong side of the street.
StronglyAdhere	Adds a cost of 1,000 miles to ending up on the wrong side of the street.

TrailerType

enum TrailerType

strong

Represents the type of Trailer for toll reports

Enumerator
None	</summary>
Trailer	</summary>
Caravan	</summary>

EngineEmissionType

enum EngineEmissionType

strong

Represents the type of Engine Emission for toll reports

Enumerator
Euro0	</summary>
EuroI	</summary>
EuroII	</summary>
EuroIII	</summary>
EuroIV	</summary>
EuroV	</summary>
EuroVI	</summary>
EuroEEV	</summary>

TimeWindowSequenceMethodType

enum TimeWindowSequenceMethodType

strong

Represents the optimization process on an TimeWindowSequence.

Enumerator
Optimize	Find the optimal sequence of stops.
ETA	Route via ETA on an already optimized sequence.

TimeWindowFormatType

enum TimeWindowFormatType

strong

Represents the time format for an TimeWindowSequence.

Enumerator
Hour24	00:00 - 23:59
Minutes	0 - 1439 (minutes after midnight)
Hour12	12:00a.m. - 11:59p.m.

TimeWindowUniqueClusterStrictnessLevel

enum TimeWindowUniqueClusterStrictnessLevel

strong

Decide how to handle unique cluster IDs provided in time window stops.

Enumerator
Off	Do not use unique cluster IDs, even if they are provided
On	Take unique cluster IDs into consideration with normal logic.
Only	Only resequence using unique cluster IDs, ignoring normal clustering and reclustering logic. Premium stops still cluster using normal logic, to make them less likely to be late.

TimeWindowHistoricSpeedDay

enum TimeWindowHistoricSpeedDay

strong

Chooses whether time window routing uses the current historic speed data or a fixed day of the week.

Enumerator
Current	</summary>
Sunday	</summary>
Monday	</summary>
Tuesday	</summary>
Wednesday	</summary>
Thursday	</summary>
Friday	</summary>
Saturday	</summary>

TimeWindowDeliveryType

enum TimeWindowDeliveryType

strong

Describes if a time window stop is a delivery or a pickup/collection.

Enumerator
Unknown	Don't know the delivery type.
Delivery	Stop is a delivery.
Pickup	Chooses whether time window routing uses the current historic speed data or a fixed day of the week.

RoadClass

enum RoadClass

strong

Road class corresponding to core TRoadClass

Enumerator
Closed	</summary>
Interstate	</summary>
InterstateNoRamps	</summary>
Divided	</summary>
Primary	</summary>
Ferry	</summary>
Secondary	</summary>
Ramp	</summary>
Local	</summary>
SubLocal	</summary>
Pathway	</summary>

SpeedCongestionRatio

enum SpeedCongestionRatio

strong

Speed Congestion Ratio for a Traffic Path

Enumerator
Unknown	Unknown congestion ratio
Closed	Road is closed
Heavy	Heavy congestion
Light	Light Congestion
Open	Little congestion

TileImageRatio

enum TileImageRatio

strong

Image ratios for vector maps raster tiles.

Enumerator
OneX	Image ratio of 1X used for 256x256 as well as 512x512 map tiles
TwoX	Image ratio of 2x used for 512x512 map tiles only.

TileSize

enum TileSize

strong

Tile size for vector maps raster tiles.

Enumerator
Standard256	Standard tile height and width of 256 px.
Large512	Large tile height and width of 512 px.

EPortalLanguages

enum EPortalLanguages

strong

E Portal Languages.

Enumerator
DATA_LANGUAGE	E Portal Languages.
ERR_LANGUAGE	E Portal Languages.
USENGLISH	E Portal Languages.
UKENGLISH	E Portal Languages.
GERMAN	E Portal Languages.
FRENCH	E Portal Languages.
SPANISH	E Portal Languages.
ITALIAN	E Portal Languages.
AUSTRALIAN	E Portal Languages.
DUTCH	E Portal Languages. E Portal Languages.
SWEDISH	E Portal Languages.
CZECH	E Portal Languages.
DANISH	E Portal Languages.
PORTUGUESE	E Portal Languages.
NORWEGIAN	E Portal Languages.
FINNISH	E Portal Languages.
GREEK	E Portal Languages.
TURKISH	E Portal Languages.
POLISH	E Portal Languages.
RUSSIAN	E Portal Languages.
ARABIC	E Portal Languages.
HUNGARIAN	E Portal Languages.
SLOVENIAN	E Portal Languages.
CATALAN	E Portal Languages.
BULGARIAN	E Portal Languages.
ROMANIAN	E Portal Languages.
SMPCHINESE	E Portal Languages.
CHINESE	E Portal Languages.
CROATIAN	E Portal Languages.
BRZPORTUGUESE	E Portal Languages.
SERBIAN	E Portal Languages.
SLOVAK	E Portal Languages.
LATAMSPANISH	E Portal Languages.
RESERVED	E Portal Languages.
ALBANIAN	E Portal Languages.
BASQUE	E Portal Languages.
BELARUSIAN	E Portal Languages.
BOSNIAN	E Portal Languages.
CHINESE_CANTONESE	E Portal Languages.
ESTONIAN	E Portal Languages.
GALICIAN	E Portal Languages.
INDONESIAN_BAHASA	E Portal Languages.
KOREAN	E Portal Languages.
LATVIAN	E Portal Languages.
LITHUANIAN	E Portal Languages.
MACEDONIAN_SLAVIC	E Portal Languages.
MALAY	E Portal Languages.
MOLDOVAN	E Portal Languages.
MONTENEGRIN	E Portal Languages.
THAI	E Portal Languages.
UKRAINIAN	E Portal Languages.
WELSH	E Portal Languages.
PINYIN	E Portal Languages.
ICELANDIC	E Portal Languages.
MALTESE	E Portal Languages.
HAWAIIAN	E Portal Languages.
HEBREW	E Portal Languages.
HINDI	E Portal Languages.
VIETNAMESE	E Portal Languages.
JAPANESE	E Portal Languages.
TRANSCRIBED	E Portal Languages.
FILIPINO	E Portal Languages.
FLEMISH	E Portal Languages.
BENGALI	E Portal Languages.
WORLDENGLISH	E Portal Languages.
GEORGIAN	E Portal Languages.
ASSAMESE	E Portal Languages.
GUJARATI	E Portal Languages.
KANNADA	E Portal Languages.
MALAYALAM	E Portal Languages.
MARATHI	E Portal Languages.
ORIYA	E Portal Languages.
PUNJABI	E Portal Languages.
TELUGU	E Portal Languages.
TAMIL	E Portal Languages.
MONGOLIAN	E Portal Languages.
URDU	E Portal Languages.
ARMENIAN	E Portal Languages.
AZERI	E Portal Languages.
FAROESE	E Portal Languages.
UZBEK	E Portal Languages.
KAZAKH	E Portal Languages.
GUARANI	E Portal Languages.
PERSIAN	E Portal Languages.
LANGCOUNT	E Portal Languages.

PcmwsExceptionCode

enum PcmwsExceptionCode

strong

Represents exception codes within a PcmwsException class.

Enumerator
SUCCESS	Indicates a success.
LEGACY_ERROR	Indicates an error code from a legacy PCMiler web service version 18-25.
INTRNL_FAIL	Indicates an internal failure.
INVLD_PROFILE_VER	Indicates that user's profile level only allow baseline data version.
TRIP_LIMIT_EXCEEDED	Indicates that the user exceeded maximum number of trips allowed.
INVLD_LOGIN	Indicates invalid login information.
LOGIN_DISABLED	Indicates that the user's account has been disabled.
INVLD_PROFILE	Indicates that the user's profile level does not allow access to functionality requested.
INVLD_PROFILE_ARRAY	Indicates that the user's profile level does not allow batch reporting.
INVLD_PROFILE_CANADIAN	Indicates that the user's profile level does not allow Canadian postal codes.
INVLD_PROFILE_DETAIL	Indicates that the user's profile level does not allow access to detailed report.
INVLD_PROFILE_COND	Indicates that the user's profile level does not allow access to condense directions report functionality.
INVLD_PROFILE_DIRECTIONS	Indicates that the user's profile level does not allow access to directions report functionality.
INVLD_PROFILE_ROAD	Indicates that the user's profile level does not allow access to road report functionality.
INVLD_PROFILE_STATE	Indicates that the user's profile level does not allow access to state report functionality.
INVLD_PROFILE_FUEL	Indicates that the user's profile level does not allow access to fuel report functionality.
INVLD_PROFILE_HUB	Indicates that the user's profile level does not allow access to hub routing.
INVLD_PROFILE_SPLC	Indicates that the user's profile level does not allow access to SPLC code functionality.
INVLD_PROFILE_PLACE_NAME	Indicates that the user's profile level does not allow access to custom places.
INVLD_PROFILE_STREETS	Indicates that the user's profile level does not allow access to anything but highway routing.
INVLD_PROFILE_STREETS_GEO	Indicates that the user's profile level does not allow access to street address functionality.
INVLD_PROFILE_FASTEST	Indicates that the user's profile level does not allow access to fastest routing.
INVLD_PROFILE_TRK_CFG	Indicates that the user's profile level does not allow access to truck configuration.
INVLD_PROFILE_TOLLDATA	Indicates that the user's profile level does not allow access to toll data.
INVLD_PROFILE_VEHICLE_TYPE	Indicates that the user's profile level does not allow access to setting vehicle type.
INVLD_ADDR	Indicates an invalid address, address not found or insufficient location input information.
CITY_STATE_ZIP_MISMATCH	Indicates that city and state do not match zip code.
INVLD_ZIP	Indicates an invalid zip/postal code.
INVLD_STATE	Indicates an invalid state for supplied data region.
INVLD_CITY_JURIS	Indicates that the city and state do not reside within the provided jurisdiction.
INVLD_PLACE_NAME	Indicates an invalid custom place name.
NO_CITY_ZIP	Reserved for future use.
INVLD_CITY	Indicates that the supplied city was not found.
INVLD_STATE_ABBR	Indicates that an invalid state abbreviation was specified.
PO_BOX_NO_ALLOWED	Indicates that the specified zip code is a PO Box zip code and is not suitable for routing.
FIND_MTCH_FAILED	Reserved for future use.
MISSING_TRIP_ORIGIN	Indicates that the trip's origin was not specified.
MISSING_TRIP_DEST	Indicates that the trip's destination was not specified.
MISSING_VARIABLE	Indicates that a required property value is missing.
INVLD_AF_TYPE	Indicates that an avoid favor to be saved had its ALK.Common.Model.AFType set to both Avoid and Favor.
INVLD_ROUTE_NAME	Indicates an invalid route name was specified when saving an ALK.PCM.Model.BusinessModels.AvoidFavor.
INVLD_CITE_INT	Indicates that the cite interval was not specified or invalid when requesting a geotunneling report.
INVLD_FUEL_OPT_COND	Reserved for future use.
INVLD_DEPART_TIME	Indicates an invalid departure time was specified in ALK.PCM.Model.BusinessModels.TimeCosts
INVLD_INT	Indicates an invalid integer value was specified; generally the integer value should be greater than or equal to 0.
INVLD_DBL	Indicates an invalid floating point value was specified; generally the value should be greater than or equal to 0.
INVLD_INPUT_PLACE	Indicates a failure to delete or save a custom place.
INVLD_METRIC_VAL	Indicates that an invalid metric numerical value was specified.
INVLD_MET_LGTH	Indicates that truck length must be less then 24.384 and meters.
INVLD_MET_HEIGHT	Indicates that the truck height must be less then 4.1148 meters.
INVLD_MET_WEIGHT	Indicates that the truck weight must be 4090.91 through 60000 pounds kilograms.
INVLD_MET_WIDTH	Indicates that the truck width must be either 2.4384 or 2.5908 meters.
INVLD_ENG_HEIGHT	Indicates truck height, length and width requires feet'inches" (For example 13'6").
INVLD_ENG_WEIGHT	Indicates that truck weight must be a numerical value and must be 9000 through 132000 pounds.
INVLD_ENG_WIDTH	Indicates that truck width must be either 96", 98" or 102".
INVLD_ENG_LENGTH	Indicates that truck length must be less then 80'.
INVLD_TOLL_DISCOUNT	Indicates an invalid toll discount program.
INVLD_STOP_INFO	Indicates an invalid route stop.
INVLD_DATE	Indicates that an invalid Date was passed in; date format should be mm/dd/yyyy.
INVLD_TIME	Indicates that an invalid time was passed in; date format should be hh:mm am/pm or H:mm where H denotes military time 0 to 23.
INVLD_RADIUS	Indicates that the radius value was invalid. Radius value needs to be an number greater than 0.
MISSING_FUEL_OPTIONS	Indicates that fuel optimization requested, but FuelOptions were not specified.
MISSING_FUEL_INFO	Reserved for future use.
MISSING_STOP_INFO	Indicates that there is missing StopLocation information. StopLocation requires (City and State) or Zip or Place Name or (Lat and Long) or SPLC.
MISSING_DATE_TIME	Indicates that the DateOption was set to Specific, but DateTime was not specified.
MISSING_DAY_OF_WEEK	Indicates that the DateOption was set to DayOfWeek, but DateTime.DayOfWeek was not specified.
INVLD_LAT	Indicates that the Latitude is invalid. This could be because the value is too large or non numeric data.
INVLD_LNG	Indicates that the Longitude is invalid. This could be because the value is too large or non numeric data.
INVLD_COORDS	Indicates that the latitude/longitude are invalid.
FUEL_OPT_ERR	Indicates that there was an error during fuel optimization request.
INVLD_TRIP	Indicates that there was an error during the route creation.
PARITY_MISMATCH	Indicates that there is a parity mismatch with the address range.
NO_STREET_NUMBER	Indicates that the address provided had no number.
DIRECTIONAL_MISMATCH	Indicates that the directional does not match or has bad placement.
STREET_TYPE_MISMATCH	Indicates that the street type does not match.
STREET_NAME_MISSPELL	Indicates that the street name is misspelled.
MULTIPLE_MATCHES	Indicates that the street has multiple exact matches.
NO_STREET_NAME	Indicates that that no street name was specified.
ADDR_OUT_OF_RANGE	Indicates that the address number is out of range.
STREET_NOT_IN_ZIP	Indicates that the street is not within zip code specified.
COORDS_ZIPCENTROID	Indicates that the coordinates returned are for the zip centroid.
EXTRA_FUEL_OPTIONS	Indicates that the fuel options were included, but fuel optimization was not requested for the route.
EXTRA_TRUCK_CONFIG	Indicates that the vehicle type is set to Auto, but the TruckCfg options were included. The automobile configuration will be used for the routing.
EXTRA_DATE	Indicates that an extra DateTime element was included when the DateOption type is set to 'current'.
EXTRA_REPORT	Indicates that duplicate report types were included. Only a single report of each type will be returned.
INVLD_DATA_VER	Indicates an invalid data version.
DEPCREATED_TOLL_TAG	Indicates that a particular toll discount program has been deprecated.
INVLD_GEO_LIST_CNT	Indicates that for versions 21 and older, only one location can be geocoded with geo list.
GEOCODE_ERROR	Indicates that the input location could not be geocoded.
GEOCODE_WARN	Indicates that the input location geocoded, but with warnings.
INVLD_TILE_INDEX	Indicates that the requested tile index is outside of the valid range.
EXTRA_ROUTE	Indicates that more than one route was supplied for the map when the least cost option was chosen.
EXTRA_DATA	Indicates that more data was supplied such as array length is too long.
INVLD_ROUTE_OPTIONS	Generic invalid route option
INVLD_VAL	Generic invalid value
DEPRECATED	Generic deprecated exception
GEOCODE_LIMIT_EXCEEDED	Indicates that the user exceeded maximum number of geocode allowed.
UNAVAILABLE_FEATURE	Indicates that a feature is not available.
STOP_LIMIT_EXCEEDED	Indicates that the user exceeded maximum number of stops allowed.
NO_ALLOWED_INTERPS	Indicates that the user has specified no valid interps.
INVALID_INTERP	Indicates that the user specified an invalid interp.
INVALID_FUEL_CONSUMPTION	Indicates that the user has specified a fuel consumption value that is out of range
INVLD_COUNTRY_ABBR	Indicates that an invalid country abbreviation was specified.
HOS_SERVICE_ERR	Indicates that hos service returned an error