PCMILER Web Services ASMX User’s · PDF file|i pcmiler web services asmx user’s guide table of contents pc*miler product line end-user license agreement..... v

Technology Beyond Miles Technology Beyond Miles

Technology Beyond Miles

User’s Guide

27Web Services

Technology Beyond Miles

PC*MILER Web Services ASMX User’s Guide

ALL RIGHTS RESERVED You may print one (1) copy of this document for your personal use. Otherwise, no part of this document may be reproduced, transmitted, transcribed, stored in a retrieval system, or translated into any language, in any form or by any means electronic, mechanical, magnetic, optical, or otherwise, without prior written permission from ALK Technologies, Inc. Microsoft and Windows are registered trademarks of Microsoft Corporation in the United States and other countries. IBM is a registered trademark of International Business Machines Corporation. PC*MILER, CoPilot, and ALK are registered trademarks and BatchPro and RouteMap are trademarks of ALK Technologies, Inc. GeoFUEL™ Truck Stop location data © Copyright 2012 Comdata Corporation®, a wholly owned subsidiary of Ceridian Corporation, Minneapolis, MN. All rights reserved. Traffic information provided by INRIX © 2013. All rights reserved by INRIX, Inc. SPLC data used in PC*MILER products is owned, maintained and copyrighted by the National Motor Freight Traffic Association, Inc. Canadian Postal Codes data based on Computer File(s) licensed from Statistics Canada. © Copyright, HER MAJESTY THE QUEEN IN RIGHT OF CANADA, as represented by the Minister of Industry, Statistics Canada 2003-2011. This does not constitute an endorsement by Statistics Canada of this product. Certain Points of Interest (POI) data by infoUSA © Copyright 2013. All Rights Reserved. ALK Technologies, Inc. reserves the right to make changes or improvements to its programs and documentation materials at any time and without prior notice. © Copyright 1994-2013 ALK Technologies, Inc. 457 North Harrison Street, Princeton, NJ 08540 www.pcmiler.com

| i


TABLE OF CONTENTS

PC*MILER PRODUCT LINE END-USER LICENSE AGREEMENT ...................................... V

CHAPTER 1: INTRODUCTION .............................................................................................1

1.1 ASMX Service Feature Option Levels ...................................................................5 1.2 Annual Release Versus Mid-Release Datasets .....................................................10

1.2.1 Accessing the Mid-Release Routing and Map Data Update ........................11 1.2.2 How to Access the Service ..........................................................................12

1.3 WSDL (Web Services Definition/Description Language) ...................................13 1.4 Recent Enhancements and New Features .............................................................14

1.4.1 Version 27.0 (Current North American Data and Version Release) ...........14 1.4.2 Version 27.1 (Current Worldwide Data and Version Release) ....................15

1.5 Technical Support .................................................................................................16 1.6 Database Support ..................................................................................................16 1.7 PC*MILER Sales Contact Options .......................................................................17

CHAPTER 2: INPUT STRUCTURE DEFINITIONS ................................................................18

2.1 LoginType .............................................................................................................19 2.2 LocationInputType ................................................................................................19 2.3 StopCostsType ......................................................................................................23 2.4 RouteCostsType ....................................................................................................24 2.5 TimeCostsType .....................................................................................................25 2.6 TruckConfigType ..................................................................................................26 2.7 OptionsType ..........................................................................................................27 2.8 EstimatedTimeOptions ..........................................................................................31 2.9 DateTimeOptions ..................................................................................................31 2.10 FuelOptType .......................................................................................................33 2.11 AvoidFavorType .................................................................................................34 2.12 RoadSpeedType ..................................................................................................35 2.13 MapPinLocationType .........................................................................................36 2.14 MapSettingsType ................................................................................................37 2.15 TrafficFlowDrawer .............................................................................................40 2.16 MapLegendOptions.............................................................................................41 2.17 ShapeDetail .........................................................................................................42 2.18 GeoLocType .......................................................................................................47 2.19 PointSearchType .................................................................................................48 2.20 CompLineType ...................................................................................................50 2.21 RouteLegDetail ...................................................................................................51 2.22 CircleDetail .........................................................................................................52 2.23 StateHighlightDetail ...........................................................................................53

Table of Contents | ii


CHAPTER 3: API DESCRIPTIONS .....................................................................................54

3.1 PMWSGetReport ..................................................................................................54 3.2 PMWSGetMapRoute ............................................................................................77 3.3 PMWSGetMap ......................................................................................................83 3.4 PMWSGetETAOutOfRoute .................................................................................89 3.5 PMWSGetMapBreadcrumbTrail ..........................................................................92 3.6 PMWSSetMapCustomPlace .................................................................................97 3.7 PMWSGetCustomPlace ......................................................................................101 3.8 PMWSSetAvoidFavor ........................................................................................104 3.9 PMWSGetAvoidFavor .........................................................................................105 3.10 PMWSSetRoadSpeed .......................................................................................107 3.11 PMWSGetRoadSpeed .......................................................................................108 3.12 PMWSGeoCode ................................................................................................111 3.13 PMWSRadiusSearch .........................................................................................115 3.14 PMWSReduceTrip ............................................................................................118 3.15 PMWSGetMapRoutes.......................................................................................122 3.16 PMWSGetStates ...............................................................................................128 3.17 PMWSAbout .....................................................................................................131 3.18 RequestHeader ..................................................................................................131

CHAPTER 4: OUTPUT STRUCTURE DEFINITIONS ..........................................................132

4.1 ErrorType ............................................................................................................133 4.2 ArrayOfErrorType ..............................................................................................133 4.3 LocationOutputType ...........................................................................................134 4.4 DirLineType ........................................................................................................135 4.5 DirStructType .....................................................................................................136 4.6 DtlLineType ........................................................................................................136 4.7 DtlStructType ......................................................................................................138 4.8 StpLineType ........................................................................................................138 4.9 OORLineType.....................................................................................................139 4.10 EORStructType .................................................................................................140 4.11 SCLineType ......................................................................................................141 4.12 StStructType .....................................................................................................141 4.13 RoadLineType ...................................................................................................142 4.14 FuelStopLineType .............................................................................................143 4.15 FuelSummaryType ............................................................................................143 4.16 FuelReportType ................................................................................................145 4.17 RadiusReportType ............................................................................................145 4.18 ReportType .......................................................................................................146 4.19 MapType ...........................................................................................................147 4.20 MapPointInfo ....................................................................................................149

Table of Contents | iii


CHAPTER 5: PC*MILER.NET WEB CONTROLS .........................................................150

5.1 Introduction ..........................................................................................................150 5.2 Technical Specifications ......................................................................................151 5.3 Using .NET Web Controls With Visual Studio ...................................................151 5.4 About the Map Control ........................................................................................153

CHAPTER 6: PC*MILER FEATURE DESCRIPTIONS ....................................................155

6.1 PC*MILER Routing Types and Options .............................................................155 6.1.1 Practical Routing ........................................................................................155 6.1.2 Shortest Routing.........................................................................................155 6.1.3 Toll Discouraged Routing (U.S. and Canada only) ...................................155 6.1.4 National Network Routing (U.S. only) ......................................................156 6.1.5 53'/102'' Trailer or Twins Routing (U.S. and Canada only) ......................157 6.1.6 Routing for Different Sized Vehicles ........................................................157

6.1.6.1 Light Vehicle Automobile Routing ..................................................158 6.1.7 Hub Routing ...............................................................................................158 6.1.8 Least Cost Routing .....................................................................................158 6.1.9 Time-Based Routing ..................................................................................160 6.1.10 Using Traffic Data For Time Estimates ...................................................161 6.1.11 Hazardous Material Routing ....................................................................162 6.1.12 Trip Costs .................................................................................................167 6.1.13 Stop Costs (Time and Cost Estimates for Individual Stops) ....................168

6.1.13.1 Additional Time ..............................................................................168 6.1.14 Average Road Speeds (Estimated Travel Time) ......................................169

6.1.14.1 PC*MILER Road Classifications: ..................................................169 6.1.15 Route Optimization ...................................................................................170

6.2 Adding Stops To a Route ....................................................................................171 6.2.1 City Name and State/Country Abbreviation ...............................................171 6.2.2 Address Entry (U.S.,Canada and Europe only) ..........................................172 6.2.3 Entering ZIP and Postal Codes ...................................................................172 6.2.4 Canadian Postal Codes ................................................................................173 6.2.5 SPLC (Standard Point Location Codes) (U.S. only) ...................................173 6.2.6 Latitude/Longitude Points ...........................................................................173 6.2.7 Truck Stop Locations (U.S. and Canada only) ...........................................173 6.2.8 CAT Scale Weigh Stations (U.S. and Canada only) ..................................173 6.2.9 State Weigh Stations (U.S. only).................................................................174

6.3 Reports ................................................................................................................174 6.3.1 Trip Distance Report ..................................................................................174 6.3.2 Batch Trip Distance Report .......................................................................174 6.3.3 State/Country Distance Summary Report ..................................................174

6.3.3.1 Order of States in the State/Country Distance Summary Report ......174 6.3.4 Detailed Route Report................................................................................174 6.3.5 Driving Directions Report ..........................................................................175 6.3.6 Road Type Report .......................................................................................175 6.3.7 Condensed Directions Report .....................................................................176

Table of Contents | iv


6.3.8 ETA/OoR Report ........................................................................................177 6.3.8.1 OoR Calculation ................................................................................177 6.3.8.2 ETA Calculation ...............................................................................178

6.3.9 Fuel Optimization Report ...........................................................................178 6.4 PC*MILER|Fuel Optimization (U.S. and Canada only) ....................................178 6.5 PC*MILER|Tolls (U.S. and Canada only) .........................................................179

6.5.1 Time-Based Toll Cost Reporting ................................................................181 6.5.2 Customizing Toll Costs by Weight and Axle .............................................181

6.6 infoUSA Points of Interest on the Map (U.S. only) ............................................182 6.7 Mapping and Map Options .................................................................................183

6.7.1 Map Controls ..............................................................................................183 6.7.2 Mapping Icons ............................................................................................184

CHAPTER 7: ABOUT ALK TECHNOLOGIES ..................................................................186

7.1 Enterprise Solutions from ALK Technologies ...................................................187

APPENDIX A: ACCESS POLICIES FROM NATIONAL NETWORK ROUTES TO TERMINALS AND SERVICES .....................................................................192

APPENDIX B: CANADIAN COUNTIES & TOURISM REGIONS ..........................................200

APPENDIX C: NORTH AMERICAN STATE/PROVINCE/ESTADO ABBREVIATIONS ..........203

APPENDIX D: COUNTRY ABBREVIATIONS AND POSTAL CODE ACCESS .......................206

APPENDIX E: POSTAL CODE FORMATS IN WORLDWIDE REGIONS ..............................215

APPENDIX F: PC*MILER WEB ERRORS & WARNINGS ..............................................217

APPENDIX G: VALID ENTRIES FOR STREET ADDRESSES (U.S. and Canada only) .......222

APPENDIX H: DEFAULT ROAD SPEEDS BY JURISDICTION AND ROAD CATEGORY .......225

APPENDIX I: MIGRATING APPLICATIONS FROM ALK|FLEETSUITE DIRECTIONS TO PC*MILER WEB SERVICES ...............................................................239

APPENDIX J: SAMPLE CODE ...........................................................................................240

APPENDIX K: TOLL PLAZA NAMES IN REPORTS (U.S. and Canada only) ....................241

APPENDIX L: TOLL ROADS REQUIRING ELECTRONIC PAYMENT (U.S. and Canada only) ..........................................................242

| v


PC*MILER Product Line End-User License Agreement

1. Grant of License: Subject to the terms, conditions, use limitations and payment of fees

as set forth herein, ALK Technologies, Inc. (“ALK”) grants the end-user (“you”) a license to install and use the PC*MILER solution(s) (including traffic data subscriptions) you have purchased (“PC*MILER”) on a single personal computer. The PC*MILER software, data and documentation are provided for your personal, internal use only and not for resale. They are protected by copyright held by ALK and its licensors and are subject to the following terms and conditions which are agreed to by you, on the one hand, and ALK and its licensors (including their licensors and suppliers) on the other hand.

2. Title: You acknowledge that the PC*MILER computer programs, data, concepts,

graphics, documentation, manuals and other material by, developed by or licensed to ALK, including but not limited to program output (together, “program materials”), are the exclusive property of ALK or its licensors. You do not secure title to any PC*MILER program materials by virtue of this license.

3. Copies: You may make one (1) copy of the PC*MILER program materials, provided you retain such copy in your possession and use it solely for backup purposes. You agree to reproduce the copyright and other proprietary rights notices of ALK and its licensors on such a copy. Otherwise, you agree not to copy, reverse engineer, interrogate or decode any PC*MILER program materials or attempt to defeat protection provided by ALK for preventing unauthorized copying or use of PC*MILER or to derive any source code or algorithms therefrom. You acknowledge that unauthorized use or reproduction of copies of any program materials or unauthorized transfer of any copy of the program materials is a serious crime and is grounds for suit for damages, injunctive relief and attorneys' fees.

4. Limitations on Transfer: This license is granted to you by ALK. You may not directly or indirectly lease, sublicense, sell or otherwise transfer PC*MILER or any PC*MILER program materials to third parties, or offer information services to third parties utilizing the PC*MILER program materials without ALK's prior written consent. To comply with this limitation, you must uninstall PC*MILER from your computer prior to selling or transferring that computer to a third party.

5. Limitations on Network Access: You may not allow end-users or software applications on other computers or devices to directly or indirectly access this copy of PC*MILER via any type of computer or communications network (including but not limited to local area networks, wide area networks, intranets, extranets, the internet, virtual private networks, Wi-Fi, Bluetooth, and cellular and satellite communications systems), using middleware (including but not limited to Citrix MetaFrame and Microsoft Terminal Server) or otherwise (including but not limited to access through PC*MILER connectivity products), or install or use PC*MILER on a network file server, without first notifying ALK, executing a written supplemental license agreement, and paying

Terms of Use | vi


the license fee that corresponds to the number and types of uses to which access is to be allowed.

6. Limitations on Data Extraction: You may extract data (including but not limited to

program output such as distances, maps, and driving directions) from PC*MILER and use it in other applications on the same computer on which PC*MILER is legally licensed and installed. You may not transfer data extracted from PC*MILER onto any other computer or device unless you have licensed PC*MILER for that computer or device.

7. Limitations on Mobile Communications: Without limiting the generality of the foregoing, you may not transmit PC*MILER street-level driving directions through mobile communications systems such as Qualcomm, satellite, or cellular services or to mobile devices such as computers, handhelds, pagers, or telephones without first executing a written supplemental license agreement with ALK and paying the license fee that corresponds to the number and types of devices and systems to and through which transmission is to be permitted.

8. Limitations on Disclosure: You may disclose PC*MILER distances to trading partners for specific origin-destination moves for which you provide transportation services and use PC*MILER distances as a basis for payment. You may not make any other disclosure of PC*MILER programs and materials, including but not limited to program output, to anyone outside the legal entity that paid for and holds this license, without prior written permission of ALK. You acknowledge that the PC*MILER programs and materials by, developed by or licensed to ALK are very valuable to ALK and its licensors, and their use or disclosure to third parties except as permitted by this license or by a written supplemental license agreement with ALK is strictly prohibited.

9. Security: You agree to take reasonable and prudent steps to safeguard the security of the PC*MILER program materials and to notify ALK immediately if you become aware of the theft or unauthorized possession, use, transfer or sale of the PC*MILER program materials licensed to you by ALK.

10. Acceptance: You are deemed to have accepted the PC*MILER program materials

upon receipt. 11. Warranties: ALK represents and warrants that:

A. For ninety (90) days from date of purchase, PC*MILER, when delivered and

properly installed, will function substantially according to its specifications on a computer purchased independently by you.

B. For ninety (90) days from date of purchase, the software media on which ALK

provides PC*MILER to you will function substantially free of errors and defects. ALK will replace defective media during the warranty period at no charge to you unless the defect is the result of accident, abuse, or misapplication of the product.

C. THE FOREGOING WARRANTIES ARE IN LIEU OF ALL OTHER

WARRANTIES EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITING

Terms of Use | vii


THE GENERALITY OF THE FOREGOING ANY WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR USE. THE PC*MILER PROGRAM, DATA AND DOCUMENTATION IS SOLD "AS IS". IN NO EVENT SHALL ALK OR ITS LICENSORS BE LIABLE FOR ANY INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES SUCH AS, BUT NOT LIMITED TO, LOSS IN CONNECTION WITH OR ARISING OUT OF THE EXISTENCE OF THE FURNISHING, FUNCTIONING OR USE OF ANY ITEM OF SOFTWARE, DATA OR SERVICES PROVIDED FOR IN THIS AGREEMENT. IN THE EVENT THAT A COURT OF PROPER JURISDICTION DETERMINES THAT THE DAMAGE LIMITATIONS SET FORTH ABOVE ARE ILLEGAL OR UNENFORCEABLE THEN, IN NO EVENT SHALL DAMAGES EXCEED THE CONTRACT PRICE. THIS WARRANTY SHALL NOT ACCRUE TO THE BENEFIT OF THIRD PARTIES OR ASSIGNEES.

12. Disclaimer: The data may contain inaccurate, incomplete or untimely information due to the passage of time, changing circumstances, sources used and the nature of collecting comprehensive geographic data, any of which may lead to incorrect results. PC*MILER’s suggested routings and traffic data are provided without a warranty of any kind. The user assumes full responsibility for any delay, expense, loss or damage that may occur as a result of their use. The user shall have no recourse against Canada, whether by way of any suit or action, for any loss, liability, damage or cost that may occur at any time, by reason of possession or use of Natural Resources Canada data.

13. Termination: This Agreement will terminate immediately upon any of the following

events:

A. If you seek an order for relief under the bankruptcy laws of the United States or similar laws of any other jurisdiction, or a composition with or assignment for the benefit of creditors, or dissolution or liquidation, or if proceedings under any bankruptcy or insolvency law are commenced against you and are not discharged within thirty (30) calendar days.

B. If you materially breach any terms, conditions, use limitations, payment obligations,

or any other terms of this Agreement. C. Upon expiration of any written supplemental license agreement between you and

ALK of which this license is a part.

14. Obligations on Termination: Termination or expiration of this Agreement shall not be construed to release you from any obligations that existed prior to the date of such termination or expiration.

15. Hold Harmless and Indemnity: To the maximum extent permitted by applicable law,

you agree:

Terms of Use | viii


A. to hold harmless and indemnify ALK and its subsidiaries, affiliates, officers, agents, licensors, co-branders or other partners, and employees from and against any third party claim (other than a third party claim for Intellectual Property Rights) arising from or in any way related to your use of PC*MILER, including any liability or expense arising from all claims, losses, damages (actual and/or consequential), suits, judgments, litigation costs and attorneys' fees, of every kind and nature. ALK shall use good faith efforts to provide you with written notice of such claim, suit or action; and

B. to indemnify Canada and its officers, employees, agents and contractors from all

claims alleging loss, costs, expenses, damages or injuries (including injuries resulting in death) arising out of your possession or use of Natural Resources Canada data.

16. Canada: DISCLOSURE FOR PRODUCTS CONTAINING CANADIAN POSTAL

CODE AND/OR CANADIAN STREET-LEVEL DATA: Based on Computer File(s) licensed from Statistics Canada. © Copyright, HER MAJESTY THE QUEEN IN RIGHT OF CANADA, as represented by the Minister of Industry, Statistics Canada 2003-2011. ALK Technologies, Inc. is an Authorized User of selected Statistics Canada Computer File(s) and Distributor of derived Information Products under Licensing Agreement 6147. No confidential information about an individual, family, household, organisation or business has been obtained from Statistics Canada.

17. Disclosure for products containing Historical or Real-time Traffic data: traffic data,

including historical traffic data, is licensed as a subscription service which must be renewed annually for continued use. ALK and its licensor(s) will use commercially reasonable efforts to make traffic data available at least 99.5% of the time each calendar month, excluding minor performance or technical issues as well as downtime attributable to necessary maintenance, and Force Majeure.

18. Limitations on Export: You hereby expressly agree not to export PC*MILER, in whole

or in part, or any data derived therefrom, in violation of any export laws or regulations of the United States.

19. Miscellaneous: This Agreement shall be construed and applied in accordance with the

laws of the State of New Jersey. The Courts of the State of New Jersey shall be the exclusive forum for all actions or interpretation pertaining to this Agreement. Any amendments or addenda to this Agreement shall be in writing executed by all parties hereto. This is the entire Agreement between the parties and supersedes any prior or contemporaneous agreements or understandings. Should any provision of this Agreement be found to be illegal or unenforceable, then only so much of this Agreement as shall be illegal or unenforceable shall be stricken and the balance of this Agreement shall remain in full force and effect.

| 1


With the emergence of Web services platforms that provide the ability of one computer to get information from another computer without human intervention, companies are seeing an immediate increase in the efficiency of their back-office functions. PC*MILER Web Services provides a standardized environment in which your transportation costs such as rates, routes, actual driven mileage, driver satisfaction, surcharges, and toll costs can be accurately managed. ALK’s latest Web Services product continues to increase PC*MILER’s leadership position in the transportation industry. The benefits provided by PC*MILER Web Services include:

Access an accurate and reliable single-source of PC*MILER functionality.

Manage and plan all routing, mileage and mapping requests.

Standardize transportation transactions in a simple ubiquitous system-interface to any platform.

Eliminate the need for extra IT resources, including maintaining and supporting multiple servers.

Streamline freight payment/audit procedures.

Decrease time to market with optimized routes and standard mileage reports. PC*MILER Web Services is designed to efficiently fulfill all PC*MILER routing, mileage and mapping transactions in a simple ubiquitous system-interface to any platform. Web services in general allow different applications from different sources to communicate with each other without time-consuming custom coding, and because all communication is in XML, Web services are not tied to any one operating system or programming language. For example, Java can talk with Perl, and Windows applications can talk with UNIX applications. A hardware and software agnostic interface, PC*MILER Web Services gives you the ability to access all the functionality associated with the core PC*MILER product, making it easier to share data and improve efficiency. It offers a standardized way of integrating Web-based applications using XML and SOAP over an Internet Protocol Backbone, where XML is used to tag data and SOAP is used to transfer the data. Developers can then add the Web service to a GUI (such as a Web page or an executable program) to offer specific functionality to users. Technical benefits of PC*MILER Web Services include:

Access to an open-source, platform agnostic, Microsoft .NET XML Interface. A schema driven SOAP/XML interface developed in .NET.

Alternative programming interface to our existing COM, Java, or OLE-enabled development environments (Visual Basic, Visual C++, and ASP).

Chapter 1: Introduction

Chapter 1: Introduction | 2


Additional mileage solution to PC*MILER’s existing PC, Unix/Linux, AS/400, and Mainframe-based solutions.

The security of knowing that the service is hosted in an enterprise-ready data center to provide you with a consistent and reliable source for your mileage, mapping and routing needs.

Transparent access to mid-release and/or annual map, data and routing updates to keep your operations in one central location, running on the most reliable routes.

Seamless integration with Web Services or .NET interfaces or applications.

PC*MILER Web Services is housed in a production-ready data center on a number of servers as part of a server farm. A load balancing router will act as a gateway to these servers, and forward requests appropriately. The diagrams below are high-level graphical representations of PC*MILER Web Services.

Topography Model



Context Model

Process Model: Inbound and Outbound Inbound



Outbound



1.1 ASMX Service Feature Option Levels Powered by PC*MILER’s core feature set, the PC*MILER Web Services ASMX service gives users the flexibility to choose from four different Feature Option Levels to gain access to features of choice, including the following major features (see the Feature Option Level Table in the following pages for a full description of all feature sets):

North America truck-specific routing, mileage and mapping that spans over 6.4 million miles of highways including 3.52 million commercial truck restrictions and allowances.

Access nationwide US and Canadian truck-specific street-level data with more than 7 million street-level miles, over 140 million nationwide US street address, and 30.2 million nationwide Canadian street addresses.

Access to worldwide data coverage with borderless routing to generate routes between Europe, Asia and Africa; Central American countries down to the Panama Canal are accessible for routing to and from Mexico, the United States and Canada (with Worldwide feature level access).

Generate exact toll costs for toll roads, toll bridges, tunnels, and ferries for U.S. and Canadian toll authorities for both cash and discount toll program transactions.

Routing parameters based on Practical, Fastest or Shortest distances or by further customizing a route by combining these with National Network, 53'/102'' Trailer or Twins, Toll Discouraged, Hazardous Materials, or Hub Routing,

Visualize route-specific real-time and historical traffic trends directly on the map.

Define a departure or arrival date and time for more realistic transit times per route.

Least Cost Routing feature generates optimal routes based on custom fuel efficiency and operation cost settings.

Greenhouse Gas (GHG) estimator available in route calculations and reports; estimated emissions in pounds of CO2 per gallon of fuel.

Route optimization will resequence an unlimited number of stops for efficient routing planning.

Graphically display PC*MILER’s data on the RouteMap™.

Generate various reports such as Trip Mileage, Detailed Driving Directions (in full or condensed text), State/Country Mileage Summary, or the ETA/Out-of-Route Mileage Report as examples.

Improve arrival times by optionally including border crossing wait times and road speeds by country in a route’s overall travel time calculation.

Calculate stop costs and driver break options for more accurate trip costs, travel and arrival times, and hours of service compliance in route calculations.



ASMX Service Feature Option Level Table

Features Lite1 Standard PremiumNorth

American Versions2

Standard-Worldwide

Premium-Worldwide

Region(s) Accessible

In3

Worldwide Versions2

DA

TA

FE

AT

UIR

ES

Routing Database: North America 18 – 27 NA 24.1 - 27.1

Routing Database: Africa AF 24.1 - 27.1

Routing Database: Asia AS 24.1 - 27.1

Routing Database: Europe EU 24.1 - 27.1

Routing Database: Oceania OC 24.1 - 27.1

Routing Database: South America

SA 24.1 - 27.1

Truck Stops 18 – 27 NA 24.1 - 27.1

Weigh Stations 18 – 27 NA 24.1 - 27.1

County Designations for Cities4 18 – 27 ALL 24.1 - 27.1

Country Abbreviations: FIPS 18 – 27 ALL 24.1 - 27.1

Country Abbreviations: ISO 2-Character and ISO 3-Character

ALL 24.1 - 27.1

Geocoding 18 – 27 ALL 24.1 - 27.1

infoUSA® Points of Interest 21 – 27 NA 24.1 - 27.1

Geographic Points of Interest 18 – 27 NA 24.1 - 27.1

Postal Code Coverage (outside of N. America) ALL 24.1 - 27.1

U.S. ZIP Codes 18 – 27 NA 24.1 - 27.1

Canadian Postal Codes 18 – 27 NA 24.1 - 27.1

Mexican Postal Codes 26 – 27

Standard Point Location Codes 18 – 27 NA 24.1 - 27.1

Truck-Specific Toll Costs 20 – 27 NA 24.1 - 27.1

Toll Costs for Light Vehicles 26 – 27

Toll Plaza Names in Reports 24 – 27 NA 24.1 - 27.1




American Versions2

Standard-Worldwide

Premium-Worldwide


In3

Worldwide Versions2

RO

UT

ING

OP

TIO

NS

Truck-Specific Routing 18 – 27 ALL 24.1 - 27.1

Light Vehicle (Automobile) Routing

26 – 27

Practical Routing 18 – 27 ALL 24.1 - 27.1

Shortest Routing 18 – 27 ALL 24.1 - 27.1

National Network Routing 18 – 27 NA 24.1 - 27.1

Toll Discouraged Routing 18 – 27 NA 24.1 - 27.1

53'/102'' Trailer or Twins Routing 18 – 27 NA 24.1 - 27.1

Region-to-Region Routing ALL 24.1 - 27.1

Borders Open/Closed Routing 18 – 27 ALL 24.1 - 27.1

Override Truck Restrictions 18 – 27 NA, EU 24.1 - 27.1

Distances in Miles/Kilometers 18 – 27 ALL 24.1 - 27.1

Route Stop Optimization 18 – 27 ALL 24.1 - 27.1

Cost Estimates and Break Times 18 – 27 ALL 24.1 - 27.1

Border Wait Time Calculation ALL 24.1 - 27.1

By Route Greenhouse Gas Estimator

24 – 27 ALL 24.1 - 27.1

Multi-Stop Routing 18 – 27 ALL 24.1 - 27.1

Define Departure/Arrival Date/Time

26 – 27 ALL 24.1 - 27.1

Hub Routing 18 – 27 ALL 24.1 - 27.1

Set Road Speeds by State/Country 18 – 27 ALL 24.1 - 27.1

Designate Custom Roads 18 – 27 NA, EU 24.1 - 27.1

Vehicle Dimension Routing 22 – 27

Least Cost Routing Feature 24 – 27

Use Traffic Data for ETA/ETD 26 – 27

Toll Costs Based on Time of Day 26 – 27 ALL 24.1 - 27.1

(Continued on next page…)




American Versions2

Standard-Worldwide

Premium-Worldwide


In3

Worldwide Versions2

Street-Level Routing in the U.S. 18 – 27 NA 24.1 - 27.1

Street-Level Routing in Canada 18 – 27 NA 24.1 - 27.1

Hazardous Materials Routing 18 – 27 NA, EU 24.1 - 27.1

Setting Hazardous Materials Permits

18 – 27 NA, EU 24.1 - 27.1

RE

PO

RT

S

Trip Distance Report 18 – 27 ALL 24.1 - 27.1 GeoTunnel Report 23 – 27 ALL 24.1 - 27.1 State/Country Distance Report 18 – 27 ALL 24.1 - 27.1 Detailed Route Report 18 – 27 ALL 24.1 - 27.1 Driving Directions Report 18 – 27 ALL 24.1 - 27.1 Road Type Report 20 – 27 ALL 24.1 - 27.1 Batch Trip Distance Report 18 – 27 ALL 24.1 - 27.1 Condensed Driving Directions 18 – 27 NA 24.1 - 27.1

ETA/OoR Report Current

Version Only ALL 24.1 - 27.1

Fuel Optimization Report5 21 – 27 NA 24.1 - 27.1

MA

PP

ING

5

Map Display Current

Version Only ALL Current Version Only

Map Multiple Destinations Current

Version Only

Map Customizations Current


Map Controls Current


Traffic Display on Map Current


Map a Vehicle’s Route Current


Location Radius Search6 Current




S

ER

VIC

ES

Hosted in Data Center 18 – 27 ALL 24.1 - 27.1

3rd Party System Integration 18 – 27 ALL 24.1 - 27.1

Graphical User Interface (GUI) 18 – 27

Annual Updates Current


U.S. ZIP Code Mid-Release Updates

Current Version Only NA Current

Version Only

Toll Data Mid-Release Updates Current

Version Only NA Current Version Only

Map and Data Mid-Release Updates

Current

Version Only

Multiple Version Support7 18 – 27 ALL 24.1 - 27.1

NOTES: 1 Beginning in Version 25, the Lite Feature Option Level is available only to the following types of companies: Load Boards, Fuel Tax

Services, Freight audit/payment companies, Benchmarking services, and other types of Bureaus. 2 The Version column lists the versions in which the applicable feature is accessible. 3 Regions available include: Africa (AF), Asia (AS), Europe (EU), North America (NA), Oceania (OC), and South America (SA).

“ALL” refers to the listed feature being accessible in all regions.

4 County designations are available in select countries. 5 Requires an account on fueladvice.com. 6 For companies who qualify as Load Boards, the Location Radius feature is available at all Feature Option Levels. For accounts

that are not designated as a “Load Board Account”, then the Location Radius feature is only available on the Premium Feature Option Level.

7 Multiple version support only provides access to the basic mileage and reporting features listed for the applicable versions.

NOTE: Enterprise versions are also available. Please contact us for more information. If you are an Enterprise user, the features available in your interface are the same as the Premium Feature Option Level, with the exception of Traffic Features, which are not available for Enterprise versions installed locally.



1.2 Annual Release Versus Mid-Release Datasets ALK’s North American routing, mapping, toll data, and U.S. ZIP Code databases are released annually and updated three times during the release year. All PC*MILER Web Services users can access the current annual release dataset. Premium and Premium-Worldwide users can, in addition, access current mid-release datasets and past annual release datasets for the versions available in the service. IMPORTANT NOTE: PC*MILER Web Services provides connections to the most current version release and to past releases. ALK recommends using the current version for everything other than rating and auditing trips made in the 12 months following a past release where necessary. If the intended use of the product includes generating driving directions, we strongly recommend that the newest version release is not only integrated but is the version that’s accessed when requesting routing results. Each new version release provides the most up-to-date highway and street-level network data available; enhancements include updated truck restrictions and allowances, new highways and streets, updated exit ramp structures, road alignment enhancements, and more. The current annual release dataset is updated three times within the year for toll rates (in the U.S. and Canada only, and accessible to Premium and Premium-Worldwide users only) and, beginning with version 24, for additions of U.S. ZIP codes; and it is updated semi-annually with additions of Canadian Postal Codes. It is also updated for occasional closings of interstate highways expected to last for more than one month, which are the only updates that are made to the current annual release dataset. All other types of updates will be released in the next mid-release or annual dataset, including changes resulting from customer-reported data issues. For a more complete description of the types of data contained in PC*MILER, including data accessible only to Premium and Premium-Worldwide users, see section 1.1 and Chapter 6, PC*MILER Feature Descriptions. If you are using PC*MILER as a basis of payment, you should first agree with your payer or payee on whether to use a particular annual version, the most current annual version, or the most current mid-release version, and purchase a feature level that supports that agreement. You will then need to set the data version field accordingly, following the instructions for the DataVer field in the next section (see section 1.2.1). North American Database Update Details. Annual Release Datasets for North America are updated three times a year with toll rates (Premium and Premium-Worldwide users only) and, starting with version 24, additional U.S. ZIP Codes. On occasion the annual release dataset will be updated with major highway closings expected to last more than one month. These updates are available to all Web Services feature levels and to PC*MILER desktop and network customers. The three mid-release dataset updates available to Premium and Premium-Worldwide users contain additional streets, highways and address data as well as an occasional correction for customer reported routing issues. The presence of these additional roads and corrections can create distance discrepancies between non-Premium Web Services customers and customers using the desktop or networked editions of PC*MILER. If this is the case, we recommend setting the DataVer to the base version release (see section 1.2.1 below).



When a new North American mid-release release dataset is available, an email will be sent to all Premium and Premium-Worldwide users, identifying what was updated and how users can access the new release. It will also identify the setting for the DataVer field (see section 1.2.1 below for assistance). To make sure all applicable parties in your organization receive notification of available data updates, please email [email protected] with applicable names and email addresses.

1.2.1 Accessing the Mid-Release Routing and Map Data Update ALK Technologies is committed to continuously enhancing our user's routing experiences. Through mid-release updates, extensive routing and map data improvements are integrated into the database and made available to users. If you are a Premium and Premium-Worldwide User (see section 1.1), you have the choice of upgrading the North American routing dataset to access mid-release updates or staying with the base version release dataset instead. Depending on how you are using the interface, you may prefer to remain on the base North American version dataset. For example, if you have a contract with a customer that states a specific version of PC*MILER mileage is to be used, it would be best to access the base version dataset (e.g. V27's dataset instead of the V27.02 release). For users who are routing vehicles with PC*MILER's truck-specific directions, we recommend accessing the most recent mid-release dataset. As a Premium User, you can access both datasets; the choice is yours and you will need to determine which option best fits your business model. To access mid-release datasets for routing and map in your interface, a simple field value change is needed. The DataVer field determines whether the base version dataset or the mid-release dataset will be accessed. When ALK releases a new version, all users are automatically updated to that version, unless you set the DataVer field to a specific version of your choice.

If the DataVer field is left blank,

o for Premium and Premium-Worldwide Users, the current North American mid-release dataset will be accessed;

o for all other users, the base version dataset will be accessed.

To access the most recent North American mid-release dataset, populate the DataVer field with "current".

To access a base version dataset, populate the DataVer field with the number of the version (for example, “26” or “27”).

To access the North American mid-release dataset for the prior quarter, populate the DataVer field with “LQ” or “lastquarter”; this will also transcend versions, so when version 28 is released, LQ will return Version 27, Q4 data.



To access a specific active North American mid-release update of data, populate the DataVer field with "VVQ#" where VV represents the version of PC*MILER and # represents the quarter of data (1-4). For instance, to access the PC*MILER 27 2nd Quarter data release, the string would be "27Q2". The active quarters of data are "current" and one prior. When the third quarter update of a specific version has been released, the "base" (Q1) version of the data is also active in addition to the current and one prior, and will remain so until the next base version release.

1.2.2 How to Access the Service In PC*MILER Web Services, PC*MILER features are exposed as a standard web service interface (ASMX-SOAP and WCF-SOAP) which can be used by desktop, mobile or Web-based applications running on a variety of platforms and/or frameworks, over the Internet. Users will have access to all service options through the following URLs:

ASMX Service URL http://pcmws.alk.com/service.asmx

https://pcmws.alk.com/service.asmx

WCF-SOAP Service URL http://pcmiler.alk.com/APIs/SOAP/v1.0/service.svc

NOTE: Accessing PC*MILER Web Services through the use of HTTPS in the URL rather than HTTP indicates that an encrypted connection is desired. Using it will encrypt and provide further protection to the data you are sending to and requesting from PC*MILER Web Services. Remember that you must purchase access to the correct feature option level for the features and data that you want. Please contact a PC*MILER Account Executive to upgrade your feature option level and gain access to any additional features and data that you may need. Also note that in order to take advantage of features related to the enhanced functionality available in this version release as well as upcoming version releases, users must convert to using a WCF Service offering. No new functionality will be added to the ASMX Service, only data-related feature enhancements. NOTE: In versions previous to Version 25, Standard-Worldwide and Premium-Worldwide users were required to access a separate URL to get worldwide mileage. In PC*MILER Web Services xx.1 versions there is one URL for all users. Additional documentation can be found here (see section 1.3 below for access to the WSDL):

Updated User’s Guide http://pcmiler.com/support/pcmiler_webservices/user_manual.asp

Sample Code http://pcmiler.com/support/pcmiler_webservices/faqs.asp

WCF-SOAP Documentation http://pcmiler.alk.com/APIs/SOAP/v1.0/help/



1.3 WSDL (Web Services Definition/Description Language) The Web Services Definition/Description Language (WSDL) is an XML-based representation which provides a model to describe a web service, in this case PC*MILER Web Services. A client program connecting to a web service can read the WSDL to determine what functions are available on the server. Any special datatypes used are embedded in the WSDL file in the form of XML Schema. The client can then use SOAP to actually call one of the functions listed in the WSDL. For those of you who need to access the PC*MILER Web Services’ ASMX WSDL, it can be found by going to:

ASMX Service WSDL http://pcmws.alk.com/service.asmx?wsdl

WCF-SOAP Service WSDL http://pcmiler.alk.com/APIs/SOAP/V1.0/Service.svc?wsdl

The following sample from the web page shows WSDL definitions at the top of the page and the correct sequence for the function PMWSGetMapRoute:

<wsdl:definitions xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tm="http://microsoft.com/wsdl/mime/textMatching/" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:mime="http://schemas.xmlsoap.org/wsdl/mime/" xmlns:tns="http://localhost/PCMilerWS/" xmlns:s="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://schemas.xmlsoap.org/wsdl/soap12/" xmlns:http="http://schemas.xmlsoap.org/wsdl/http/" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" targetNamespace="http://localhost/PCMilerWS/"> <wsdl:documentation xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/"> <b>ALK PC*Miler Portal</b> </wsdl:documentation> <wsdl:types> <s:schema elementFormDefault="qualified" targetNamespace="http://localhost/PCMilerWS/"> <s:element name="PMWSGetMapRoute"> <s:complexType> <s:sequence> <s:element minOccurs="0" maxOccurs="1" name="LoginInfo" type="tns:LoginType"/> <s:element minOccurs="0" maxOccurs="1" name="TripOrigin" type="tns:LocationInputType"/> <s:element minOccurs="0" maxOccurs="1" name="TripDestination" type="tns:LocationInputType"/> <s:element minOccurs="0" maxOccurs="1" name="TripStops" type="tns:ArrayOfLocationInputType"/> <s:element minOccurs="0" maxOccurs="1" name="TripOptions" type="tns:OptionsType"/> <s:element minOccurs="0" maxOccurs="1" name="TripFuel" type="tns:FuelOptType"/> <s:element minOccurs="0" maxOccurs="1" name="TripStopsOptimize" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="TripHub" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="TripID" type="s:string"/> <s:element minOccurs="0" maxOccurs="1" name="MapOptions" type="tns:MapSettingsType"/> <s:element minOccurs="0" maxOccurs="1" name="MapCorner1" type="tns:MapPinLocationType"/> <s:element minOccurs="0" maxOccurs="1" name="MapCorner2" type="tns:MapPinLocationType"/> <s:element minOccurs="0" maxOccurs="1" name="VehiclePin" type="tns:MapPinLocationType"/> <s:element minOccurs="0" maxOccurs="1" name="VehiclePinList" type="tns:ArrayOfMapPinLocationType"/> <s:element minOccurs="0" maxOccurs="1" name="CenterPoint" type="tns:MapPinLocationType"/> <s:element minOccurs="0" maxOccurs="1" name="ZoomLevel" type="s:string"/>



<s:element minOccurs="0" maxOccurs="1" name="RouteLegDetail" type="tns:RouteLegDetail"/> <s:element minOccurs="0" maxOccurs="1" name="CircleDetail" type="tns:ArrayOfCircleDetail"/> <s:element minOccurs="0" maxOccurs="1" name="StateHighlight" type="tns:ArrayOfStateHighlightDetail"/> <s:element minOccurs="0" maxOccurs="1" name="ShapeDetail" type="tns:ArrayOfShapeDetail"/> </s:sequence> </s:complexType> </s:element>

…

1.4 Recent Enhancements and New Features

1.4.1 Version 27.0 (Current North American Data and Version Release) ENHANCED!... New Discount Toll Programs. As part of ALK’s ongoing effort to

track nationwide toll costs in the U.S. and Canada, we’ve added toll rates for four more discount toll programs to the database (listed below). See section 6.5 for more on toll costs and discounts.

A30 EXPRESS Transponder – (Quebec, Canada)

Downbeach Express Pass – (New Jersey)

NEXUS – (New York and Ontario, Canada)

TReO – (British Columbia, Canada)

ENHANCED!... Annual Updates of Defaults for US$/CAD$ Conversion Rate and Trip Costs. In Version 27.x, the default US dollar/Canadian dollar conversion rate as applied to toll rates (if PC*MILER|Tolls is installed) and default fuel/trip costs (in U.S. dollars) are as follows:

Cost/Time Parameter Version 27 Version 26

US$/Canadian$ Conversion Rate $1.00/$.995 $1.00/$1.018

Fuel Cost Per Gallon $3.9400 $4.0500

Fuel Cost Per Liter $1.0408 $1.0699

Fuel Cost Per Mile (Loaded or Empty) $.6080 $0.6750

Fuel Cost Per Kilometer (Loaded or Empty) $.3778 $0.4194

Other Cost Per Mile (Loaded or Empty) $.1900 $0.1500

Other Cost Per Kilometer (Loaded or Empty) $.1180 $0.0932

Labor Cost Per Hour (Loaded or Empty) $36.1900 $34.1200

ENHANCED!... Yearly Database Enhancements and Routing Improvements in

North America (includes U.S. ZIP Code Updates). The PC*MILER industry-standard highway network database is updated yearly to include the most current data available.



Throughout the year, ALK Technologies’ team of network editors and Geographic Information System (GIS) specialists spend countless hours gathering new data, researching current road construction and other changes, and incorporating customer feedback. This version release of ALK’s proprietary North American highway network integrates the following nationwide improvements:

Adding newly built roads along with new street/highway names to the database

Realigning the existing road network to GPS standards

Updating and adding exit interchanges and aligning ramp structures

Reclassing roads where necessary (e.g. changing a road from secondary to primary, confirming one-way designations)

Updating street-level address changes

Improving ZIP/Postal Code placement and alignment

Additional updates specifically for commercial vehicles include but are not limited to: o Defining urban-classed roads to keep commercial vehicles out of city centers and

on higher-classed beltway roads o Verifying and coding truck-designated routing attributes throughout the network

with a special focus on metropolitan areas (e.g. keeping drivers on roads designated by local and state authorities as preferred/ designated for truck travel)

o Reclassing vertical clearance data to accurately model low viaducts o Defining specific routing designations for truck-through travel within city limits o Verifying truck restrictions and allowances (classifications include truck

designated roads, truck discouraged roads, height/weight restrictions and allowances, commercial prohibited road classifications, hazardous materials restrictions/allowances, and others)

1.4.2 Version 27.1 (Current Worldwide Data and Version Release) Since Version 24.1, PC*MILER Web Services has incorporated PC*MILER|Worldwide into its functionality. PC*MILER|Worldwide generates point-to-point truck-specific mileage, driving directions and maps over the entire international highway network. Data coverage includes the following regions: North America, South America, Europe, Africa, Asia and Oceania (see Appendix D for details). The PC*MILER|Worldwide includes the following major features:

Region-to-region routing capabilities ISO and GENC country abbreviation options Border crossing wait time options Language translation for reports Speed limits by state/province/country Custom average road speed estimates Access to worldwide Postal Codes State/country distance summaries including ferry miles Route stop optimization Customize routes by avoiding/favoring roads



Generate detailed driving directions Custom cost/time estimates for empty/loaded miles

New features in Version 27.1 include:

NEW!...GENC2 and GENC3 Country Codes. (PC*MILER|Worldwide only) New GENC2 and GENC3 country codes are now available for stop entry as an option in the Application Settings dialog box. See section 3.16, and Appendix C.

Additionally, the PC*MILER|Worldwide 27.1 release integrates the following routing improvements: increased coverage of road networks, cities, postal codes, and truck attributes for over 60 countries including South Korea, Brazil and Argentina, as well as several countries in the Middle East, Southeast Asia and Europe.

1.5 Technical Support ALK Technologies offers free unlimited technical support to all licensed users of PC*MILER Web Services for the term of your subscription to the service. For questions that cannot be resolved using this user’s guide, you can contact our staff via the following contact options: Phone: 1.800. 377.6453, ext. 2 or 609.683.0220, ext. 2 (outside the U.S.) Fax: 609.252.8108 Email: [email protected] Web Site: www.pcmiler.com Hours: 9:00am – 5:00pm EST, Mon-Fri When emailing, please put “PCM Web Services” in the subject line. In the email, please include which Web browser you are using and the version of the browser.

1.6 Database Support ALK Technologies' North American and Worldwide Highway Networks, the primary databases used by PC*MILER products, undergo constant revision. Revisions include the addition of new roads, upgrades of improved sections of highway, and addition of new Key Cities. ALK Technologies is dedicated to maintaining a highway network of the highest quality and welcomes user input and comments. If you encounter any problems related to mileage, routing or highway names, you may contact our staff at:

ALK TECHNOLOGIES, INC. PC*MILER Products Division 457 North Harrison Street Princeton, NJ 08540 USA Fax: (609) 252-8108 Email: [email protected]



1.7 PC*MILER Sales Contact Options Phone: 1.800.377.6453, ext. 1 609.683.0220, ext. 1 (outside the U.S.) Fax: 609.252.8108 Email: [email protected] Web Site: www.pcmiler.com Address: ALK Technologies 457 North Harrison Street Princeton, NJ 08540 USA

| 18


This chapter describes the structure definitions used in the API requests. For each structure description there will be a brief overview of the structure’s use, as well as each element, and an XML abstract.

Input Structure Exposed Per Feature Option Access to the input structures described in this chapter is determined by your Feature Option Level. For more details, refer to section 1.1, PC*MILER Web Services Feature Option Levels.

INPUT STRUCTURE

Lite Standard Premium Enterprise Standard-Worldwide

Premium-Worldwide

LoginType LocationInputType StopCostsType RouteCostsType TimeCostsType TruckConfigType OptionsType TimeOptions DateAndTimeOptions FuelOptType AvoidFavorType RoadSpeedType MapPinLocationType MapSettingsType MapLegendOptions* ShapeDetail TrafficFlowDrawer GeoLocType PointSearchType CompLineType * Traffic legend not available in locally installed Enterprise version.

Chapter 2: Input Structure Definitions

Chapter 2: Input Structure Definitions | 19


2.1 LoginType The LoginType structure is necessary for security within the PC*MILER Web Services server. This structure should only be necessary for transactions against the internal ALK server.

Elements

Element Definition Acceptable Value(s) Required UserID A string to identify the user UserID

(your PCM ID) Y

Password Password associated with the user as defined within the Web Services server

Password (your PCM Password)

Y

Account A string identifying the account this user is associated with

AccountName (your PCM Account)

Y

DataVer The data version of PC*MILER, acceptable entries are current, lastquarter, and any supported (through this interface) version number or version number/ quarter combination.

Current, lastquarter, and any supported (through this interface) version number or version number/quarter combination, e.g. 26Q3

N

Abstract

<xsd:complexType name=”LoginType”> <xsd:sequence> <xsd:element name=”UserID” type=”xsd:string” /> <xsd:element name="Password" type="xsd:string" /> <xsd:element name=”Account” type=”xsd:string” /> <xsd:element name=”DataVer” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

2.2 LocationInputType The LocationInputType structure will be used to pass all data associated with a geographic point. It may be either address or lat/long information. This structure is associated with the following APIs:

PMWSGetMapRoute PMWGetMapRoutes PMWSGetETAOutOfRoute PMWSGetMap PMWSGetMapBreadcrumbTrail PMWSSetMapCustomPlace PMWSGetReport



PMWSGeoCode PMWSRadiusSearch PMWSReduceTrip

Elements

Element Definition Acceptable Value(s)

Required

Region Must have worldwide to use this feature. North America (NA) is the default.

AF (Africa), AS (Asia), EU (Europe), NA (North America), OC (Oceania), SA (South America).

Conditional (Y-If using a premium worldwide route, not using NA N-If routing through NA)

Address1 Street information Valid Street address, e.g. 1000 Herrontown Rd.

N

Address2 Additional street information Valid Street address, e.g. 1000 Herrontown Rd.

N

City City name Valid City, e.g. Princeton

Conditional (N-If using Zip, Place name, Lat/ Long, or SPLC Y- When specifying the state without a Zip)

State Two-character abbreviation; see Appendix C & D for applicable entries. For worldwide (not NA), the state is the country abbrev. Ex: IT(aly)

PA,NJ, etc. See Appendix C & D

Conditional (N-If using Zip, Place name, Lat/Long, or SPLC Y-When specifying the city without the ZIP)

Zip Five-digit US ZIP Code, six-character Canadian Postal Code, or

19020, etc Conditional (N-If using



Worldwide Postal Code City/State, Place name, Lat/Long, or SPLC Y- If NOT using City/State, Place name, Lat/Long, or SPLC)

SPLC Standard Point Location Code 6- 9 characters (US only)

Valid 6-9 digit characters maintained by National Motor Freight Assoc. Ex: 142000000 (This is for Boston, MA)

N

Juris Jurisdiction; in the US this would be county. Used in conjunction with City/State.

Ex: Suffolk, Middlesex (This is for Boston, MA)

N

PlaceName Corresponds to a custom place; this would supersede standard address entries for geocoding, or identify a custom place to be associated with the address. This is associated with GetMapCustomPlace – the name you have given after running this API.

Ex: ALK N

Lat A latitude; if entered with a longitude, these entries supersede all others. (See section 6.2.6 on entering latitude/longitude points.)

Ex: <Lat>40.116024</Lat>

Conditional (N -If using City/State, Zip, Place name, or SPLC Y-If specifying a Long to Geocode)

Long A longitude; if entered with a latitude, these entries supersede all others. (See section 6.2.6 on entering latitude/longitude points.)

Ex: <Long>-74.917683</Long>

Conditional (N -If using City/State, Zip, Place name, or SPLC Y-If specifying



a Lat to Geocode)

StopLabel A string which represents a label to be displayed on maps and in reports in association with a stop

Ex: “Stop 1”

N

SCost The cost associated with this stop; it is a StopCostType structure.

See section 2.3 below. No input values

N

Country Country abbreviation – NOTE: In North America, NX should be used as the State abbreviation for Nuevo Leon in Mexico (EM) and NL for Newfoundland and Labrador in Canada. If NL is passed as the state and EM as the country, geocoding will fail and the following warning will display: “GeoWarning: Check Country Setting” warning will display – GeoWarning: “Check Country Setting.”

Ex: US, CA, etc. See Appendix D for listing

N

CountryPostalCode Defines match criteria for U.S. ZIP Codes and Mexican Postal Codes; US returns default U.S. ZIP code, Mx returns default Mexican Postal Code, or USandMx to return the default U.S. ZIP or Mexican code.

US, EM, Both

N

Abstract

<xsd:complexType name=”LocationInputType”> <xsd:sequence> <xsd:element name=”Address1” type=”xsd:string” /> <xsd:element name="Address2" type="xsd:string" /> <xsd:element name=”City” type=”xsd:string” /> <xsd:element name=”State” type=”xsd:string” /> <xsd:element name=”Zip” type=”xsd:string” /> <xsd:element name=”Region” type=”xsd:string” /> <xsd:element name=”SPLC” type=”xsd:string” /> <xsd:element name="Juris" type="xsd:string" /> <xsd:element name="PlaceName" type="xsd"string" /> <xsd:element name=”Lat” type=”xsd:string” /> <xsd:element name=”Long” type=”xsd:string” /> <xsd:element name=”StopLabel” type=”xsd:string” /> <xsd:element name="SCost" type="StopCostsType" />

<xsd:element name="Country" type="xsd:string" /> <xsd:element name="CountryPostalCode" type="xsd:string" /> <xsd:element name="AbbreviationFormat" type="xsd:string" />

</xsd:sequence> </xsd:complexType>



2.3 StopCostsType The StopCostsType structure will be used to pass all data associated with any additional costs incurred by stopping at a specific location. See sections 6.1.12 and 6.1.13 for more information, including default values. This structure is referenced as part of the LocationInputType structure and is valid for PMWSGetReport (Trip Distance Report, State/Country Distance Report, Detailed Driving Directions, and Condensed Driving Directions). Elements

Element Definition Acceptable Value(s) Required CostOfStop The cost of the stop A valid decimal value

Ex: 10.5 N

HoursPerStop The length of time allocated for this stop; format is in decimal hours.

A valid decimal value Ex: 1.5

N

Loaded Is the truck is loaded? Y (yes) or N (no) N OnDuty Is the truck is on duty Y (yes) or N (no) N UseOrigin Defaults the settings to

those associated with the trip origin

Y (yes) or N (no) N

Abstract

<xsd:complexType name=”StopCostsType”> <xsd:sequence> <xsd:element name=”CostOfStop” type=”xsd:string” /> <xsd:element name="HoursPerStop" type="xsd:string" /> <xsd:element name=”Loaded” type=”xsd:string” /> <xsd:element name=”OnDuty” type=”xsd:string” /> <xsd:element name=”UseOrigin” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>



2.4 RouteCostsType The RouteCostsType structure will be used to pass all data associated with “cost per mile”. See sections 6.1.12 - 6.1.14 for more information, including default values. This structure is referenced as part of the OptionsType structure and is valid for PMWSGetReport (Trip Distance Report, State/Country Distance Report, Detailed Driving Directions, and Condensed Driving Directions). Elements

Element Definition Acceptable Value(s) Required LoadedPerMile Loaded cost per mile Valid decimal Value

Ex: 3.5 N

UnlPerMile Unloaded cost per mile Valid decimal Value Ex: 3.5

N

MPGLoaded Loaded MPG Valid decimal Value Ex: 3.5

N

MPGEmpty Empty MPG Valid decimal Value Ex: 3.5

N

PricePerGallon Fuel cost per gallon Valid decimal Value Ex: 3.5

N

TruckStyle Includes vehicle dimensions and route costs

28 (28' double trailers), 40 (40' straight truck), 48 (48' semitrailer), 53 (53' semitrailer)

N

GreenHouseGas Greenhouse gases in lbs. per gallon.

Valid decimal Value Ex: 3.5

N

OtherCostPerMileLoaded

Other cost per mile loaded Valid decimal Value Ex: 3.5

N

OtherCostPerMileEmpty

Other cost per mile empty Valid decimal Value Ex: 3.5

N

CostTimeLoaded Estimated labor or other cost per hour loaded


N

CostTimeEmpty Estimated labor or other cost per hour empty


N

Abstract

<xsd:complexType name=”RouteCostsType”> <xsd:sequence> <xsd:element name=”LoadedPerMile” type=”xsd:string” /> <xsd:element name="UnlPerMile" type="xsd:string" />

<xsd:element name=”MPGLoaded” type=”xsd:string” /> <xsd:element name="MPGEmpty" type="xsd:string" /> <xsd:element name=”PricePerGallon” type=”xsd:string” /> <xsd:element name="TruckStyle" type="xsd:string" />



<xsd:element name=”GreenHouseGas” type=”xsd:string” /> <xsd:element name="OtherCostPerMileLoaded" type="xsd:string"/> <xsd:element name=”OtherCostPerMileEmpty” type=”xsd:string” /> <xsd:element name=”CostTimeLoaded” type=”xsd:string” />

<xsd:element name="CostTimeEmpty" type="xsd:string" /> </xsd:sequence> </xsd:complexType>

2.5 TimeCostsType The TimeCostsType structure will be used to pass all data associated with additional delays associated with the trip. Default values for break and border wait times are 0. This structure is referenced as part of the OptionsType structure and is valid for PMWSGetReport (Trip Distance Report, State/Country Distance Report, Detailed Driving Directions, and Condensed Driving Directions). Elements

Element Definition Acceptable Value(s) Required DepartTime The time the trip begins; the

format is HH:MM A[P]M; this field is conditional, and valid if the RoutingType is E (optimized ETA).

HH:MM A[P]M Ex: 09:30 AM

N

BreakInterval The elapsed time of the trip before a break will be taken; the format is in decimal hours.

Valid Decimal Value

N

BreakLength The amount of time a break will last; the format is in decimal hours.

Valid Decimal Value

N

BorderWait Adds the amount of time at the border to the overall trip.

Valid Decimal Value

N

Abstract

<xsd:complexType name=”TimeCostsType”> <xsd:sequence> <xsd:element name=”DepartTime” type=”xsd:string” /> <xsd:element name="BreakInterval" type="xsd:string" /> <xsd:element name=”BreakLength” type=”xsd:string” /> <xsd:element name=”BorderWait” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>



2.6 TruckConfigType The TruckConfigType structure will be used to pass all data associated with the truck configuration (vehicle dimension, weight and number of axles) for routing and tolls. See section 6.5.2 for information related to vehicle dimensions, weight, and number of axles. This structure is referenced as part of the OptionsType structure and is valid for all of that structure’s associated APIs. Elements

Element Definition Acceptable Value(s) Required Units The units of measure to be

used; Default = E (English) for North America, M (Metric) for all other regions.

E (English) or M (Meters) N

Height The height of the truck in feet and inches, or meters depending upon units; maximum is 13' 6'' or 4.1148 meters. Default = 13' 6'' in all regions except Europe, which is 12' 6''.

feet'inches” Ex: 13'6"

N

Length The length of the truck in feet or meters, depending upon units; maximum is 53 feet or 16.1544 meters. Default = 48 feet in all regions except Europe, which is 54' 1''.

feet'inches” Ex: 13'6"

N

Width The width of the truck in inches or meters depending upon units; functionally this will be dealt with as 8” and below and 8’5” and above. Default = 8’5” for all regions.

8” or 8’5” N

Weight The weight of the truck in pounds or kilos depending upon units; weights up to 132,000 pounds or 59,874 kilos are acceptable. Default = 80,000 lbs. all regions.

Valid Integer Ex: 100000

N

Axles The number of axles on the truck Default = 5.

2,3,4,5,6,7,8,9,10,11,12,13,14 N



LCV (in North America) True indicates a multi-trailer or longer combination vehicle for calculation of toll costs.

true, false N

Abstract

<xsd:complexType name=”TruckConfigType”> <xsd:sequence> <xsd:element name=”Units” type=”xsd:string” /> <xsd:element name="Height" type="xsd:string" /> <xsd:element name=”Length” type=”xsd:string” /> <xsd:element name=”Width” type=”xsd:string” /> <xsd:element name=”Weight” type=”xsd:string” /> <xsd:element name=”Axles” type=”xsd:string” /> <xsd:element name=”LCV” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

2.7 OptionsType The OptionsType structure will be used to pass all data specific to the kind of route which is to be run. NOTE: For a description of PC*MILER route options, see Chapter 6. This structure is associated with the following APIs:

PMWSGetMapRoute PMWGetMapRoutes PMWSGetETAOutOfRoute PMWSGetMap PMWSGetMapBreadcrumbTrail PMWSGetReport

Elements

Element Definition Acceptable Value(s) Required DataVer The data version; acceptable

entries are Current, and any supported (through this interface) version number.

Current, any supported (through this interface) version number Ex: 25Q3

N

Lang The language in which the information is to be displayed; default is English.

U (English), P(Portugese) F(French) S(Spanish)

N

VehicleType Type of vehicle used for routing, with Truck as the

T (truck) L (light truck)

N



default type. A (auto) RoutingType The type of route used from

origin to destination; Practical is the default type.

P (practical) S (shortest) E (Optimized ETA)

N

HighwayOnly Route will involve highways or street level routing from origin to destination. The default is Highway-only routing (Y).

Y (yes – highway routing) N (no – street routing)

N

FuelRoute Use an optimized fuel route; a fuel Login must be used in conjunction when “Y”.

Y (yes – a fuel optimized route) N (no – normal routing)

N

CustRoad Routing via custom roads are to be used/avoided. Normal routing is the default.

Y (yes – use the avoids/favors associated with this account) N (no – normal routing)

N

ClassOverrides When the “53' Routing Option”, or when a width of greater than 96'' or length greater than 48' is entered as the vehicle size, the routing algorithm favors roads designated by the states for trucks over 96'' wide or over 48' long, or twin trailers.

5 (53 foot) N (National Network)

N

Units The unit of measure to calculate route, Miles is the default unit.

M (miles) K (kilometers)

N

FuelUnits Measure of fuel, the default is gallons.

G ( gallons) L (liters)

N

TollDiscourage Route around tolls if possible. Default is not to discourage tolls (N).

Y (yes - toll avoid) N (no – don’t avoid tolls)

N

TollData Provide information about the tolls including the toll plaza name and price. This is a conditional field depending upon whether the user has tolls privileges; if the user has tolls privileges the default is to provide tolls (Y), else do not include them (N).

Y (yes) N (no)

N

BordersOpen If BordersOpen is set to “yes” (this is the default), the generated route will ignore international boundaries when

Y (borders open) N (borders closed)

N



necessary to create the best route. If this option is set to have borders closed, the borders will never be crossed. Default is borders open (Y).

OverrideRestrict When OverrideRestrict is “N”, both truck-prohibited and truck-discouraged roads will always be avoided. When “Y”, truck restrictions are relaxed for particular sizes and weights. See section 6.1.6. The default is “N”.

Y (override trucking restrictions) N (keep restrictions in place)

N

HazMatType If Hazardous Materials Routing is available in your login level, you can run routes for various types of hazardous materials using any PC*MILER route type. The default is “N” (none).

N (none) G (general) C (corrosive) E (explosives) F (flammable) I (inhalants) R (radioactive)

N

TripCosts A RouteCostsType structure; this is an optional field.

See section 2.4 No input values

N

TimeCost A TimeCostsType structure; this is an optional field, though the “Depart Time” is only valid if the RoutingType is E (optimized ETA)

See Section 2.5 No input values

N

TruckCfg A TruckConfigType structure; this is an optional field.

See Section 2.6 No input values

N

InclFerryDist Include mileage travelled on ferries. The default is Yes.

Y (yes, include miles traveled on ferries in the mileage calculation) N (no, do not include)

N

TollCurrency Display toll data in US or Canadian Currency. The default is US dollars.

U (for US dollars or) C ( for Canadian dollars)

N

ExchangeRate To pass in the exchange rate for converting US dollars to Canadian dollars

Valid decimal value Ex: 1.5

N

TimeOptions To be used in calculating the ETA/ETD of a trip

See section 2.8 & 2.9 No input values

N

UseTrafficData To determine whether to use Traffic Data or not when calculating transit time

true or false N



HubRouting Hub routing feature allows you to generate routes and mileages from one origin to unlimited destinations. The default is hub routing disabled (N).

Y (enable hub routing) N (disable hub routing)

N

ZipArea Controls Zip Code geocoding. Choose between matching to either the U.S. or Mexico or both countries.

u (USA only) m (Mexico only) b (USA and Mexico)

N

Abstract

<xsd:complexType name="OptionsType"> <xsd:sequence> <xsd:element name="DataVer" type="xsd:string" /> <xsd:element name=”Lang” type=”xsd:string” /> <xsd:element name="VehicleType" type="xsd:string" /> <xsd:element name="RoutingType" type="xsd:string" /> <xsd:element name=”HighwayOnly” type=”xsd:string” />

<xsd:element name=”FuelRoute” type=”xsd:string” /> <xsd:element name=”CustRoad” type=”xsd:string” /> <xsd:element name="ClassOverrides" type="xsd:string" /> <xsd:element name="Units" type="xsd:string" />

<xsd:element name="FuelUnits" type="xsd:string" /> <xsd:element name="TollDiscourage" type="xsd:string" /> <xsd:element name=”TollData” type=”xsd:string” /> <xsd:element name="BordersOpen" type=xsd:string /> <xsd:element name="OverrideRestrict" type=xsd:string /> <xsd:element name="HazMatType" type="xsd:string"/> <xsd:element name=”TripCosts” type=”RouteCostsType” /> <xsd:element name=”TripTime” type=”TimeCostsType” /> <xsd:element name=”TruckCfg” type=”TruckConfigType” /> <xsd:element name="TollCurrency" type="xsd:string"/> <xsd:element name=”ExchangeRate” type=” xsd:string” /> <xsd:element name=”TimeOptions” type=”TimeOptions” /> <xsd:element name=”UseTrafficData” type=”xsd:string” /> <xsd:element name=”InclFerryDist” type=”xsd:string” /> <xsd:element name="HubRouting" type="s:string"/> <xsd:element name="ZipArea" type="s:string"/> </xsd:sequence> </xsd:complexType>



2.8 EstimatedTimeOptions The EstimatedTimeOptions structure will be used to pass in all the values associated with time-based functionality. Elements


Required

DateAndTimeOptions This is an optional element. This will be a DateAndTime structure used to specify the start or the end date/time of the trip.

See 2.9 No input values

N

Stop This is a conditional element representing the stop that DateAndTimeOptions is associated with. This value is only valid when DateAndTimeOptions is set.

o (origin) d (destination)

N

Abstract

<xsd:complexType name=”EstimatedTimeOptions”> <xsd:sequence> <xsd:element name=”DateAndTimeOptions” type=”DateAndTime” /> <xsd:element name="Stop" type="xsd:string" /> </xsd:sequence> </xsd:complexType>

2.9 DateTimeOptions The DateTimeOptions structure will be used for time-based functionality. This structure will allow the user to specify the values for the date/time entry as well as time zone adjustment. The user may also set the option for the entry and display of dates and times and specify how these options apply to a specific departure time or specific arrival time. Elements

Element Definition Acceptable Value(s) Required ETAETD The ability to define a departure or

arrival time for more precise calculation of ETA/ETD at each stop on a route, taking time zones into consideration

d (departure) a (arrival)

N

DateOption Calculate more realistic transit times and opt to factor in real-time or historical traffic* trends per route NOTE: With Current, historical data

C (Current) D (DayOfWeek) S (Specific)

N



is NOT used in ETA/ETD calculations for the first 15 miles on a route. To use historical data for the entire route, use Specific. *Applicable licenses required

DateTime Year Month Day DayOfWeek Time Hour Minute amPm

Calculate more realistic transit times by defining a departure or arrival date and time and opt to factor in real-time or historical traffic*. Is a composite type with the following elements: Year –numeric value for the

year

Month – numeric value for the month. Acceptable entries are in the range.

Day – day of the month. For instance, for December 2, 2012, day should be 2.

DayOfWeek – valid values are

Time – is a composite type in

itself with the following entries: o Hour – numeric value for

hour o Minute – numeric value for

minute o AmPm – time frame. The

default is military. *Applicable licenses required

4-digit year Ex: 2012 1-12 1-31 "su", "sunday", "mo", "monday", "tu", "tuesday", "we", "wednesday", "th", "thursday", "fr", "friday", "sa", "saturday" 0 – 23 0 – 59 A (for AM) P (for PM) M (for military time)

N

TimeZone Calculate routing time according to specified time zone.

Local System Hawaii Alaska Pacific Arizona Mountain Central Eastern Atlantic Newfoundland

N



Abstract

<xsd:complexType name=”DateTimeOptions”> <xsd:sequence> <xsd:element name=”ETAETD” type=”xsd:string” /> <xsd:element name="DateOption" type="xsd:string" /> <xsd:element name="DateTime" type="tns:DateTimeType"/> <xsd:element name="TimeZone" type="s:string"/> </xsd:sequence> </xsd:complexType> Sample XML:

<DateAndTimeOptions> <ETAETD /> - Acceptable entries are 'a' (arrival) and 'd' (departure) <DateOption /> - Acceptable entries are 'current'/'specific'/'dayofweek' <DateTime> <Year></Year> <Month></Month> <Day></Day> <DayofWeek></DayofWeek> <Time> <Hour></Hour> <Minute></Minute> <AmPm></AmPm> </Time> </DateTime> <TimeZone> </TimeZone> </DateAndTimeOptions>

2.10 FuelOptType The FuelOptType structure will be used to pass all data specific to the Fuel Optimization functionality. Because it is necessary to log into an external service, additional login information will be required.

This structure is associated with the following APIs: PMWSGetMapRoute PMWSGetReport

Elements

Element Definition Acceptable Value(s) Required FuelLogin A LoginType structure

containing the UserID and Password associated with the FuelAdvice account

String containing userID Ex: myuserid Password

Y-If FuelRoute parmeter = Y



Account (the business partner ID)

FuelCap The total capacity, in gallons, of the fuel tank on the truck; this is a conditional field.

Valid Decimal Value Ex: 20.5


Level The number of gallons currently in the fuel tank



MPG The miles per gallon of the truck



Abstract

<xsd:complexType name=”FuelOptType”> <xsd:sequence> <xsd:element name=”FuelLogin” type=”xsd:LoginType” /> <xsd:element name=”FuelCap” type=”xsd:string” /> <xsd:element name=”Level” type=”xsd:string” /> <xsd:element name=”MPG” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

2.11 AvoidFavorType The AvoidFavorType structure will be used to pass all data specific to both road and state preferences when doing routing. This structure is used as part of the PMWSSetAvoidFavor API. NOTE on FAVORED ROADS: Because PC*MILER Practical and Shortest routes default to specific roads over long distances, it may be necessary to insert an intermediate stop on a road designated as favored so that PC*MILER will use the favored road. Elements

Element Definition Acceptable Value(s) Required State The state abbreviation where

the avoid/favor exists Valid 2-digit string Ex: PA

Y

Road The road within the state to be avoided or favored; and if it is not included the entire state is either avoided or favored

Valid Road Name string Ex: US-1

N

Action Action to take

A (avoid) F (favor) D (delete)

Y

Label The group name associated with this avoid or favor; this field is optional.

Any string Ex: “Don’t go”

N



Abstract

<xsd:complexType name=”AvoidFavorType”> <xsd:sequence> <xsd:element name=”State” type=”xsd:string” /> <xsd:element name="Road" type="xsd:string" /> <xsd:element name=”Action” type=”xsd:string” /> <xsd:element name=”Label” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

2.12 RoadSpeedType The RoadSpeedType structure will be used to pass all data specific to both road type and state associations for speeds. This will override the default settings for the speed on certain road types (see Appendix G for a list of PC*MILER default road speeds). This structure is used as part of the PMWSSetRoadSpeed API. Elements

Element Definition Acceptable Value(s) Required State The state where the road speed

is to be changed; see Appendix G for default road speeds.

Valid 2 digit state abbrev Ex: PA

Y

RoadType The type of road within that state for which this speed is to apply

InterstateU, InterstateR, DividedU, DividedR, PrimaryU, PrimaryR, SecondaryU, SecondaryR, LocalU, LocalR, FerriesU, FerriesR (The U and R suffix represent Urban and Rural)

Y

Speed A numeric field representing, in miles per hour, the speed on that road type

Any valid Integer Ex: 55

Y



Abstract

<xsd:complexType name=”RoadSpeedType”> <xsd:sequence> <xsd:element name=”State” type=”xsd:string” /> <xsd:element name="RoadType" type="xsd:string" /> <xsd:element name=”Speed” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

2.13 MapPinLocationType The MapPinLocation structure will be used to pass all data specific to the location of a point on a map. This structure is associated with the following APIs:

PMWSGetMapRoute PMWSGetMap

Elements

Element Definition Acceptable Value(s) Required ID The pin ID Valid Numeric Integer

Ex: 100 N

PinLat A latitude on a map (in millionths of degrees – see section 6.2.6 on entering latitude/longitude points)

Valid Integer to be GeoCoded Ex: <PinLat>39963828</PinLat>

Y

PinLong A longitude on a map (in millionths of degrees – see section 6.2.6 on entering latitude/longitude points)

Valid Integer to be GeoCoded Ex: <PinLong>-75146538</PinLong>

Y

PinX The X coordinate on a map Valid Integer Ex: 914

N

PinY The Y coordinate on a map Valid Integer Ex: 497

N

Bitmap A bitmap to be displayed at those coordinates

See section 6.7.2 for list Ex: truck_g (green truck)

N

Category A pin category name Any String Ex: “Category 1”

N

Abstract

<xsd:complexType name=”MapPinLocationType”> <xsd:sequence> <xsd:element name="ID" type="xsd:unsignedInt"/> <xsd:element name=”PinLat” type=”xsd:string” /> <xsd:element name="PinLong" type="xsd:string" />



<xsd:element name=”PinX” type=”xsd:string” /> <xsd:element name=”PinY” type=”xsd:string” /> <xsd:element name=”Bitmap” type=”xsd:string” /> <xsd:element name="Category" type="xsd:string"/> </xsd:sequence> </xsd:complexType>

2.14 MapSettingsType The MapSettingsType structure will be used to pass all data specific to the visual representation of geographic information. This structure is associated with the following APIs:

PMWSGetMapRoute PMWSGetMapRoutes PMWSGetMap PMWSGetMapBreadcrumbTrail PMWSSetMapCustomPlace PMWSGetExtentForRoutes

Elements

Element Definition Acceptable Value(s) RequiredZoomTo Where you would like the

zoom level of the route to be focused on. The default is the entire route.

O (origin), D (destination), R (the entire route), B (bitmap), or a zero-based numeral which corresponds to a stop number, e.g. the first stop would be “0”;

N

ZoomRad This is a numeric entry representing the radius of the circle which defines the map to be displayed, the center of which was defined by a pin; this radius is in the units previously defined with miles as default.

Any Valid Decimal Ex: 2.5

N

Region The region the map is displaying

NA (all of North America), US (United States) Mexico, Canada, Puerto Rico, Bermuda

N

DetailLevel Corresponds to the level of 1,2,3,4,5,6,7 N



detail to be shown on the map; with 7 representing the most detail; default is 4.

MapWidth This is a numeric entry representing the number of pixels which will define the X axis of the map; 640 is the default.


N

MapHeight This is a numeric entry representing the number of pixels which will define the Y axis of the map; 480 is the default.


N

MapMult This is a numeric entry representing the multiplier for the image to be returned.

Any Valid Decimal Ex: 1.5

N

OversizeMap this is a bool entry representing whether the width and length of the map will be adjusted to match the MapMult; this in an optional field. Setting OversizeMap to true is useful for panning the map without the need to go back to the server for another image. Setting OversizeMap to false is useful for zooming in or out.

true false

N

Drawer This entry will define the drawer to be used in the drawing of the map layer; default is “All”; a list of drawers will be comma delimited.

All, Rt# (route, where # represents the numbers 1 through 8), City, StpNm (stop name), RdNm (road name), RdSh (road shields), TimeZone (this is off by default), AvdFvr (avoids/favors), Place, Road, HazMat, TrkRst (truck restrictions), TrkDesg (truck designated), AP (airports), Point (points of interest icons),



Bnd (boundries), Park, RR (rail roads), Isl (islands), Mlt (military bases), StateHighlight, Shape, TrafficFlow, Countybounadaries, StateBoundaries, Water, Urban

MapLegend Corresponds to whether the legends will be displayed on the map; the default is On.

On or Off N

MapLegendDrawer This is a comma delimited string with a list of legends to be drawn; this parameter supersedes the MapLegend element .

Route, Road, Miles, Hazmat

N

StopLabelDrawer This is a string containing the stop label drawing options; the default is Both.

Name, Number, None, Both

N

TrafficFlowDrawer A road speed drawer structure used to display historical, typical or real-time traffic patterns

See section 2.15 No input value

N

MapLegendOptions An array of MapLegendOptions type that defines how map legends should be drawn; specifically, if they should be drawn on the map or in a separate buffer; this parameter overrides the MapLegend and LegendDrawer elements.

See section 2.16 No input value

N

SeparateLayering This is a string entry representing whether to draw points in a separate layer on a map.

MapAndPointsOneLayer MapLayer PointsLayer MapAndPointsTwoLayers

N

Abstract

<xsd:complexType name="MapSettingsType"> <xsd:sequence> <xsd:element name="ZoomTo" type="xsd"string" />



<xsd:element name="ZoomRad" type="xsd"string" /> <xsd:element name="Region" type=xsd:string" /> <xsd:element name="DetailLevel" type=xsd:string /> <xsd:element name="MapWidth" type="xsd:string" /> <xsd:element name="MapHeight" type="xsd:string" /> <xsd:element name="MapMult" type="xsd:string" /> <xsd:element name=”OversizeMap” type=”bool” /> <xsd:element name="Drawer" type=xsd:string" /> <xsd:element name=”MapLegend” type=xsd:string” />

<xsd:element name=”MapLegendDrawer” type=xsd:string” /> <xsd:element name=”StopLabelDrawer” type=”xsd:string” /> <xsd:element name="SeparateLayering" type=xsd:string" /> <xsd:element name=”TrafficFlowDrawer” type=TrafficFlowDrawer” />

<xsd:element name=”MapLegendOptions” type=MapLegendOptions” /> </xsd:sequence> </xsd:complexType>

2.15 TrafficFlowDrawer The TrafficFlowDrawer structure will be used to control the road speed overlay on a map. By default, the road speed layer will be on top. If the z order needs to be changes, then this must be done by manipulating the drawer element in the MapSettingsType structure.

Elements


Required

TrafficFlowType Displays the road speed overlay on a map.

RoadSpeed, Congestion, Neither

N

TrafficFlowTime Historic and Actual are valid for Congestion; all three are valid for Speed.

Historic, Actual, Default

N

DayOfWeek This is a conditional element. Su (Sunday), Mo (Monday), Tu (Tuesday), We(Wednesday), Th (Thursday), Fr (Friday), Sa (Saturday)

N

TimeOfDay Use the following entries: o Hour – numeric value for hour o Minute – numeric value for

minute o AmPm – acceptable entries are

A for AM, P for PM, or M for military time format. The default is AM.

0 – 23 0 – 59 A (for AM) P (for PM) M (for military time)

N (If one of these has a parameter, all must)



Abstract

<xsd:complexType name=”TrafficFlowDrawer”> <xsd:sequence> <xsd:element name="TrafficFlowType" type="xsd:TrafficFlowCategory"/> <xsd:element name="TrafficFlowTime" type="xsd:TrafficFlowTime"/> <xsd:element name=”DayOfWeek” type=”xsd:string” /> <xsd:element name=”TimeOfDay” type=”xsd:TimeOfDay” /> </xsd:sequence> </xsd:complexType>

2.16 MapLegendOptions The MapLegendOptions structure will be used to define how and where map legends will be drawn on the PC*MILER Web Services map. The object encapsulates the drawing details of the various map legends that are drawn by Web Services.

Elements


Required

LegendName An enumeration that represents the type of map legend: ScaleOfMiles = Scale of Miles Legend RouteLegend = Route Legend RouteLegend = Road Legend HazMatLegend = HazMat Legend TrafficLegend = Traffic Legend

ScaleOfMiles, RouteLegend, RoadLegend, HazMatLegend, TrafficLegend

N

DrawOnMap Boolean value that defines if the legend should be drawn on the map or on a separate buffer.

true ( Draw on the map), false (Draw on a separate buffer)

N

Abstract

<xsd:complexType name=”MapLegendOptions”> <xsd:sequence>

<xsd:element name=”LegendName” type=”Enums.MapLegend” /> <xsd:element name="DrawOnMap" type="Boolean" />




2.17 ShapeDetail The ShapeDetail structure defines how a shape is defined on the map returned by PC*MILER Web Services. This object encapsulates various shapes and polygons that are drawn by Web Services.

Elements


Required

ShapeType Indicate a shape to display on the map from a specified list of latitude/longitude values.

LINE, CIRCLE, RECT, ELLIPSE, POLYGON

N

PenColor The RGB values that define the line color of the border: Red numeric value, Green numeric value, Blue numeric value

Any valid Integer from 0 - 255 Ex : <Red>200</Red> <Green>155</Green> <Blue>100</Blue>

N

LineWidth String that defines the width of the border around the edge of the shape

Any valid integer Ex: 2

N

Fill To indicate if a fill should be applied to the polygon

true or false N

RadiusHorizontal The horizontal radius of the shape; this only applies to the Circle and Ellipse polygons. In the case of the circle, this is the radius of the circle.


N

RadiusVertical The vertical radius of the shape. This only applies to the ellipse polygon. For the Circle polygon, this is ignored.


N

Center Defines the center point of a circle or an ellipse.

See section 2.13 N

LatitudeLongitude An array of Any valid point thay can be Y – if a



LatitudeLongitude objects that describe the various points of the shape/polygon.

GeoCoded Ex: <Latitude>39946715</Latitude> <Longitude>-5028122</Longitude>

shape is specified

Abstract

<xsd:complexType name=”ShapeDetail”> <xsd:sequence>

<xsd:element name=”ShapeType” type=”Enums.Shape” /> <xsd:element name="PenColor" type="RGB" /> <xsd:element name="LineWidth" type="int" /> <xsd:element name="Fill" type="bool" /> <xsd:element name="RadiusHorizontal" type="float" /> <xsd:element name="RadiusVertical" type="float" /> <xsd:element name="Center" type="MapPinLocationType" /> <xsd:element name="LatitudeLongitude" type="ArrayOfLatitudeLongitude" />


Definition of a Line:

In order to define a line, the following elements of the ShapeDetail must be defined: ShapeType = LINE PenColor LineWidth LatitudeLongitude – This will be an array of LatitudeLongitude objects. The number of

elements in this array must be 2, defining the two points of the line.

Sample XML for a Line:

<ShapeDetail> <ShapeType>LINE</ShapeType> <PenColor> <Red>255</Red> <Green></Green> <Blue></Blue> </PenColor> <LineWidth>5</LineWidth> <LatitudeLongitude> <LatitudeLongitude> <Latitude>29439597</Latitude> <Longitude>-98459472</Longitude> </LatitudeLongitude> <LatitudeLongitude> <Latitude>29759608</Latitude> <Longitude>-95388793</Longitude>



</LatitudeLongitude> </LatitudeLongitude> </ShapeDetail>

Definition of a Circle:

In order to define a circle, the following elements of the ShapeDetail must be defined: ShapeType = CIRCLE PenColor LineWidth Fill RadiusHorizontal Center – The PinLat and PinLong values must be defined.

Sample XML for a Circle:

The following xml with draw a 50-mile radius circle around Princeton, NJ with a line color of green:

<ShapeDetail> <ShapeType>CIRCLE</ShapeType> <PenColor> <Red></Red> <Green>255</Green> <Blue></Blue> </PenColor> <LineWidth>5</LineWidth> <Fill>true</Fill> <RadiusHorizontal>50</RadiusHorizontal> <RadiusVertical></RadiusVertical> <Center> <ID></ID> <PinLat>40348610</PinLat> <PinLong>-74659440</PinLong> <PinX></PinX> <PinY></PinY> <Bitmap></Bitmap> <Category></Category> </Center> </ShapeDetail>

Definition of an Ellipse:

In order to define an ellipse, the following elements of the ShapeDetail must be defined: ShapeType = ELLIPSE PenColor LineWidth



Fill RadiusHorizontal RadiusVertical Center – The PinLat and PinLong values must be defined.

Sample XML for an Ellipse:

<ShapeDetail> <ShapeType>ELLIPSE</ShapeType> <PenColor> <Red></Red> <Green></Green> <Blue>255</Blue> </PenColor> <LineWidth>5</LineWidth> <Fill>true</Fill> <RadiusHorizontal>50</RadiusHorizontal> <RadiusVertical>40</RadiusVertical> <Center> <ID></ID> <PinLat>40348610</PinLat> <PinLong>-74659440</PinLong> <PinX></PinX> <PinY></PinY> <Bitmap></Bitmap> <Category></Category> </Center> </ShapeDetail>

Definition of a Rectangle:

In order to define a rectangle, the following elements of the ShapeDetail must be defined: ShapeType = RECT PenColor LineWidth LatitudeLongitude – This will be an array of LatitudeLongitude objects. The number of

elements in this array must be 2. This element is made up of two latitude/longitude pairs that define the opposite corners of the rectangle.

Sample XML for a Rectangle:

<ShapeDetail> <ShapeType>RECT</ShapeType> <PenColor> <Red>255</Red>



<Green></Green> <Blue></Blue> </PenColor> <LineWidth>5</LineWidth> <Fill>true</Fill> <LatitudeLongitude> <LatitudeLongitude> <Latitude>29439597</Latitude> <Longitude>-98459472</Longitude> </LatitudeLongitude> <LatitudeLongitude> <Latitude>29759608</Latitude> <Longitude>-95388793</Longitude> </LatitudeLongitude> </LatitudeLongitude> </ShapeDetail>

Definition of a Polygon:

In order to define a rectangle, the following elements of the ShapeDetail must be defined: ShapeType = POLYGON PenColor LineWidth LatitudeLongitude – This will be an array of LatitudeLongitude object. The number of

elements in this array must be 2.

Sample XML for a Polygon:

<ShapeDetail> <ShapeType>POLYGON</ShapeType> <PenColor> <Red>255</Red> <Green></Green> <Blue></Blue> </PenColor> <LineWidth>10</LineWidth> <Fill>true</Fill> <LatitudeLongitude> <LatitudeLongitude> <Latitude>40348727</Latitude> <Longitude>-74659049</Longitude> </LatitudeLongitude> <LatitudeLongitude> <Latitude>40568010</Latitude> <Longitude>-74609775</Longitude> </LatitudeLongitude> <LatitudeLongitude>



<Latitude>40655523</Latitude> <Longitude>-73978257</Longitude> </LatitudeLongitude> </LatitudeLongitude> </ShapeDetail>

2.18 GeoLocType The GeoLocType structure will be used to pass all data specific to independently geocoded addresses. This structure is associated with the following APIs:

PMWSGeocode

Elements


Required

GeoAddress A LocationInputType structure

See Section 2.2 for parameters N

GeoType A string representing the type of geocoding to be done

V (verify) [will verify that there is enough information to geocode – future enhancement], G (geocode) [will geocode the address], L2A (lat/long to address) [will take an input lat/long pair and return an address], A2L (address to lat/long) [will take an input address and provide a lat/long pair]

N

GeoList A string representing whether a pick list is to be returned with valid entries

Y (yes) N (no –which will return “best match”)

N

Abstract

<xsd:complexType name=”GeoLocType”> <xsd:sequence> <xsd:element name=”GeoAddress” type=”LocationInputType “/> <xsd:element name="GeoType" type="xsd:string" /> <xsd:element name=”GeoList” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>



2.19 PointSearchType The PointSearchType structure will be used to pass in which locations, and points of interest, are to be searched for. Only those types to be searched for need to be passed in with a parameter of Y or Yes. This structure is associated with the following APIs:

PMWSRadiusSearch

Elements


Required

POICity Search for cities. Y (return this POI), N (do not return this POI)

N – But must specify Y to at least 1 POI type

POIZip Search for zip codes. Y (return this POI), N (do not return this POI)


POIPlace Search for Custom Places. Y (return this POI), N (do not return this POI)


POIAll Search for all POI ; this field does not imply that the prior fields are to be searched for, but it does imply the subsequent.

Y (return this POI), N (do not return this POI)


POIAirMajor Search for major airports. Y (return this POI), N (do not return this POI)

N – But must specify Y to at least 1 POI

POIAirMinor Search for minor airports. Y (return this POI), N (do not return this POI)


POIAuto Search for automotive and maintenance POIs.



POICat Search for CAT Scale weigh stations .



POIDine Search for dining establishments.



POIEd Search for educational institutions.



POIEm Search for emergency and medical facilities.



POIFac Search for facilities and buildings.



POIGas Search for gas stations. Y (return this POI), N (do not return this POI)


POIGov Search for government buildings.





POILog Search for lodging. Y (return this POI), N (do not return this POI)


POINat Search for nature attractions.



POINode Search for intersections and exits.



POIPark Search for parks and similar facilities.



POIRtl Search for retail stores. Y (return this POI), N (do not return this POI)


POIRV Search for RV facilities. Y (return this POI), N (do not return this POI)


POISport Search for sports facilities. Y (return this POI), N (do not return this POI)


POITrav Search for travel and transportation facilities.



POITruck Search for truck fuel and services facilities.



POIVstr Search for visitors’centers. Y (return this POI), N (do not return this POI)


POIWS Search for weigh stations. Y (return this POI), N (do not return this POI)


Abstract

<xsd:complexType name=”PointSearchType”> <xsd:sequence> <xsd:element name=”POICity” type=”xsd:string” /> <xsd:element name="POIZip" type="xsd:string" /> <xsd:element name=”POIPlace” type=”xsd:string” /> <xsd:element name=”POIAll” type=”xsd:string” /> <xsd:element name=”POIAirMajor” type=”xsd:string” /> <xsd:element name=”POIPAirMinor” type=”xsd:string” /> <xsd:element name=”POIAuto” type=”xsd:string” /> <xsd:element name=”POICat” type=”xsd:string” /> <xsd:element name=”POIDine” type=”xsd:string” /> <xsd:element name=”POIEd” type=”xsd:string” /> <xsd:element name=”POIEm” type=”xsd:string” /> <xsd:element name=”POIFac” type=”xsd:string” /> <xsd:element name=”POIGas” type=”xsd:string” /> <xsd:element name=”POIGov” type=”xsd:string” /> <xsd:element name=”POILog” type=”xsd:string” /> <xsd:element name=”POINat” type=”xsd:string” /> <xsd:element name=”POINode” type=”xsd:string” /> <xsd:element name=”POIPark” type=”xsd:string” /> <xsd:element name=”POIRtl” type=”xsd:string” /> <xsd:element name=”POIRV” type=”xsd:string” /> <xsd:element name=”POISport” type=”xsd:string” />



<xsd:element name=”POITrav” type=”xsd:string” /> <xsd:element name=”POITruck” type=”xsd:string” /> <xsd:element name=”POIVstr” type=”xsd:string” /> <xsd:element name=”POIWS” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

2.20 CompLineType The CompLineType structure will be used to pass all data associated with the Comparison Report. Elements

Element Definition Route The name of the route: Route1, Route2, etc. TripOrigin The LocationOutputType for the trip origin TripDestination A LocationOutputType structure for the trip destination Miles Miles for the trip Cost The cost for the trip Hours The length of time for the trip, in hours Tolls The Toll Costs for the trip Fuel Fuel cost per gallon or liter Estghg* Estimated Greenhouse Gas emissions* Labor Labor costs Other Other costs

* Beginning in Version 24, a new Greenhouse Gas Estimator is now available for use in route calculations and reports. Based on a setting for emissions in pounds of CO2 equivalent per gallon of fuel, Greenhouse Gas estimates are now calculated by route in the Comparison Report. This feature allows users to consider the carbon footprint when selecting the optimal route for their business needs.

Abstract

<xsd:complexType name=”CompLineType”>

<xsd:sequence> <xsd:element name=”Route” type=”xsd:string” /> <xsd:element name=”TripOrigin” type=”xsd:string” /> <xsd:element name="TripDestination" type="xsd:string" /> <xsd:element name=”Miles” type=”xsd:string” /> <xsd:element name="Cost" type="xsd:string" /> <xsd:element name="Hours" type="xsd:string" /> <xsd:element name=”Tolls” type=”xsd:string” /> <xsd:element name=”Labor” type=”xsd:string” /> <xsd:element name="Other" type="xsd:string"/> <xsd:element name=”Estghg” type=”xsd:string” /> <xsd:element name=”Fuel” type=”xsd:string” />




2.21 RouteLegDetail The RouteLegDetail structure will be used to pass all data associated with the appearance of a route in a map. This structure is associated with the following APIs:

PMWSGetMapRoute PMWGetMapRoutes PMWSGetMapBreadcrumbTrail

Elements


Required

LabelText A text that is displayed besides a route. The text displayed is the mileage from origin to destination.

True or False N

LegDetail Defines the width and color of the route drawn on the map, it is a list of LineDetail structures. A LineDetail structure consists of a LineColor structure of type RGB and a LineWidth string.

0 thru 255 Ex: <Red>0</Red> <Green>255</Green> <Blue>0</Blue>

N

TextDetail Defines the color and font size of the route label, it is a list of RouteLegLabel structures. A RouteLegLabel structure consists of a TextColor structure of type RGB and a FontSize string. TheRGB represents the color of the LabelText. The FontSize is the size of the LabelText.

RGB: 0 thru 255 FontSize: Any valid Integer 7-72 Ex: <Red>0</Red> <Green>255</Green> <Blue>0</Blue> <FontSize>16</FontSize>

N

* This structure was introduced in version 25.

Abstract

<xsd:complexType name="RouteLegDetail"> < xsd:sequence> < xsd:element name="LabelText" type="s:string"/> < xsd:element name="LegDetail" type="ArrayOfLineDetail"/>



< xsd:element name="TextDetail" type="ArrayOfRouteLegLabel"/> </ xsd:sequence> </ xsd:complexType>

2.22 CircleDetail

NOTE: The CircleDetail structure has been deprecated, in favor of the ShapeDetail structure. Please refrain from using CircleDetail. This structure is associated with the following APIs:

PMWSGetMap PMWSGetMapRoute PMWGetMapRoutes PMWSGetMapBreadcrumbTrail

Elements


Required

LineColor A RGB value that defines the color of the circle to be drawn

RGB: 0 thru 255 Ex: <Red>0</Red> <Green>255</Green> <Blue>0</Blue>

N

LineWidth A string value that defines the thickness of the line


N

Radius The radius of the circle Any valid Integer Ex: 5

N

Fill true or false value; if true, then the inside of the color is filled with the LineColor value.

true or false N

Center A MapPinLocationType structure; it can be used to define the coordinates of the center of the circle.

Ex: <Center> <ID>1</ID> <PinLat>52211483</PinLat> <PinLong>108609929</PinLong> <PinX>320</PinX> <PinY>240</PinY> <Bitmap>truck_g</Bitmap> </Center>

N




Abstract

<xsd:complexType name="CircleDetail"> <xsd:sequence> <xsd:element name="LineColor" type="RGB"/> <xsd:element name="LineWidth" type="string"/> <xsd:element name="Radius" type="string"/> <xsd:element name="Fill" type="string"/> <xsd:element name="Center" type="MapPinLocationType"/> </xsd:sequence> </xsd:complexType>

2.23 StateHighlightDetail The StateHighlighDetail structure specifies a state that should be highlighted (filled with a color) on the map. This structure is associated with the following APIs:

PMWSGetMap PMWSGetMapRoute PMWGetMapRoutes PMWSGetMapBreadcrumbTrail

Elements


Required

FillColor A RGB value that defines the color of the fill/highlight

Ex: <FillColor> <Red>255</Red> <Green>0</Green> <Blue>0</Blue> </FillColor>

N

State A string that identifies which state should be highlighted

Valid State Ex: PA

N


Abstract

<xsd:complexType name="StateHighlightDetail"> <xsd:sequence> <xsd:element name="FillColor" type="RGB"/> <xsd:element name="State" type="string"/> </xsd:sequence> </xsd:complexType>

| 54


APIs Exposed Per Feature Option Access to the APIs described in this chapter is determined by your Feature Option Level. For more details, refer to section 1.1, PC*MILER Web Services Feature Option Levels.

API Lite Standard Premium EnterpriseStandard-Worldwide

Premium-Worldwide

PMWSGetReport PMWSGetMapRoute PMWSGetMap PMWSGetETAOutOfRoute PMWSGetMapBreadcrumbTrail

PMWSSetMapCustomPlace PMWSGetCustomPlace PMWSSetAvoidFavor PMWSGetAvoidFavor PMWSSetRoadSpeed PMWSGetRoadSpeed PMWSGeoCode PMWSRadiusSearch PMWSReduceTrip PMWSGetMapRoutes PMWSGetStates PMWSAbout

3.1 PMWSGetReport All requests for data are done through the PMWSGetReport API, and the type of report will be driven by the parameters passed into the API. The available reports include the following: Trip Distance Report, State/Country Distance Report, Detailed Route Report, Condensed Driving Directions, Driving Directions Report, Road Type Report, Calculate Report, and Comparison Report.

Chapter 3: API Descriptions

Chapter 3: API Descriptions | 55


Elements


Required

LoginInfo A LoginType structure

See section 2.1 Y

TripOrigin LocationInputType structure with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See section 2.2 Y

TripDestination LocationInputType structure with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See section 2.2 Y

TripHub A string to request Hub routing; default is No for standard routing

Y or Yes N or No

N

ReportType Type of report being requested

Trip Distance Report: M or miles for the mileage report between the two points State/Country Distance Report: S or state to also include the state information Detailed Route Report: D or detail for the detailed route report Driving Directions Report: V or driver for driver’s directions Road Type Report: R or road for the miles by road type report; Fuel Optimization Report: F or fuel; GeoTunnel Report: G or Geo; returns lat/longs at specified intervals along the trip (see CiteInt parameter below); may be used to determine how close a particular geographic location is to any point on the route Least Cost Report: L or LeastCost (batch processing of trips is not allowed with least cost comparison) Mileage Report: C (mileage only)

Y



TripID A string containing an identifier; this will be echoed back in the response

Any String “MyTripID” N

TripOptions An OptionsType structure

See section 2.7 N

TripFuel A FuelOptType structure

N

TollDiscount A string containing the applicable discount program; this field is only valid if the user has quarterly toll data privileges and the TollData field in the TripOptions is set to Yes.

407ETR Transponder, A25 Transponder, A30 EXPRESS Transponder*, BreezeBy, C-Pass, Cruise Card, Downbeach Express Pass*, E-Pass, E-Pass Canada, EXpress Toll, EZ Tag, EZPass, EZPass-NJ, EZPass-WV, FAST LANE, FasTrak, GeauxPass, GO-PASS, Good to Go, I-PASS, I-Zoom, K-TAG, Laredo Trade Tag, Leeway, MACPASS, NC Quick Pass, NEXPRESS TOLL, NEXUS*, Palmetto Pass, Peach Pass, PikePass, Quickpass, Smart Tag, StraitPASS, SunPass, TollTag, TReO*, TxTag, and WabashPass , or All;

*New for V27:

A30 EXPRESS Transponder, Downbeach Express Pass, NEXUS, TReO

Conditional

TripStopsOptimize A string containing A or All which will then re-order all of the input stops in the most optimal sequence, or a string containing F or Fixed which will then re-order the input stops while keeping the destination fixed; only valid for multiple stop trips

A or All F or Fixed

N

CondenseFlag Y or yes for condensed driving directions, and N or

Y or Yes N or No

Conditional



no (the default) for full text directions; this field is only valid if the ReportType is V or Driver

ReportInstance A numeric field defining how many of this particular report are being requested; default is 1.

Valid Integer Ex: 2

N

CiteInt A numeric field defining at what interval of miles lat/longs are to be cited; this is only valid for the geotunnel report.

Valid Decimal Ex:1.5

Conditional

DLDirection Separates the route and directions if set to True; default is False (route and directions are concatenated in one line in the report).

True or False N

Example: Trip Distance Report With that definition as the template, the first example to be outlined will be the ability to get a trip’s distance. Looking at the definition, the parameters that must be passed are the login, the origin, the destination, and the report type. The login information is self-explanatory and thus will not be outlined here. Both the origin and destination – TripOrigin and TripDestination – utilize the LocationInputType structure, which allows for various addressing styles to be passed (full address, city/state pair, ZIP/Postal Code, lat/long, &c) and the styles do not need to match. For instance, the origin can be a lat/long and the destination can be city/state pair. For purposes of this example, the origin will be 1000 Herrontown Rd., Princeton, NJ and the destination Edison, NJ with no intervening stops. The resultant XML would appear as: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>



<PMWSGetReport xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <LocationInputType> <Address1>1000 Herrontown Rd</Address1> <City>Princeton</City> <State>NJ</State> </LocationInputType> </TripOrigin> <TripDestination> <LocationInputType> <City>Edison</City> <State>NJ</State> </LocationInputType> </TripDestination> <TripID> <string>Test ID 1</string> </TripID> <ReportType> <string>M</string> </ReportType> <ReportInstance>1</ReportInstance> </PMWSGetReport> </soap:Body> </soap:Envelope> From this request, PC*MILER Web Services will return the following response: <?xml version="1.0" encoding="utf-8"?> <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <PMWSGetReportResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetReportResult> <ReportResponse> <Version>.08</Version> <Report> <RptType>m</RptType> <TripID>Test ID 1</TripID> <StopNum>1</StopNum> <MilesReport> <StpLineType> <SRStop> <Address1>1000 Herrontown Road</Address1>

Did you know? This is a user-defined numeric or alphanumeric character string.



<City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <Juris /> <Lat>40389448</Lat> <Long>-74656224</Long> </SRStop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>0.0</LEstghg> <TEstghg>0.0</TEstghg> </StpLineType> <StpLineType> <SRStop> <Address1 /> <City>Edison</City> <State>NJ</State> <Zip>08817</Zip> <Juris>Middlesex</Juris> <Lat>40517293</Lat> <Long>-74406797</Long> </SRStop> <LMiles>29.0</LMiles> <TMiles>29.0</TMiles> <LCostMile>39.38</LCostMile> <TCostMile>39.38</TCostMile> <LHours>0:08</LHours> <THours>0:08</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>64.1</LEstghg> <TEstghg>64.1</TEstghg> </StpLineType> </MilesReport> </Report> </ReportResponse> </PMWSGetReportResult> </PMWSGetReportResponse> </soap:Body>

Did you know? Lat/longs are entered and returned in millionths of degrees.



Example: State/Country Distance Report with Route Optimization For something more complex, what follows is a request for a State/Country Distance Report with four stops that have been optimized. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetReport xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <LocationInputType> <Address1>399 Thornall St</Address1> <City>Edison</City> <State>NJ</State> <Zip>08837-2246</Zip> </LocationInputType> </TripOrigin> <TripDestination> <LocationInputType> <Address1>900 Lanidex Plz</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> </LocationInputType> </TripDestination> <TripStops> <ArrayOfLocationInputType> <LocationInputType> <Address1>1000 Herrontown Rd</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> </LocationInputType> <LocationInputType> <City>Robbinsville</City> <State>NJ</State> <Zip>08691</Zip> </LocationInputType> </ArrayOfLocationInputType> </TripStops> <TripID>



<string>Test ID 1</string> </TripID> <TripStopsOptimize> <string>A</string> </TripStopsOptimize> <ReportType> <string>S</string> </ReportType> <ReportInstance>1</ReportInstance> </PMWSGetReport> </soap:Body> </soap:Envelope> From this request, PC*MILER Web Services will return the following response: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetReportResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetReportResult> <ReportResponse> <Version>27.0.1.0</Version> <Report> <RptType>s</RptType> <TripID>Test ID 1</TripID> <StopNum>3</StopNum> <StateReport> <StopMiles> <StpLineType> <SRStop> <Region>NA</Region> <Address1>399 Thornall Street</Address1> <City>Edison</City> <State>NJ</State> <Zip>08837</Zip> <Juris>Middlesex</Juris> <Lat>40561550</Lat> <Long>-74335938</Long> </SRStop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours>



<THours>0:00</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>0.0</LEstghg> <TEstghg>0.0</TEstghg> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1/> <City>Robbinsville</City> <State>NJ</State> <Zip>08691</Zip> <Juris>Mercer</Juris> <Lat>40200645</Lat> <Long>-74629683</Long> <StopWarning>False</StopWarning> </SRStop> <LMiles>36.4</LMiles> <TMiles>36.4</TMiles> <LCostMile>61.85</LCostMile> <TCostMile>61.85</TCostMile> <LHours>0:42</LHours> <THours>0:42</THours> <LTolls>7.75</LTolls> <TTolls>7.75</TTolls> <LEstghg>134.8</LEstghg> <TEstghg>134.8</TEstghg> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <Juris>Mercer</Juris> <Lat>40388250</Lat> <Long>-74654726</Long> <StopWarning>False</StopWarning> </SRStop> <LMiles>21.9</LMiles> <TMiles>58.4</TMiles> <LCostMile>33.22</LCostMile> <TCostMile>95.07</TCostMile> <LHours>0:27</LHours> <THours>1:09</THours>



<LTolls>0.00</LTolls> <TTolls>7.75</TTolls> <LEstghg>81.1</LEstghg> <TEstghg>215.9</TEstghg> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1>900 Plaza Lanidex</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> <Juris>Morris</Juris> <Lat>40861341</Lat> <Long>-74420469</Long> <StopWarning>False</StopWarning> </SRStop> <LMiles>42.2</LMiles> <TMiles>100.6</TMiles> <LCostMile>63.14</LCostMile> <TCostMile>158.21</TCostMile> <LHours>0:50</LHours> <THours>1:58</THours> <LTolls>0.00</LTolls> <TTolls>7.75</TTolls> <LEstghg>156.2</LEstghg> <TEstghg>372.1</TEstghg> </StpLineType> </StopMiles> <StateMiles> <SCLineType> <StCntry>NJ</StCntry> <STotal>100.6</STotal> <SToll>27.6</SToll> <SFree>73.0</SFree> <SFerry>0.0</SFerry> <SLoaded>100.6</SLoaded> <SEmpty>0.0</SEmpty> <STolls>7.75</STolls> </SCLineType> <SCLineType> <StCntry>US</StCntry> <STotal>100.6</STotal> <SToll>27.6</SToll> <SFree>73.0</SFree> <SFerry>0.0</SFerry> <SLoaded>100.6</SLoaded>



<SEmpty>0.0</SEmpty> <STolls>7.75</STolls> </SCLineType> <SCLineType> <StCntry>TOTAL</StCntry> <STotal>100.6</STotal> <SToll>27.6</SToll> <SFree>73.0</SFree> <SFerry>0.0</SFerry> <SLoaded>100.6</SLoaded> <SEmpty>0.0</SEmpty> <STolls>7.75</STolls> </SCLineType> </StateMiles> </StateReport> </Report> </ReportResponse> </PMWSGetReportResult> </PMWSGetReportResponse> </soap:Body> </soap:Envelope>

Example: Batch Report Request It is also possible to batch report requests into one API call. The following request is for three trips – the first and last with two stops, and the second with three stops – with each of them getting different report types. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetReport xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <LocationInputType> <Address1>4800 SOUTHWEST LOOP 820</Address1> <Zip>76109</Zip> </LocationInputType> <LocationInputType> <Address1>10972 W COLONIAL DR</Address1>



<Zip>34761</Zip> </LocationInputType> <LocationInputType> <Address1>2250 MAPLE AVENUE</Address1> <Zip>19440</Zip> </LocationInputType> </TripOrigin> <TripDestination> <LocationInputType> <Address1>10900 SAN SEVAINE WAY</Address1> <Zip>91752</Zip> </LocationInputType> <LocationInputType> <Address1>8790 WALLISVILLE RD.</Address1> <Zip>77029</Zip> </LocationInputType> <LocationInputType> <Address1>230 JOHN HANCOCK RD</Address1> <Zip>02780</Zip> </LocationInputType> </TripDestination> <ReportType> <string>m</string> <string>s</string> <string>s</string> </ReportType> <ReportInstance>3</ReportInstance> </PMWSGetReport> </soap:Body> </soap:Envelope> From this request, PC*MILER Web Services will return the following response: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetReportResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetReportResult> <ReportResponse> <Version>.11</Version> <Report> <RptType>m</RptType> <StopNum>1</StopNum> <MilesReport>



<StpLineType> <SRStop> <Region>NA</Region> <Address1>4800 Southwest Loop 820</Address1> <City>Fort Worth</City> <State>TX</State> <Zip>76132</Zip> <Juris /> <Lat>32682584</Lat> <Long>-97395960</Long> </SRStop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1>10900 San Sevaine Way</Address1> <City>Mira Loma</City> <State>CA</State> <Zip>91752</Zip> <Juris /> <Lat>34017496</Lat> <Long>-117522312</Long> </SRStop> <LMiles>1355.2</LMiles> <TMiles>1355.2</TMiles> <LCostMile>1843.06</LCostMile> <TCostMile>1843.06</TCostMile> <LHours>24:41</LHours> <THours>24:41</THours> </StpLineType> </MilesReport> </Report> </ReportResponse> <ReportResponse> <Version>.11</Version> <Report> <RptType>s</RptType> <StopNum>1</StopNum> <StateReport> <StopMiles> <StpLineType>



<SRStop> <Region>NA</Region> <Address1>10972 West Colonial Drive</Address1> <City>Ocoee</City> <State>FL</State> <Zip>34761</Zip> <Juris /> <Lat>28551670</Lat> <Long>-81541696</Long> </SRStop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1>8790 Wallisville Road</Address1> <City>Houston</City> <State>TX</State> <Zip>77020</Zip> <Juris /> <Lat>29790786</Lat> <Long>-95273048</Long> </SRStop> <LMiles>946.7</LMiles> <TMiles>946.7</TMiles> <LCostMile>1287.49</LCostMile> <TCostMile>1287.49</TCostMile> <LHours>17:20</LHours> <THours>17:20</THours> </StpLineType> </StopMiles> <StateMiles> <SCLineType> <StCntry>TX</StCntry> <STotal>0.2</STotal> <SToll>0.0</SToll> <SFree>0.2</SFree> <SFerry>0.0</SFerry> <SLoaded>0.2</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> <SCLineType>



<StCntry>US</StCntry> <STotal>946.5</STotal> <SToll>39.6</SToll> <SFree>906.9</SFree> <SFerry>0.0</SFerry> <SLoaded>946.5</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> <SCLineType> <StCntry>Total</StCntry> <STotal>946.7</STotal> <SToll>39.6</SToll> <SFree>907.1</SFree> <SFerry>0.0</SFerry> <SLoaded>946.7</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> </StateMiles> </StateReport> </Report> </ReportResponse> <ReportResponse> <Version>.11</Version> <Report> <RptType>s</RptType> <StopNum>1</StopNum> <StateReport> <StopMiles> <StpLineType> <SRStop> <Region>NA</Region> <Address1>2250 Maple Avenue</Address1> <City>Hatfield</City> <State>PA</State> <Zip>19440</Zip> <Juris /> <Lat>40281636</Lat> <Long>-75294944</Long> </SRStop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> </StpLineType> <StpLineType>



<SRStop> <Region>NA</Region> <Address1>230 John Hancock Road</Address1> <City>Taunton</City> <State>MA</State> <Zip>02780</Zip> <Juris /> <Lat>41946528</Lat> <Long>-71137344</Long> </SRStop> <LMiles>297.7</LMiles> <TMiles>297.7</TMiles> <LCostMile>404.87</LCostMile> <TCostMile>404.87</TCostMile> <LHours>5:40</LHours> <THours>5:40</THours> </StpLineType> </StopMiles> <StateMiles> <SCLineType> <StCntry>MA</StCntry> <STotal>1.4</STotal> <SToll>0.0</SToll> <SFree>1.4</SFree> <SFerry>0.0</SFerry> <SLoaded>1.4</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> <SCLineType> <StCntry>PA</StCntry> <STotal>0.3</STotal> <SToll>0.0</SToll> <SFree>0.3</SFree> <SFerry>0.0</SFerry> <SLoaded>0.3</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> <SCLineType> <StCntry>US</StCntry> <STotal>295.9</STotal> <SToll>22.5</SToll> <SFree>273.4</SFree> <SFerry>0.0</SFerry> <SLoaded>295.9</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> <SCLineType>



<StCntry>Total</StCntry> <STotal>297.7</STotal> <SToll>22.5</SToll> <SFree>275.2</SFree> <SFerry>0.0</SFerry> <SLoaded>297.7</SLoaded> <SEmpty>0.0</SEmpty> </SCLineType> </StateMiles> </StateReport> </Report> </ReportResponse> </PMWSGetReportResult> </PMWSGetReportResponse> </soap:Body> </soap:Envelope> Last is an example to request a fuel optimized report: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetReport xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <LocationInputType> <Address1>1000 Herrontown rd</Address1> <Zip>08540</Zip> </LocationInputType> </TripOrigin> <TripDestination> <LocationInputType> <Zip>12181</Zip> </LocationInputType> </TripDestination> <TripFuel> <FuelOptType> <FuelLogin> <UserID>fuelID</UserID> <Password>fuelPW</Password>



<Account>fuelAcc</Account> </FuelLogin> <FuelCap>200</FuelCap> <Level>50</Level> <MPG>6.0</MPG> </FuelOptType> </TripFuel> <ReportType> <string>d</string> </ReportType> <ReportInstance>0</ReportInstance> </PMWSGetReport> </soap:Body> </soap:Envelope> Which will receive a response as follows: <?xml version="1.0" encoding="utf-8"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetReportResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetReportResult> <ReportResponse> <Version>27.0.1.0</Version> <Report> <RptType>d</RptType> <StopNum>1</StopNum> <DetailReport> <DtlStructType> <DtlOrigin> <Region>NA</Region> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <Juris>Mercer</Juris> <Lat>40388250</Lat> <Long>-74654726</Long> </DtlOrigin> <DtlLines> <DtlLineType> <DLStop>Origin: 1000 Herrontown Road, 08540 Princeton, NJ, Mercer</DLStop> <DLRoute/>



<DLMiles/> <DLTime>0:00</DLTime> <DLTToll>(On-Duty) 0.00</DLTToll> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>North Local</DLRoute> <DLMiles>0.1</DLMiles> <DLTime>0:00</DLTime> <DLInterCh>+ Local US-206</DLInterCh> <DLLMiles>0.1</DLLMiles> <DLLTime>0:00</DLLTime> <DLTMiles>0.1</DLTMiles> <DLTTime>0:00</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>North US-206</DLRoute> <DLMiles>14.2</DLMiles> <DLTime>0:21</DLTime> <DLInterCh>+ US-206 Somerville Cir</DLInterCh> <DLLMiles>14.3</DLLMiles> <DLLTime>0:22</DLLTime> <DLTMiles>14.3</DLTMiles> <DLTTime>0:22</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>Keep right Somerville Cir</DLRoute> <DLMiles>0.0</DLMiles> <DLTime>0:00</DLTime> <DLInterCh>+ Somerville Cir Ramp</DLInterCh> <DLLMiles>14.3</DLLMiles> <DLLTime>0:22</DLLTime> <DLTMiles>14.3</DLTMiles> <DLTTime>0:22</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>Keep right Ramp</DLRoute> <DLMiles>0.3</DLMiles>



<DLTime>0:01</DLTime> <DLInterCh>+ Ramp US-202</DLInterCh> <DLLMiles>14.6</DLLMiles> <DLLTime>0:23</DLLTime> <DLTMiles>14.6</DLTMiles> <DLTTime>0:23</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>North US-202</DLRoute> <DLMiles>1.3</DLMiles> <DLTime>0:01</DLTime> <DLInterCh>+ US-202</DLInterCh> <DLLMiles>15.9</DLLMiles> <DLLTime>0:24</DLLTime> <DLTMiles>15.9</DLTMiles> <DLTTime>0:24</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>North I-287</DLRoute> <DLMiles>20.2</DLMiles> <DLTime>0:19</DLTime> <DLInterCh>+ I-287 US-202</DLInterCh> <DLLMiles>36.2</DLLMiles> <DLLTime>0:43</DLLTime> <DLTMiles>36.2</DLTMiles> <DLTTime>0:43</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NJ</DLState> <DLRoute>North I-287</DLRoute> <DLMiles>29.4</DLMiles> <DLTime>0:27</DLTime> <DLInterCh>(to NJ/NY State Line)</DLInterCh> <DLLMiles>65.6</DLLMiles> <DLLTime>1:10</DLLTime> <DLTMiles>65.6</DLTMiles> <DLTTime>1:10</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/>



</DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>North I-287</DLRoute> <DLMiles>0.3</DLMiles> <DLTime>0:00</DLTime> <DLInterCh>+ I-287 Ramp</DLInterCh> <DLLMiles>65.9</DLLMiles> <DLLTime>1:10</DLLTime> <DLTMiles>65.9</DLTMiles> <DLTTime>1:10</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>Keep left Ramp</DLRoute> <DLMiles>0.7</DLMiles> <DLTime>0:02</DLTime> <DLInterCh>+ Ramp I-87</DLInterCh> <DLLMiles>66.5</DLLMiles> <DLLTime>1:12</DLLTime> <DLTMiles>66.5</DLTMiles> <DLTTime>1:12</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>North I-87 - New York State Thruway</DLRoute> <DLMiles>111.0</DLMiles> <DLTime>1:43</DLTime> <DLInterCh>+ I-87 Exit 23</DLInterCh> <DLLMiles>177.6</DLLMiles> <DLLTime>2:55</DLLTime> <DLTMiles>177.6</DLTMiles> <DLTTime>2:55</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>Keep right Exit 23</DLRoute> <DLMiles>0.3</DLMiles> <DLTime>0:01</DLTime> <DLInterCh>+ Exit 23 Toll Plaza</DLInterCh> <DLLMiles>177.8</DLLMiles>



<DLLTime>2:55</DLLTime> <DLTMiles>177.8</DLTMiles> <DLTTime>2:55</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>Keep right Toll Plaza</DLRoute> <DLMiles>0.1</DLMiles> <DLTime>0:00</DLTime> <DLInterCh>+ Toll Plaza Ramp</DLInterCh> <DLLMiles>177.9</DLLMiles> <DLLTime>2:55</DLLTime> <DLTMiles>177.9</DLTMiles> <DLTTime>2:55</DLTTime> <DLLToll>20.81</DLLToll> <DLTToll/> <DLTollPlazaAbbr>NYSTA 15 23</DLTollPlazaAbbr> <DLTollPlazaName>New York State Thruway 15 Woodbury 23 Albany (Downtown)</DLTollPlazaName> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>Keep left Ramp</DLRoute> <DLMiles>0.5</DLMiles> <DLTime>0:01</DLTime> <DLInterCh>+ Ramp I-787</DLInterCh> <DLLMiles>178.4</DLLMiles> <DLLTime>2:57</DLLTime> <DLTMiles>178.4</DLTMiles> <DLTTime>2:57</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>North I-787</DLRoute> <DLMiles>5.4</DLMiles> <DLTime>0:05</DLTime> <DLInterCh>+ I-787 Exit 7E</DLInterCh> <DLLMiles>183.8</DLLMiles> <DLLTime>3:02</DLLTime> <DLTMiles>183.8</DLTMiles> <DLTTime>3:02</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/>



</DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>Keep right Exit 7E</DLRoute> <DLMiles>0.5</DLMiles> <DLTime>0:02</DLTime> <DLInterCh>+ Exit 7E NY-378</DLInterCh> <DLLMiles>184.3</DLLMiles> <DLLTime>3:04</DLLTime> <DLTMiles>184.3</DLTMiles> <DLTTime>3:04</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>East NY-378</DLRoute> <DLMiles>0.5</DLMiles> <DLTime>0:01</DLTime> <DLInterCh>+ NY-378 US-4</DLInterCh> <DLLMiles>184.9</DLLMiles> <DLLTime>3:04</DLLTime> <DLTMiles>184.9</DLTMiles> <DLTTime>3:04</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLState>NY</DLState> <DLRoute>North US-4</DLRoute> <DLMiles>2.6</DLMiles> <DLTime>0:03</DLTime> <DLInterCh>Troy, NY 12181</DLInterCh> <DLLMiles>187.4</DLLMiles> <DLLTime>3:08</DLLTime> <DLTMiles>187.4</DLTMiles> <DLTTime>3:08</DLTTime> <DLLToll>0.00</DLLToll> <DLTToll/> </DtlLineType> <DtlLineType> <DLArState>Arrive Loaded</DLArState> </DtlLineType> <DtlLineType> <DLStop>Dest: 12181 Troy, NY, Rensselaer</DLStop> <DLRoute/> <DLMiles/>



<DLTime>0:00</DLTime> <DLInterCh/> <DLLMiles>187.4</DLLMiles> <DLLTime>3:08</DLLTime> <DLTMiles>187.4</DLTMiles> <DLTTime>3:08</DLTTime> <DLTToll>20.81</DLTToll> </DtlLineType> </DtlLines> <DtlDest> <Region>NA</Region> <Address1/> <City>Troy</City> <State>NY</State> <Zip>12181</Zip> <Juris>Rensselaer</Juris> <Lat>42739834</Lat> <Long>-73685677</Long> <StopWarning>False</StopWarning> </DtlDest> </DtlStructType> </DetailReport> </Report> </ReportResponse> </PMWSGetReportResult> </PMWSGetReportResponse> </soap:Body> </soap:Envelope>

3.2 PMWSGetMapRoute This message request will return the visual representation of a route between two points, and optionally the location of a vehicle on that route. If desired, a vehicle bitmap can be passed to be displayed on the map. The resulting MapResponse object will have ZoomLevel and CenterPoint returned to the user. The first call to PMWSGetMapRoute has to set ZoomLevel to -1. This will cause the map to be automatically adjusted to the closest zoom level to frame the trip and the new value of the ZoomLevel will be returned to the user. If the user just wishes to pan and not zoom, they can use -1 for the ZoomLevel. When making consecutive calls to PMWSGetMapRoute, the changes to the CenterPoint should be cumulative relative to the original CenterPoint and the new CenterPoint can be beyond the bounds of the map.



Elements


Required

LoginInfo LoginType structure < See Section 2.1 Y


See Section 2.2

Y


See Section 2.2 Required

TripStops A list of LocationInputType structures, in the order of when they fall in the trip, with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See Section 2.2 Ex: <TripStops> <LocationInputType> <Zip>19067</Zip> </LocationInputType> <LocationInputType> <Zip>19047</Zip> </LocationInputType> <LocationInputType> <Zip>19020</Zip> </LocationInputType> <LocationInputType> <Zip>19123</Zip> </LocationInputType> <LocationInputType> <Zip>19125</Zip> </LocationInputType> </TripStops>

Optional

TripOptions An OptionType structure

See Section 2.7 N


See Section 2.10 N

TripStopsOptimize A string containing A or All which will then re-order all of the input stops along a route in the most optimal sequence, or a string containing F or Fixed which will then re-order the input stops while

A or All F or Fixed

N



keeping the destination fixed; only valid for multiple stop trips

TripHub A string containing Y or Yes, which will request Hub routing, or N or No for standard routing; default is No

Y or Yes N or No

N

TripID A string containing an identifier; this will be echoed back in the response

Any String Ex: MyTripID

N

MapOptions MapSettingsType structure See Section 2.14 N MapCorner1 A MapPinLocation

structure which will define the upper left hand corner of the route map; the following elements will be populated PinLat and PinLong

See Section 2.13 N

MapCorner2 A MapPinLocation structure that defines the lower right hand corner of the route map; these elements will be populated: PinLat and PinLong

See Section 2.13 N

VehiclePin AMapPinLocationType structure

See Section 2.13 Conditional

VehiclePinList A list of MapPinLocationType structures

See Section 2.13 Conditional

CenterPoint MapPinLocationType structure containing the new centerpoint that frames a route on the map; the ZoomLevel must be set to use this value; ZoomLevel is a numeric value; for an initial map, set the ZoomLevel to -1 and the ZoomLevel for the map will be returned in the MapResponse; otherwise this value can be a numeric 1 to 12.

See Section 2.13 N

ZoomLevel Set to -1 for initial map (see Centerpoint above).

-1 or Valid Integer 1-12

N



RouteLegDetail A RouteLegDetail structure, for changing the appearance (e.g. color, line width) of the route on the map

See Section 2.21 N

CircleDetail (deprecated in favor of ShapeDetail)

A list of CircleDetail structures, for drawing circles on the map

See Section 2.22 N

StateHighlight A list of StateHighlightDetail structures, for highlighting states on a map

See Section 2.23 N

ShapeDetail A list of ShapeDetail structures, for drawing other shapes on the map

See Section 2.17 N

Example: For purposes of this example, the origin will be 1000 Herrontown Rd., Princeton, NJ and the destination Edison, NJ with no intervening stops. The resultant XML would appear as: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapRoute xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <Address1>1000 Herrontown Rd</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> </TripOrigin> <TripDestination> <Address1>900 Lanidex Plz</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> </TripDestination> <MapOptions> <DetailLevel>7</DetailLevel>



<MapWidth>640</MapWidth> <MapHeight>480</MapHeight> </MapOptions> <VehiclePin> <PinLat>40546119</PinLat> <PinLong>-74531008</PinLong> <Bitmap>blutruck</Bitmap> </VehiclePin> </PMWSGetMapRoute> </soap:Body> </soap:Envelope> To which, PC*MILER Web Services will give the following response: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapRouteResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetMapRouteResult> <Version>27.0.1.0</Version> <RouteMap> <ZoomLevel>0</ZoomLevel> <Origin> <Region>NA</Region> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <Juris>Mercer</Juris> <Lat>40388250</Lat> <Long>-74654726</Long> </Origin> <Destination> <Region>NA</Region> <Address1>900 Plaza Lanidex</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> <Juris>Morris</Juris> <Lat>40861341</Lat> <Long>-74420469</Long> <StopWarning>False</StopWarning> </Destination> <UpLeft> <ID>0</ID>

Did you know? 640x480 is default size of a map image unless otherwise specified.

Did you know? Premium users can request customizations to map images and icons. Please ontact ALK Sales for more info.



<PinLat>40889635</PinLat> <PinLong>-74993092</PinLong> <PinX>0</PinX> <PinY>0</PinY> </UpLeft> <LowRt> <ID>0</ID> <PinLat>40373539</PinLat> <PinLong>-74086852</PinLong> <PinX>640</PinX> <PinY>480</PinY> </LowRt>

<MapSize>387370</MapSize> <MapInfo>lots of bitmap information</MapInfo>

<Center> <ID>0</ID> <PinLat>40631587</PinLat> <PinLong>-74540484</PinLong> <PinX>320</PinX> <PinY>240</PinY> </Center> </RouteMap> </PMWSGetMapRouteResult> </PMWSGetMapRouteResponse> </soap:Body> </soap:Envelope>

PMWS GetMapRoute



3.3 PMWSGetMap There is also a generic API for requesting and manipulating maps. Depending upon the input parameters, different map images will be returned. The parameter list will define whether the returned map will be complete, or an overlay. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y MapArea A MapSettingsType structure See Section 2.14 N MapCorner1 A MapPinLocationType

structure with the following elements populated: PinX and PinY

See Section 2.13 N

MapCorner2 A MapPinLocationType structure with the following elements populated: PinX and PinY

See Section 2.13 N

MapPin A MapPinLocationType structure which will be used to display information for individual points on a map

See Section 2.13 N

MapDistrict A LocationInputType structure with the zip code element populated

See Section 2.2 N

CenterPoint A MapPinLocationType structure containing the new centerpoint of the map. The ZoomLevel must be set to use this value. ZoomLevel A numeric value for zooming a map. For an initial map set the ZoomLevel to -1 and the ZoomLevel for the map will be returned in the MapResponse. Otherwise this value can be a numeric 1 to 12.

See Section 2.13 N

ZoomLevel Set to -1 for initial map (see Centerpoint above)


N


See Section 2.23 N


See Section 2.17 N



The simplest implementation is to simply get a map area, such as an entire region. To do this, only one parameter needs to be passed, the map area: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" > <soapenv:Header/> <soapenv:Body> <PMWSGetMap xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <MapArea> <ZoomTo>8</ZoomTo> </MapArea> <MapPin> <MapPinLocationType> <PinLat>40433074</PinLat> <PinLong>-77215843</PinLong> </MapPinLocationType> </MapPin> <MapDistrict> <Region>NA</Region> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> </MapDistrict> <CenterPoint> <PinLat>40433074</PinLat> <PinLong>-77215843</PinLong> </CenterPoint> <ZoomLevel>8</ZoomLevel> </PMWSGetMap> </soapenv:Body> </soapenv:Envelope> To which the response will appear as: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetMapResult> <Version>27.0.1.0</Version>



<RouteMap> <ZoomLevel>8</ZoomLevel> <UpLeft> <ID>0</ID> <PinLat>40737202</PinLat> <PinLong>-77748323</PinLong> <PinX>0</PinX> <PinY>0</PinY> </UpLeft> <LowRt> <ID>0</ID> <PinLat>40127922</PinLat> <PinLong>-76682339</PinLong> <PinX>640</PinX> <PinY>480</PinY> </LowRt> <MapSize>200059</MapSize> <MapInfo>base64-encoded image MapInfo> <Center> <ID>0</ID> <PinLat>40433074</PinLat> <PinLong>-77215843</PinLong> <PinX>320</PinX> <PinY>240</PinY> </Center> </RouteMap> <Points> <MapPointInfo> <GroupID>-1</GroupID> <ID>0</ID> <ClassName>truck_bl</ClassName> <Devx>320</Devx> <Devy>240</Devy> <Latitude>40433074</Latitude> <Longitude>-77215843</Longitude> </MapPointInfo> </Points> </PMWSGetMapResult> </PMWSGetMapResponse> </soap:Body> </soap:Envelope>



PMWSGetMap For the user to be able to map a particular place, the lat/long information for that place must be known, possibly through the PMWSGeoCode API. At that point, all that is necessary is to send in the MapPin, but to receive a specific radius around that point a MapArea structure should also be included. The user can also request the map of an area defined by two corners on a map. To do this, the user needs to specify the upper left and lower right hand corners through the MapCorner1 and MapCorner2 parameters (which also require lat/longs). Any additional information about the map needs to be described in the MapArea parameter. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMap xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <MapArea> <MapLegend>Off</MapLegend> </MapArea> <MapCorner1> <PinLat>40880657</PinLat> <PinLong>-75020871</PinLong> /> </MapCorner1> <MapCorner2> <PinLat>40367906</PinLat> />



<PinLong>-74065792</PinLong> </MapCorner2> <MapPin> <MapPinLocationType> <PinLat>40476596</PinLat> <PinLong>-74404339</PinLong> <PinX /> <PinY /> <Bitmap /> </MapPinLocationType> </MapPin> </PMWSGetMap> </soap:Body> </soap:Envelope>

Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetMapResult> <Version>27.0.1.0</Version> <RouteMap> <ZoomLevel>0</ZoomLevel> <UpLeft> <ID>0</ID> <PinLat>40895641</PinLat> <PinLong>-75020515</PinLong> <PinX>0</PinX> <PinY>0</PinY> </UpLeft> <LowRt> <ID>0</ID> <PinLat>40351897</PinLat> <PinLong>-74065123</PinLong> <PinX>640</PinX> <PinY>480</PinY> </LowRt> <MapSize>250718</MapSize> <MapInfo>a lot of bitmap information</MapInfo> <Center> <ID>0</ID> <PinLat>40624281</PinLat> <PinLong>-74543331</PinLong>



<PinX>320</PinX> <PinY>240</PinY> </Center> </RouteMap> <Points> <MapPointInfo> <GroupID>-1</GroupID> <ID>0</ID> <ClassName>truck_bl</ClassName> <Devx>412</Devx> <Devy>370</Devy> <Latitude>40476596</Latitude> <Longitude>-74404339</Longitude> </MapPointInfo> </Points> </PMWSGetMapResult> </PMWSGetMapResponse> </soap:Body> </soap:Envelope>

Map Area Defined by Two Corners



3.4 PMWSGetETAOutOfRoute This message request will return the out of route (OoR) mileage and Estimated Time of Arrival (ETA) given a current location, for a defined route. This route will be defined by an O/D pair, with all of the standard options. More than one CurrentLocation can be provided. Elements


Required


See Section 2.1 Y


See Section 2.2 Y


See Section 2.2 Y

CurrentLocation LocationInputType structure representing the truck’s present location with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See Section 2.2 Y


See Section 2.7 N

TripID String containing an identifier; this will be echoed back in response

Any string Ex: “MyTripID”

N



This API is actually quite straightforward to use, by providing a route and a location. In return, the user will be returned the new ETA to the destination based upon the new location. In the example below, you can also see how geocoding warnings would be received when the input and the data do not exactly match. Such a request would appear as: <soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" > <soapenv:Header/> <soapenv:Body> <PMWSGetETAOutOfRoute xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> </TripOrigin> <TripDestination> <Address1>900 Lanidex Plz</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> </TripDestination> <CurrentLocation> <LocationInputType> <Address1>500 Thornall Ave</Address1> <City>Edison</City> <State>NJ</State> </LocationInputType> </CurrentLocation> </PMWSGetETAOutOfRoute> </soapenv:Body> </soapenv:Envelope> Which would receive a response of:

<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetETAOutOfRouteResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetETAOutOfRouteResult> <Version>27.0.1.0</Version>



<Report> <RptType>ETAOOR</RptType> <CurrentLocationNum>1</CurrentLocationNum> <Origin> <Region>NA</Region> <Address1>500 Thornall Street</Address1> <City>Edison</City> <State>NJ</State> <Zip>08837</Zip> <Juris>Middlesex</Juris> <Lat>40563810</Lat> <Long>-74333581</Long> <GeoWarning> <ErrorCode>1030</ErrorCode> <ErrorDesc>The street type does not match</ErrorDesc> </GeoWarning> </Origin> <Destination> <Region>NA</Region> <Address1>900 Plaza Lanidex</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> <Juris>Morris</Juris> <Lat>40861341</Lat> <Long>-74420469</Long> <StopWarning>False</StopWarning> </Destination> <EORReport> <OORLineType> <OORLineType> <SRStop> <Region>NA</Region> <Address1>500 Thornall Street</Address1> <City>Edison</City> <State>NJ</State> <Zip>08837</Zip> <Juris>Middlesex</Juris> <Lat>40563810</Lat> <Long>-74333581</Long> <GeoWarning> <ErrorCode>1030</ErrorCode> <ErrorDesc>The street type does not match</ErrorDesc> </GeoWarning> </SRStop> <LMiles>32.4</LMiles> <TMiles>32.4</TMiles>



<LCostMile>56.08</LCostMile> <TCostMile>56.08</TCostMile> <LHours>0:51</LHours> <THours>0:51</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <OORMILE>12.66</OORMILE> </OORLineType> </OORLineType> </EORReport> </Report> </PMWSGetETAOutOfRouteResult> </PMWSGetETAOutOfRouteResponse> </soap:Body> </soap:Envelope>

3.5 PMWSGetMapBreadcrumbTrail This message request will return a map image which shows the route taken by a particular truck. The user will supply the O/D pair, as well as a list of latitude/longitude pairs in millionths of degrees (see section 6.2.6) which represent the location of the truck during the trip. The API will return the map of the route, along with visual representation of the vehicle’s locations. Elements


Required

LoginInfo LoginType structure See Section 2.1 Y TripOrigin A LocationInputType

structure with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long in millionths of degrees)

See Section 2.2 Y

TripDestination A LocationInputType structure with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long in millionths of degrees)

See Section 2.2 Y



TripStops A list of LocationInputType structures, in the order of when they fall in the trip, with the following elements populated: (City and State) or Zip or Place or (Lat and Long)

See Section 2.2 N


See Section 2.7 N

Breadcrumb LocationInputType structure with Lat and Long populated; this structure should repeat to give an adequate representation of the truck’s route.

See Section 2.2 Y

TripID A string containing an identifier; this will be echoed back in the response.


N

MapArea MapSettingsType structure where the appearance of the map can be customized.

See Section 2.14 N

MapCorner1 MapPinLocation structure which will define the upper left hand corner of the route map; the following elements will be populated PinLat and PinLong.

See Section 2.13 N

MapCorner2 MapPinLocation structure which will define the lower right hand corner of the map; the following elements will be populated PinLat and PinLong.

See Section 2.13 N

CenterPoint MapPinLocationType structure containing

See Section 2.13 N



the new centerpoint of the map. The ZoomLevel must be set to use this value. ZoomLevel A numeric value for zooming a map. For an initial map set the ZoomLevel to -1 and the ZoomLevel for the map will be return in the MapResponse. Otherwise this value can be a numeric value from 1 to 12.

ZoomLevel Set to -1 for initial map (see Centerpoint above)


N


See Section 2.21 N

CircleDetail (deprecated in favor of ShapeDetail)

A list of CircleDetail structures, for drawing circles on the map

See Section 2.22 N


See Section 2.23 N


See Section 2.17 N

An example of this straightforward API call would appear as follows:

<?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body>



<PMWSGetMapBreadcrumbTrail xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripOrigin> <Address1>1000 Herrontown Rd</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <SCost> <CostOfStop>1.00</CostOfStop> <HoursPerStop>1.25</HoursPerStop> </SCost> </TripOrigin> <TripDestination> <Address1>900 Lanidex Plz</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> </TripDestination> <Breadcrumb> <LocationInputType> <Lat>40424326</Lat> <Long>-74653116</Long> </LocationInputType> </Breadcrumb> <MapArea> <ZoomRad>3</ZoomRad> <DetailLevel>7</DetailLevel> <MapWidth>400</MapWidth> <MapHeight>345</MapHeight> <MapLegend>Off</MapLegend> </MapArea> </PMWSGetMapBreadcrumbTrail> </soap:Body> </soap:Envelope> To which the service will respond with: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapBreadcrumbTrailResponse xmlns="http://localhost/PCMilerWS/">



<PMWSGetMapBreadcrumbTrailResult> <Version>27.0.1.0</Version> <RouteMap> <ZoomLevel>0</ZoomLevel> <Origin> <Region>NA</Region> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <Juris>Mercer</Juris> <Lat>40388250</Lat> <Long>-74654726</Long> </Origin> <Destination> <Region>NA</Region> <Address1>900 Plaza Lanidex</Address1> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> <Juris>Morris</Juris> <Lat>40861341</Lat> <Long>-74420469</Long> <StopWarning>False</StopWarning> </Destination> <UpLeft> <ID>0</ID> <PinLat>40888611</PinLat> <PinLong>-74933700</PinLong> <PinX>0</PinX> <PinY>0</PinY> </UpLeft> <LowRt> <ID>0</ID> <PinLat>40373539</PinLat> <PinLong>-74146244</PinLong> <PinX>400</PinX> <PinY>345</PinY> </LowRt> <MapSize>210242</MapSize> <MapInfo>a lot of bitmap information</MapInfo>

<Center> <ID>0</ID> <PinLat>40631587</PinLat> <PinLong>-74540484</PinLong> <PinX>200</PinX> <PinY>172</PinY>



</Center> </RouteMap> </PMWSGetMapBreadcrumbTrailResult> </PMWSGetMapBreadcrumbTrailResponse> </soap:Body> </soap:Envelope>

Lat/Long Ping on Map

3.6 PMWSSetMapCustomPlace NOTE: This feature is not currently supported in map data outside of North America. This message request will store the location information, and return a map showing the point. Those actions do not have to happen at the same time, and depending upon the input, the user can choose which action is to take place. Any custom places will be visible at the account level, not just at the log-in level. Elements


Required

LoginInfo LoginType structure See Section 2.1 Y PlaceLocation LocationInputType structure

containing both geocoding See Section 2.2 Y

Did you know? This green square represents a lat/long ping.



information and a PlaceName identifier

PlaceMap A MapSettingsType structure; this can be used to customize the map.

See Section 2.14 N

PlaceAction A string that will create the custom place using “Set”, or will create the custom place and return a map of it using “Map”, or will delete it using “Delete”.

Set, Map, Delete Y

This API has two functionalities which may, or may not, be used simultaneously. For the simplest functionality – setting a custom place – PlaceLocation and PlaceAction need to be sent. PlaceLocation will contain both the geocoding information, as well as the custom place name, and the PlaceAction needs to be set. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> < PMWSSetMapCustomPlace xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <PlaceLocation> <Address1>20 Sunset rd</Address1> <Address2 /> <City>Belle Mead</City> <State>NJ</State> <Zip>08502</Zip> <PlaceName>Office1</PlaceName> </PlaceLocation> <PlaceMap> <ZoomRad>10</ZoomRad> </PlaceMap> <PlaceAction>set</PlaceAction> </ PMWSSetMapCustomPlace > </soap:Body> </soap:Envelope>



Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSSetMapCustomPlaceResponse xmlns="http://localhost/PCMilerWS/"> <PMWSSetMapCustomPlaceResult/> </PMWSSetMapCustomPlaceResponse> </soap:Body> </soap:Envelope> If the user wishes to also display the new point when setting it the PlaceAction needs to be map, and PlaceMap can also be sent if there is to be any customization of the map. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapCustomPlace xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <PlaceLocation> <Address1>20 Sunset rd</Address1> <Address2 /> <City>Belle Mead</City> <State>NJ</State> <Zip>08502</Zip> <PlaceName>Office1</PlaceName> </PlaceLocation> <PlaceMap> <ZoomRad>10</ZoomRad> </PlaceMap> <PlaceAction>map</PlaceAction> </PMWSGetMapCustomPlace> </soap:Body> </soap:Envelope>



Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSSetMapCustomPlaceResponse xmlns="http://localhost/PCMilerWS/"> <PMWSSetMapCustomPlaceResult> <RouteMap> <ZoomLevel>8</ZoomLevel> <UpLeft> <ID>0</ID> <PinLat>40628656</PinLat> <PinLong>-74996792</PinLong> <PinX>0</PinX> <PinY>0</PinY> </UpLeft> <LowRt> <ID>0</ID> <PinLat>40248240</PinLat> <PinLong>-74330168</PinLong> <PinX>640</PinX> <PinY>480</PinY> </LowRt> <MapSize>253011</MapSize> <MapInfo>a lot of bitmap information</MapInfo> <Center> <ID>0</ID> <PinLat>40438704</PinLat> <PinLong>-74663480</PinLong> <PinX>320</PinX> <PinY>240</PinY> </Center> </RouteMap> </PMWSSetMapCustomPlaceResult> </PMWSSetMapCustomPlaceResponse> </soap:Body> </soap:Envelope>



Custom Place (“Office 1”)

3.7 PMWSGetCustomPlace This message request will return the user’s stored custom places. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y An example of this API’s use is as follows: <?xml version="1.0" encoding="utf-16" ?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetCustomPlace xmlns="http://localhost/PCMilerWS/">

<LoginInfo> </UserID> </Password> </Account>

</LoginInfo> </PMWSGetCustomPlace> </soap:Body> </soap:Envelope>

Here’s your custom place.



Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetCustomPlaceResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetCustomPlaceResult> <Version>27.0.1.0</Version> <CustPlaceList> <LocationOutputType> <Address1/> <City>Cape Vincent</City> <State>NY</State> <Zip>13618</Zip> <PlaceName>Cape Vincent, NY</PlaceName> </LocationOutputType> <LocationOutputType> <Address1>2 East Center Street</Address1> <City>Cedar City</City> <State>UT</State> <Zip>84720</Zip> <PlaceName>Cedar, UT</PlaceName> </LocationOutputType> <LocationOutputType> <Address1/> <City>Chicken</City> <State>AK</State> <Zip>99732</Zip> <PlaceName>Chicken, AK</PlaceName> </LocationOutputType> <LocationOutputType> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <PlaceName>LLC</PlaceName> </LocationOutputType> <LocationOutputType> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <PlaceName>LLRR</PlaceName> </LocationOutputType> <LocationOutputType> <Address1>1000 Herrontown Road</Address1>



<City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <PlaceName>Office</PlaceName> </LocationOutputType> <LocationOutputType> <Address1>20 Sunset Road</Address1> <City>Belle Mead</City> <State>NJ</State> <Zip>08502</Zip> <PlaceName>Office1</PlaceName> </LocationOutputType> <LocationOutputType> <Address1>70 Bradford Lane</Address1> <City>Plainsboro</City> <State>NJ</State> <Zip>08536</Zip> <PlaceName>OHS</PlaceName> </LocationOutputType> <LocationOutputType> <Address1/> <City>Philadelphia</City> <State>PA</State> <Zip>19116</Zip> <PlaceName>Philly, PA</PlaceName> </LocationOutputType> <LocationOutputType> <Address1/> <City>Trenton</City> <State>NJ</State> <Zip>08619</Zip> <PlaceName>Trenton, NJ</PlaceName> </LocationOutputType> </CustPlaceList> </PMWSGetCustomPlaceResult> </PMWSGetCustomPlaceResponse> </soap:Body> </soap:Envelope>



3.8 PMWSSetAvoidFavor NOTE: This feature is not currently supported in map data outside of North America. This message request will set road and routing preferences. It can be used to either avoid/favor an entire state, or an entire road within a state. It will not be used for avoiding or favoring single strings of road segments. Any preference set for avoiding and favoring roads will be visible at the account level, not just at the log-in level. Elements


Required


See Section 2.1 Y

AFLoc AvoidFavorType structure

See XML below table

State

The state where the road is that you want to avoid/ favor. If the road is not specified, it can be used to avoid/favor the entire state.

A valid state name. Ex: PA

Y

Road The roadway to avoid/favor in the state specified

A valid road name that exists in the state specified. Ex: US-1

N

Action

“A”void or “F”avor the state/road.

A or F Y

Label String used to identify location to avoid/favor

Any String Ex: “MyFavorite”

N

AFInstance Number of avoids/favors being requested; default = 1

An integer corresponding to the number of requests you are submitting to be avoided/favored. Ex: 1

N

An example of this APIs use is as follows: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSSetAvoidFavor xmlns="http://localhost/PCMilerWS/">



<LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <AFLoc> <AvoidFavorType> <State>NJ</State> <Road>Route 80</Road> <Action>A</Action> </AvoidFavorType> <AvoidFavorType> <State>NJ</State> <Road>Route 287</Road> <Action>A</Action> </AvoidFavorType> </AFLoc> <AFInstance>2</AFInstance> </PMWSSetAvoidFavor> </soap:Body> </soap:Envelope> Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSSetAvoidFavorResponse xmlns="http://localhost/PCMilerWS/"> <PMWSSetAvoidFavorResult/> </PMWSSetAvoidFavorResponse> </soap:Body> </soap:Envelope>

3.9 PMWSGetAvoidFavor This message request will allow the user to request the avoid/favors settings currently associated with the account. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y AFReqType A string defining which A, F, B Y



types are to be returned; A or Avoids, F or Favors, B or Both

AFLabel A string defining which labeled list is to be returned; if this is blank, then the unlabeled avoids, or favors, will be sent.

Label used to set Avoid/Favor Ex: MyFavorite

N

An example of using this API is as follows: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetAvoidFavor xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID/> <Password/> <Account/> </LoginInfo> <AFReqType>b</AFReqType> </PMWSGetAvoidFavor> </soap:Body> </soap:Envelope> Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetAvoidFavorResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetAvoidFavorResult> <Version>27.0.1.0</Version> <AFList> <AvoidFavorType> <State>NJ</State> <Road>20130</Road> <Action>F</Action> <Label>Test2</Label> </AvoidFavorType> </AFList> </PMWSGetAvoidFavorResult>



</PMWSGetAvoidFavorResponse> </soap:Body> </soap:Envelope>

3.10 PMWSSetRoadSpeed NOTE: This feature is not currently supported in map data outside of North America. This message request will set speeds for different road types within a state. Because a customer may have a large number of changes the input for this function can be batched. All road speed modifications will be visible at the account level, not just the log-in level. Elements


Required


See Section 2.1 Y

RSLoc RoadSpeedType structure

See XML below Y

State Valid 2-digit state abbrev

Valid State Ex: PA

Y

RoadType The road type that you would like to specify the speed of

InterstateU, InterstateR, DividedU, DividedR, PrimaryU, PaimaryR, SecondaryU, SecondaryR, LocalU, LocalR, FerriesU, FerriesR

Y

Speed The speed you would like to specify for the RoadType

Valid Integer Ex: 65

Y

RSInstance Number of road speeds being modified; default=1

An integer corresponding to the number of road speed values you are setting. Ex: 1

N

An example of using this API is as follows: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSSetRoadSpeed xmlns="http://localhost/PCMilerWS/">



<LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <RSLoc> <State>NJ</State> <RoadType>SecondaryR</RoadType> <Speed>65</Speed> </RSLoc> </PMWSSetRoadSpeed> </soap:Body> </soap:Envelope> Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSSetRoadSpeedResponse xmlns="http://localhost/PCMilerWS/"> <PMWSSetRoadSpeedResult/> </PMWSSetRoadSpeedResponse> </soap:Body> </soap:Envelope>

3.11 PMWSGetRoadSpeed This message request will retrieve speeds associated with the user’s account for different road classes within a state. Elements


Required


See Section 2.1 Y

State A string defining what state is being requested

State that you have set the speed for Ex: PA

Y



An example of using this API is as follows: <?xml version="1.0" encoding="utf-16" ?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetRoadSpeed xmlns="http://localhost/PCMilerWS/">

<LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account>

</LoginInfo> <state>pa</state>

</PMWSGetRoadSpeed> </soap:Body> </soap:Envelope> Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetRoadSpeedResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetRoadSpeedResult> <Version>27.0.1.0</Version> <RSList> <RoadSpeedType> <State>pa</State> <RoadType>interStateR</RoadType> <Speed>65</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>dividedr</RoadType> <Speed>60</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>primaryr</RoadType> <Speed>50</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>ferriesr</RoadType>



<Speed>15</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>secondaryr</RoadType> <Speed>45</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>localr</RoadType> <Speed>35</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>interStateU</RoadType> <Speed>30</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>dividedu</RoadType> <Speed>40</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>primaryu</RoadType> <Speed>35</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>ferriesu</RoadType> <Speed>15</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>secondaryu</RoadType> <Speed>35</Speed> </RoadSpeedType> <RoadSpeedType> <State>pa</State> <RoadType>localu</RoadType> <Speed>25</Speed> </RoadSpeedType> </RSList> </PMWSGetRoadSpeedResult> </PMWSGetRoadSpeedResponse> </soap:Body> </soap:Envelope>



3.12 PMWSGeoCode This message request will be used for various geocoding functions, for which there are primarily three: address validation, lat/long to city/state conversion, and city/state to lat/long conversion. The user will have the ability to do both pick-list and best match styles of geocoding, as well as being able to do batch geocoding.

The address validation has two levels of functionality: verification and geocoding. If verification is chosen, then the geocoder will check to see if enough address information is provided to create an exact match. If geocode is chosen, then the geocoder will actually find a location for the input address. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y GeoLoc A GeoLocType containing

the information associated with the address to be geocoded

See Section 2.18 Y

GeoInstance The number of addresses to be geocoded; this cannot be greater than 1 if GeoList (in the GeoLoc structure) is Yes; default is 1.

Valid Integer Ex: 1

Conditional

As this API has wide ranging functionality, there are a number of scenarios to be outlined. These are two samples of geocoding an address – one with the GeoList set to yes, and one without: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGeoCode xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <GeoLoc> <GeoLocType> <GeoAddress> <Address1>1000 slocum ave</Address1> <City>Ridgefield</City> <State>NJ</State> </GeoAddress>



</GeoLocType> </GeoLoc> <GeoType>G </GeoType> <GeoList>Yes</GeoList> </PMWSGeoCode> </soap:Body> </soap:Envelope> With a response of: <?xml version="1.0" encoding="utf-8"?> <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <PMWSGeoCodeResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGeoCodeResult> <ReportResponse> <Version>.07</Version> <Report> <Geocode> <LocationInputType> <Region>NA</Region> <Address1>900-999 Slocum Avenue</Address1> <City>RIDGEFIELD</City> <State>NJ</State> <Zip /> <Juris>Bergen</Juris> <Lat>40837852</Lat> <Long>-74003928</Long> </LocationInputType> <LocationInputType> <Region>NA</Region> <Address1>1022-1110 Slocum Avenue</Address1> <City>RIDGEFIELD</City> <State>NJ</State> <Zip /> <Juris>Bergen</Juris> <Lat>40839996</Lat> <Long>-74007248</Long> </LocationInputType> <LocationInputType> <Region>NA</Region> <Address1> Slocum Avenue & Abbott Avenue</Address1> <City>RIDGEFIELD</City> <State>NJ</State> <Zip /> <Juris>Bergen</Juris> <Lat>40836484</Lat>



<Long>-74001760</Long> </LocationInputType> </Geocode> </Report> </ReportResponse> </PMWSGeoCodeResult> </PMWSGeoCodeResponse> </soap:Body> But without a pick list: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGeoCode xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <GeoAddress> <LocationInputType> <Address1>1000 slocum ave</Address1> <City>Ridgefield</City> <State>NJ</State> </LocationInputType> </GeoAddress> <GeoType>G</GeoType> <GeoList>No</GeoList> </PMWSGeoCode> </soap:Body> </soap:Envelope> Will receive a response of: <?xml version="1.0" encoding="utf-8"?> <soap:Body xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"> <PMWSGeoCodeResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGeoCodeResult> <ReportResponse> <Version>.07</Version> <ErrorList> <ErrorType>



<ErrorCode>1070</ErrorCode> <ErrorDesc>Address number out of range</ErrorDesc> </ErrorType> </ErrorList> <Report> <Geocode> <LocationInputType> <Region>NA</Region> <Address1>900-999 Slocum Avenue</Address1> <City>Ridgefield</City> <State>NJ</State> <Zip>07657</Zip> <Juris /> <Lat>40837852</Lat> <Long>-74003928</Long> </LocationInputType> </Geocode> </Report> </ReportResponse> </PMWSGeoCodeResult> </PMWSGeoCodeResponse> </soap:Body> This is an example of “city to lat/long” functionality: <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGeoCode xmlns="http://localhost/PCMilerWS/"> <LoginInfo <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <GeoLoc> <GeoLocType> <GeoAddress> <Address1>1000 Herrontown Rd</Address1> <City>Princeton</City> <State>NJ</State> </GeoAddress> </GeoLocType> </GeoLoc> <GeoType>A2L</GeoType>



</PMWSGeoCode> </soap:Body> </soap:Envelope> Which will receive a response of: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGeoCodeResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGeoCodeResult> <ReportResponse> <Version>27.0.1.0</Version> <Report> <Geocode> <LocationOutputType> <Region>NA</Region> <Address1>1000 Herrontown Road</Address1> <City>Princeton</City> <State>NJ</State> <Zip>08540</Zip> <Juris>Mercer</Juris> <PlaceName/> <Lat>40388250</Lat> <Long>-74654726</Long> </LocationOutputType> </Geocode> </Report> </ReportResponse> </PMWSGeoCodeResult> </PMWSGeoCodeResponse> </soap:Body> </soap:Envelope>

3.13 PMWSRadiusSearch This message request will be used to find Points of Interest (POIs) within a radius of miles from a central point. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y RadLoc A LocationInputType structure See Section 2.2 Y



containing the information associated with the address which will act as the center of the search radius

RadDist A numeric representing the radius miles to be searched

Valid decimal Ex: 1.5

Y

RadType A PointSearchType structure containing the types of locations to be searched for

See Section 2.19 Y

Below is an example of requesting some standard truck related information. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSRadiusSearch xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <RadLoc> <Zip>08540</Zip> <SCost> </SCost> </RadLoc> <RadDist>10</RadDist> <RadType> <POICat>y</POICat> <POITruck>y</POITruck> <POIWS>y</POIWS> </RadType> <RadPlot>y</RadPlot> </PMWSRadiusSearch> </soap:Body> </soap:Envelope> Which will receive a response of the following. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSRadiusSearchResponse xmlns="http://localhost/PCMilerWS/">



<PMWSRadiusSearchResult> <Version>27.0.1.0</Version> <Report> <RadReport> <RadiusReportType> <RadLoc> <Address1/> <City>@Johns T/S (Lawrenceville)</City> <State>NJ</State> <Zip/> <Juris/> <PlaceName>@Johns T/S (Lawrenceville), NJ</PlaceName> <Lat>40291546</Lat> <Long>-74686842</Long> </RadLoc> <RadDist>4.21055362965634</RadDist> </RadiusReportType> <RadiusReportType> <RadLoc> <Address1/> <City>@Mobil GAS Station (Monmouth Ju</City> <State>NJ</State> <Zip/> <Juris/> <PlaceName>@Mobil GAS Station (Monmouth Ju, NJ</PlaceName> <Lat>40376940</Lat> <Long>-74582500</Long> </RadLoc> <RadDist>4.47369305318777</RadDist> </RadiusReportType> <RadiusReportType> <RadLoc> <Address1>23 Orchard Rd # 3</Address1> <City>Skillman</City> <State>NJ</State> <Zip/> <Juris/> <PlaceName>Blue Beacon Capital: 23 Orchard Rd # 3, Skillman, NJ</PlaceName> <Lat>40415678</Lat> <Long>-74655089</Long> </RadLoc> <RadDist>4.62743973090305</RadDist> </RadiusReportType> </RadReport> </Report> </PMWSRadiusSearchResult>



</PMWSRadiusSearchResponse> </soap:Body> </soap:Envelope>

3.14 PMWSReduceTrip This message request will return a trip based upon a series of lat/long pings. Elements


Required

LoginInfo A LoginType structure See Section 2.1

Y

TripPing A LocationInputType structure with the following elements populated: Lat and Long; this structure must repeat.

See Section 2.2 Ex: <LocationInputType>

<Lat>40.368406</Lat>

<Long>-74.654882</Long>

</LocationInputType>

<LocationInputType>

<Lat>39.966737</Lat>

<Long>-75.140148</Long>

</LocationInputType>

</TripPing>

Y

OffRouteMiles A string describing the number of miles to be used in calculating the “window” for the lat/long pings

Valid decimal Ex: 5.5

Y

HighwayOnly Yes – highway routing and No – street routing; this is an optional field with the default being highway routing (yes). (in North America)

Y or N N

ReportType m or miles for the mileage report between the two points; d or detail to also include detailed information.

m or M or miles, d or D or detail

Y

Below is an example of requesting a trip using PMWSReduceTrip. <?xml version="1.0" encoding="utf-16"?>



<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSReduceTrip xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> </LoginInfo> <TripPing> <LocationInputType> <Lat>40.562n</Lat> <Long>74.336w</Long> </LocationInputType> <LocationInputType> <Lat>40.543n</Lat> <Long>74.364w</Long> </LocationInputType> <LocationInputType> <Lat>40.531n</Lat> <Long>74.371w</Long> </LocationInputType> <LocationInputType> <Lat>40.527n</Lat> <Long>74.337w</Long> </LocationInputType> <LocationInputType> <Lat>40.516n</Lat> <Long>74.357w</Long> </LocationInputType> <LocationInputType> <Lat>40.496n</Lat> <Long>74.385w</Long> </LocationInputType> <LocationInputType> <Lat>40.474n</Lat> <Long>74.408w</Long> </LocationInputType> <LocationInputType> <Lat>40.447n</Lat> <Long>74.422w</Long> </LocationInputType> </TripPing> <OffRouteMiles>.5</OffRouteMiles> <HighwayOnly>n</HighwayOnly> <ReportType>m</ReportType>



</PMWSReduceTrip> </soap:Body> </soap:Envelope> Which will receive a response of the following. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSReduceTripResponse xmlns="http://localhost/PCMilerWS/"> <PMWSReduceTripResult> <Version>27.0.1.0</Version> <Report> <RptType>m</RptType> <StopNum>2</StopNum> <MilesReport> <StpLineType> <SRStop> <Region>NA</Region> <Address1>169 Lincoln Highway</Address1> <City>Edison</City> <State>NJ</State> <Zip>08820</Zip> <Juris>Middlesex</Juris> <Lat>40562000</Lat> <Long>-74336000</Long> </SRStop> <LMiles>0.0</LMiles> <TMiles>0.0</TMiles> <LCostMile>0.00</LCostMile> <TCostMile>0.00</TCostMile> <LHours>0:00</LHours> <THours>0:00</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>0.0</LEstghg> <TEstghg>0.0</TEstghg> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1>NJ Turnpike Car-Truck Lane</Address1> <City>Edison</City> <State>NJ</State> <Zip>08837</Zip>



<Juris>Middlesex</Juris> <Lat>40527000</Lat> <Long>-74337000</Long> <StopWarning>False</StopWarning> </SRStop> <LMiles>6.7</LMiles> <TMiles>6.7</TMiles> <LCostMile>11.74</LCostMile> <TCostMile>11.74</TCostMile> <LHours>0:11</LHours> <THours>0:11</THours> <LTolls>0.00</LTolls> <TTolls>0.00</TTolls> <LEstghg>24.8</LEstghg> <TEstghg>24.8</TEstghg> </StpLineType> <StpLineType> <SRStop> <Region>NA</Region> <Address1>1 Cotters Lane</Address1> <City>East Brunswick</City> <State>NJ</State> <Zip>08816</Zip> <Juris>Middlesex</Juris> <Lat>40447000</Lat> <Long>-74422000</Long> <StopWarning>False</StopWarning> </SRStop> <LMiles>16.2</LMiles> <TMiles>22.9</TMiles> <LCostMile>31.87</LCostMile> <TCostMile>43.62</TCostMile> <LHours>0:23</LHours> <THours>0:34</THours> <LTolls>5.40</LTolls> <TTolls>5.40</TTolls> <LEstghg>59.8</LEstghg> <TEstghg>84.6</TEstghg> </StpLineType> </MilesReport> </Report> </PMWSReduceTripResult> </PMWSReduceTripResponse> </soap:Body> </soap:Envelope>



3.15 PMWSGetMapRoutes This message request will return the visual representation of a number of routes. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y TripOrigin A list of LocationInputType

structures with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See Section 2.2 Y

TripDestination A list of LocationInputType structures with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See Section 2.2 Y

TripStops Jjagged array (two dimensional) of LocationInputType structures, in the order of when they fall in the trip, with the following elements populated: (City and State) or ZIP/Postal Code or Place or (Lat and Long)

See Section 2.2 Ex: <TripStops> <LocationInputType> <Zip>19067</Zip> </LocationInputType> <LocationInputType> <Zip>19047</Zip> </LocationInputType> <LocationInputType> <Zip>19020</Zip> </LocationInputType> <LocationInputType> <Zip>19123</Zip> </LocationInputType> <LocationInputType> <Zip>19125</Zip> </LocationInputType> </TripStops>

N

TripOptions A list of OptionsType structures

See Section 2.7 N


See Section 2.10 N

TripStopsOptimize String containing A or All which will re-order all of the input stops in the most optimal sequence, or a string containing F or Fixed which will then re-order the input stops while keeping the destination fixed; only valid for multiple stop trips

A or All F or Fixed

N

TripHub A string containing Y or Yes, which will request

Y or Yes N or No

N



Hub routing, or N or No for standard routing; default is No.

TripID An array of strings containing an identifier; this will be echoed back in the response.


N

MapOptions A MapSettingsType structure See Section 2.14 N MapCorner1 A MapPinLocation structure

which will define the upper left hand corner of the route map; the following elements will be populated PinLat and PinLong.

See Section 2.13 N

MapCorner2 A MapPinLocation structure which will define the lower right hand corner of the route map; the following elements will be populated PinLat and PinLong.

See Section 2.13 N

VehiclePin A MapPinLocationType structure See Section 2.13 N VehiclePinList a list of MapPinLocationType

structures See Section 2.13 N

LeastCost A string Y or Yes which will request least cost routing, or N or No; the default is No.

Y or Yes, N or No

N

CenterPoint A MapPinLocationType structure containing the new centerpoint of the map; the ZoomLevel must be set to use this value.

See Section 2.13 N

ZoomLevel A numeric value for zooming a map. For an initial map, set the ZoomLevel to -1 and the ZoomLevel for the map will be returned in the MapResponse.


N


See Section 2.21 N

CircleDetail A list of CircleDetail structures, for drawing circles on the map

See Section 2.22 N


See Section 2.23 N


See Section 2.17 N



Below is an example of requesting a trip using PMWSGetMapRoutes. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapRoutes xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> <Feature /> </LoginInfo> <TripOrigin> <LocationInputType> <Zip>08540</Zip> </LocationInputType> <LocationInputType> <Zip>08852</Zip> </LocationInputType> </TripOrigin> <TripDestination> <LocationInputType> <Zip>08837</Zip> </LocationInputType> <LocationInputType> <Zip>07054</Zip> </LocationInputType> </TripDestination> <TripOptions> <OptionsType> <DataVer /> <VehicleType /> <RoutingType /> <HighwayOnly /> <FuelRoute /> <CustRoad /> <ClassOverrides /> <Units /> <FuelUnits /> <TollDiscourage /> <TollData /> <BordersOpen /> <OverrideRestrict /> <HazMatType /> <TripCosts>



<LoadedPerMile /> <UnlPerMile /> <MPGLoaded /> <MPGEmpty /> <PricePerGallon /> <GreenHouseGas /> <MaintenanceCostLoaded /> <MaintenanceCostEmpty /> <CostTimeLoaded /> <CostTimeEmpty /> </TripCosts> </OptionsType> <OptionsType> <DataVer /> <VehicleType /> <RoutingType /> <HighwayOnly /> <FuelRoute /> <CustRoad /> <ClassOverrides /> <Units /> <FuelUnits /> <TollDiscourage /> <TollData /> <BordersOpen /> <OverrideRestrict /> <HazMatType /> <TripCosts> <LoadedPerMile /> <UnlPerMile /> <MPGLoaded /> <MPGEmpty /> <PricePerGallon /> <GreenHouseGas /> <MaintenanceCostLoaded /> <MaintenanceCostEmpty /> <CostTimeLoaded /> <CostTimeEmpty /> </TripCosts> <TimeCost> <DepartTime /> <BreakInterval /> <BreakLength /> <BorderWait /> </TimeCost> <TruckCfg> <Units />



<Height /> <Length /> <Width /> <Weight /> <Axles /> <LCV /> </TruckCfg> <Lang /> <InclFerryDist /> </OptionsType> </TripOptions> <TripStopsOptimize /> <TripHub /> <TripID /> <MapOptions> <ZoomTo /> <ZoomRad /> <Region /> <DetailLevel /> <MapWidth /> <MapHeight /> <Drawer /> <MapLegend /> <MapMult /> <OversizeMap /> <MapLegendDrawer /> <StopLabelDrawer /> </MapOptions> <RouteInstance>2</RouteInstance> <LeastCost /> </PMWSGetMapRoutes> </soap:Body> </soap:Envelope> Which will receive a response of the following. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetMapRoutesResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetMapRoutesResult> <Version>27.0.1.0</Version> <RouteMap> <ZoomLevel>0</ZoomLevel> <Origin>



<Region>NA</Region> <Address1/> <City>Monmouth Junction</City> <State>NJ</State> <Zip>08852</Zip> <Juris>Middlesex</Juris> <Lat>40378999</Lat> <Long>-74546541</Long> </Origin> <Destination> <Region>NA</Region> <Address1/> <City>Parsippany</City> <State>NJ</State> <Zip>07054</Zip> <Juris>Morris</Juris> <Lat>40857159</Lat> <Long>-74426298</Long> <StopWarning>False</StopWarning> </Destination> <TripID/> <UpLeft> <ID>0</ID> <PinLat>40870847</PinLat> <PinLong>-74995409</PinLong> <PinX>0</PinX> <PinY>0</PinY> </UpLeft> <LowRt> <ID>0</ID> <PinLat>40343487</PinLat> <PinLong>-74068689</PinLong> <PinX>640</PinX> <PinY>480</PinY> </LowRt> <MapSize>341424</MapSize> <MapInfo>lots of bitmap info… </MapInfo> <Center> <ID>0</ID> <PinLat>40607679</PinLat> <PinLong>-74532561</PinLong> <PinX>320</PinX> <PinY>240</PinY> </Center> </RouteMap> </PMWSGetMapRoutesResult> </PMWSGetMapRoutesResponse>



</soap:Body> </soap:Envelope>

3.16 PMWSGetStates This message request will retrieve a list of states or countries in the specified region. This API will accept the region as the input and will return a list of states or countries for that region. If the region is NA (North America), the state abbreviation and the full state name are filled in, as well as the country abbreviation and the full country name. Outside of NA, only the country abbreviation and the full country name are filled in. The state and the country codes will be retrieved through the LocationOutputType structure. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y Region A string representing the region

for which the list of states or countries is to be retrieved. NA (North America) is the default.

NA (North America), SA (South America), EU (Europe), AS (Asia), AF (Africa), OC (Oceania).

N

AbbreviationFormat

A string representing the format for country abbreviations to be used. Fips2 is the default.

Fips2, Iso2, Iso3, Genc2, or Genc3

N

CountryOnly True or False depending on whether only the country information should be return

True or False N

Below is an example of requesting a trip using PMWSGetStates. <?xml version="1.0" encoding="utf-16"?> <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetStates xmlns="http://localhost/PCMilerWS/"> <LoginInfo> <UserID>ThatUser</UserID> <Password>Password1</Password> <Account>12345</Account> <Feature /> </LoginInfo> <Region /> <AbreviationFormat />



</PMWSGetStates> </soap:Body> </soap:Envelope> Which will receive a response of the following. <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <soap:Body> <PMWSGetStatesResponse xmlns="http://localhost/PCMilerWS/"> <PMWSGetStatesResult> <ReportResponse> <Report> <Geocode> <LocationOutputType> <State>AL</State> <Country>U</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> <ReportResponse> <Report> <Geocode> <LocationOutputType> <State>AK</State> <Country>U</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> … <ReportResponse> <Report> <Geocode> <LocationOutputType> <State>ND</State> <Country>U</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> <ReportResponse> <Report> <Geocode>



<LocationOutputType> <State>OH</State> <Country>U</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> <ReportResponse> <Report> <Geocode> <LocationOutputType> <State>OK</State> <Country>U</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> <ReportResponse> <Report> <Geocode> <LocationOutputType> <State>YC</State> <Country>M</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> <ReportResponse> <Report> <Geocode> <LocationOutputType> <State>ZT</State> <Country>M</Country> </LocationOutputType> </Geocode> </Report> </ReportResponse> </PMWSGetStatesResult> </PMWSGetStatesResponse> </soap:Body> </soap:Envelope>



3.17 PMWSAbout This message request will return the software interface version number. This new API will return the major version of the software interface. The format is xx.x where the first token preceding the period is the major release version (ex. 24) and the second token is either .0 or .1. To access the Worldwide Release, use .1 as the second token and the base release will have .0. There are no other parameters other than LoginInfo as the user’s credentials contained in LoginType will be sufficient. Elements


Required

LoginInfo A LoginType structure See Section 2.1 Y

3.18 RequestHeader This structure will be added to a subset of APIs to facilitate authentication from the PC*MILER Web Services graphical user interface. PC*MILER Web Services users do not need to fill this structure. This structure is added to the following APIs: PMWSGeocode PMWSGetMapRoute PMWSGetMapRoutes PMWSGetReport PMWSGetRoadSpeed PMWSGetStates PMWSSetMapCustomPlace PMWSSetRoadSpeed

Elements

Element Definition

Token A token string Abstract:

<xsd:complexType name=”RequestHeader”>

<xsd:sequence> <xsd:element name=”Token” type=”s:string” />


| 132


Below are the actual definitions associated with the structures which will be returned by the various APIs.

Output Structure Exposed Per Feature Option Access to the output structures described in this chapter is determined by your Feature Option Level. For more details, refer to section 1.1, PC*MILER Web Services Feature Option Levels.

OUTPUT STRUCTURE

Lite Standard Premium Enterprise Standard-Worldwide

Premium-Worldwide

ErrorType ErrorListType LocationOutputType DirLineType DirStructType DtlLineType DtlStructType StpLineType OORLineType EORStructType SCLineType StStructType RoadLineType FuelStopLine FuelSummaryType FuelReportType RadiusReportType ReportType MapType

Chapter 4: Output Structure Definitions

Chapter 4: Output Structure Definitions | 133


4.1 ErrorType This is the granular representation of error information. This structure defines the elements which will be returned in the ErrorListType structure. Elements

Element Definition ErrorCode A numeric representation of the error in general ErrorDesc A string giving a specific description of the error

Abstract <xsd:complexType name=”ErrorType”> <xsd:sequence> <xsd:element name=”ErrorCode” type=”xsd:string” /> <xsd:element name="ErrorDesc" type="xsd:string" /> </xsd:sequence> </xsd:complexType>

4.2 ArrayOfErrorType This is the broader representation of error information to be passed back to the requesting system. This structure may be returned as a result of any API call, and may be accompanied by other structures. If the error returned signifies something which stopped the API call from completing, then this structure will be returned alone. If this structure is representing a warning – generally for geocoding – the appropriate structure for the API response will accompany this one. Elements

Element Definition ErrorType An ErrorType structure; this may repeat

Abstract <xsd:complexType name=”ArrayOfErrorType”> <xsd:sequence> <xsd:element name="Errors" type="ErrorType" /> </xsd:sequence> </xsd:complexType>



4.3 LocationOutputType The LocationOutputType structure will be used to pass all data associated with a geographic point. It may be either address, or lat/long, information. This structure is embedded within other structure definitions and will be returned as part of the following API calls:

PMWSGetETAOutOfRoute PMWSGetReport PMWSGeoCode

Elements

Element Definition Address1 Street information Address2 Additional street information City City name StateName The full name of the state State Two-character abbreviation; see Appendix C & D for applicable entries. Zip Five-digit US ZIP Code, six-character Canadian Postal Code or worldwide

postal code (see Appendix D) Region NA (North America), SA (South America), EU (Europe), AS (Asia), AF

(Africa), or OC (Oceania); NA is the default SPLC Standard Point Location Code Juris Jurisdiction; in the US this would be county. PlaceName Corresponds to a custom place; this would supersede standard address entries

for geocoding, or serve to identify a custom place to be associated with the address.

Lat A latitude; if entered with a longitude, these entries supersede all others (see section 6.2.6 on entering latitude/longitude points).

Long A longitude; if entered with a latitude, these entries supersede all others (see section 6.2.6 on entering latitude/longitude points).

GeoWarning An ErrorType structure containing any geocoding warnings; this is an optional field.

StopWarning Set to true if there is a warning for the leg between the previous stop and the current stop.

CountryName The full name of the country Country Country abbreviation – NOTE: In North America, NX should be used as the

State abbreviation for Nuevo Leon in Mexico (EM) and NL for Newfoundland and Labrador in Canada. If NL is passed as the state and EM as the country, geocoding will fail and the following warning will display: “GeoWarning: Check Country Setting”.

Abstract <xsd:complexType name=”LocationOutputType”> <xsd:sequence> <xsd:element name=”Address1” type=”xsd:string” /> <xsd:element name="Address2" type="xsd:string" />



<xsd:element name=”City” type=”xsd:string” /> <xsd:element name=”StateName” type=”xsd:string” /> <xsd:element name=”State” type=”xsd:string” /> <xsd:element name=”Zip” type=”xsd:string” /> <xsd:element name=”Region” type=”xsd:string” /> <xsd:element name=”SPLC” type=”xsd:string” /> <xsd:element name="Juris" type="xsd:string" /> <xsd:element name="PlaceName" type="xsd"string" /> <xsd:element name=”Lat” type=”xsd:string” /> <xsd:element name=”Long” type=”xsd:string” /> <xsd:element name="GeoWarning" type="ErrorType" />

<xsd:element name="StopWarning" type=" xsd:string " /> <xsd:element name="CountryName" type="xsd:string" /> <xsd:element name="Country" type="xsd:string" />


4.4 DirLineType This structure will be used to pass back the line information associated with a Driving Directions report. This structure is embedded within the DirStructType structure definition.

Elements

Element Definition DriveWarn A string containing warnings associated with the driving directions of that link DriveDir A string containing the driving directions of that link DirInterCh A string containing the interchange associated with condensed directions DirDist The cumulative distance associated with that link DirTime The cumulative estimated time associated with that link DirDelay The cumulative estimated time delay associated with the directions

Abstract <xsd:complexType name=”DirLineType”> <xsd:sequence> <xsd:element name=”DriveWarn” type=”xsd:string” /> <xsd:element name=”DriveDir” type=”xsd:string” /> <xsd:element name=”DirInterCh” type=”xsd:string” /> <xsd:element name="DirDist" type="xsd:string" /> <xsd:element name=”DirTime” type=”xsd:string” /> <xsd:element name=”DirDelay” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>



4.5 DirStructType This structure will be used to return a set of Driving Directions, is embedded within the ReportType structure, and thus returned as part of a PMWSGetReport API request. This structure may repeat on return. Elements

Element Definition DirOrg A LocationOutputType structure which will contain the information associated

with the origin DDLines DirLineType structure which will contain the actual driving direction

information; this structure will repeat DirDest A LocationOutputType structure which will contain the information associated

with the destination Abstract <xsd:complexType name=”DirStructType”> <xsd:sequence> <xsd:element name=”DirOrigin” type=”LocationOutputType” /> <xsd:element name="DDLines" type="DirLineType" /> <xsd:element name=”DirDest” type=”LocationOutputType” /> </xsd:sequence> </xsd:complexType>

4.6 DtlLineType This structure will be used to pass back the line information associated with the Detailed Route Report. This structure is embedded within the DtlStructType structure definition (section 4.7).

Elements

Element Definition DLWarn A string containing the warnings associated with the stop information DLArState A string containing the data associated with the arrival state DLStop A string containing the data associated with the stop information DLState A string containing the data from the state/country column DLDirection A string containing the data from the direction column DLRoute A string containing the data from the route column DLMiles A string containing the data from the miles column DLTime A string containing the data from the hours column DLInterCh A string containing the data from the interchange column DLLMiles A string containing the data from the leg miles column DLLTime A string containing the data from the leg hours column DLTMiles A string containing the data from the total miles column



DLTTime A string containing the data from the total hours column DLLToll (in North America) A string containing the data from the total tolls

column; only for those customers with tolls access DLTToll (in North America) A string containing the data from the leg tolls

column; only for those customers with tolls access DLTollPlazaAbbr (in North America) A string containing agency Abbreviation, Entry Plaza

Abbreviation and Exit Plaza Abbreviation DLTollPlazaName (in North America) A sting containing agency Full Name, Entry Plaza

Full Name and Exit Plaza Full Name DLEtaEtd The estimated time of arrival or departure

Abstract <xsd:complexType name=”DtlLineType”> <xsd:sequence> <xsd:element name="DLWarn" type="xsd:string" /> <xsd:element name="DLArState" type="xsd:string" /> <xsd:element name="DLStop" type="xsd:string" /> <xsd:element name=”DLState" type="xsd:string" /> <xsd:element name="DLDirection" type="xsd:string" /> <xsd:element name="DLRoute" type="xsd:string" /> <xsd:element name="DLMiles" type="xsd:string" /> <xsd:element name="DLTime" type="xsd:string" /> <xsd:element name="DLInterCh" type="xsd:string" /> <xsd:element name="DLLMiles" type="xsd:string" /> <xsd:element name="DLLTime" type="xsd:string" /> <xsd:element name="DLTMiles" type="xsd:string" /> <xsd:element name=”DLTTime" type="xsd:string" /> <xsd:element name="DLLToll" type="xsd:string" /> <xsd:element name="DLTToll" type="xsd:string" />

<xsd:element name="DLTollPlazaAbbr" type="xsd:string" /> <xsd:element name="DLTollPlazaName" type="xsd:string" /> <xsd:element name="DLEtaEtd" type="xsd:string" />




4.7 DtlStructType This structure will be used to pass back the information associated with the Detailed Route Report, is embedded within the ReportType structure, and thus returned as part of a PMWSGetReport API request. This structure may repeat on return. Elements

Element Definition DtlOrigin A LocationOutputType structure which will contain the information associated

with the origin DtlLines DtlLineType structure which will contain the actual lines of the detailed report DtlDest A LocationOutputType structure which will contain the information associated

with the destination Abstract <xsd:complexType name=”DtlStructType”> <xsd:sequence> <xsd:element name=”DtlOrigin” type=”LocationOutputType” /> <xsd:element name="DtlLines" type="DtlLineType" /> <xsd:element name=”DtlDest” type=”LocationOutputType” /> </xsd:sequence> </xsd:complexType>

4.8 StpLineType This structure will be used to pass back the line information associated with each stop of the State/Country Distance report, as well as the Mileage report.

Elements

Element Definition SRStop A LocationOutputType structure containing the address information of the stop STWarning A n ErrorType structure containing error or warning information, if any LMiles A string containing the data from the leg miles column TMiles A string containing the data from the total miles column LCostMile A string containing the data from the leg cost/mile column TCostMile A string containing the data from the total cost/mile column LHours A string containing the data from the leg hours column THours A string containing the data from the total hours column LTolls A string containing the data from the leg tolls column LEstghg Estimated greenhouse gasses from the leg ETSGHG.column TEstghg Estimated greenhouse gasses from the total ETSGHG.column OORMILE Estimated out-of-route miles EtaEtd The estimated time of arrival or departure



Abstract <xsd:complexType name=”StpLineType”> <xsd:sequence> <xsd:element name=”SRStop” type=”LocationOutputType” /> <xsd:element name="STWarning" type="ErrorType" /> <xsd:element name="LMiles" type="xsd:string" /> <xsd:element name=”TMiles” type=”xsd:string” /> <xsd:element name=”LCostMile” type=”xsd:string” /> <xsd:element name=TCostMile” type=”xsd:string” /> <xsd:element name="LHours" type="xsd:string" /> <xsd:element name=”THours” type=”xsd:string” /> <xsd:element name=”LTolls” type=”xsd:string” /> <xsd:element name=”TTolls” type=”xsd”string” />

<xsd:element name=” LEstghg” type=”xsd”string” /> <xsd:element name=” TEstghg” type=”xsd”string” /> <xsd:element name=” OORMILE” type=”xsd”string” /> <xsd:element name=” EtaEtd” type=”xsd”string” />


4.9 OORLineType This structure will be used to pass back the line information associated with each current (GPS) location and the distance to get back on route for the response associated with the PMWSGetETAOutOfRoute API. This structure is embedded within the EORStructType structure. Elements

Element Definition SRStop A LocationOutputType structure containing the address information

of the truck’s current location LMiles A string with leg miles from current location to destination TMiles A string with total miles from current location to destination LCostMile A string with leg cost from current location to destination TCostMile A string with the data from the total cost/mile column LHours A string with leg hours ETA from location to destination THours A string with total hours ETA from location to destination LTolls A string containing the data from the leg tolls column TTolls A string containing the data from the total tolls column OORMILE “Out of route” distance from current location to get back on route

Abstract <xsd:complexType name=”OORLineType”> <xsd:sequence>



<xsd:element name=”SRStop” type=”LocationOutputType” /> <xsd:element name="LMiles" type="xsd:string" /> <xsd:element name=”TMiles” type=”xsd:string” /> <xsd:element name=”LCostMile” type=”xsd:string” /> <xsd:element name=TCostMiles” type=”xsd:string” /> <xsd:element name="LHours" type="xsd:string" /> <xsd:element name=”THours” type=”xsd:string” /> <xsd:element name=”LTolls” type=”xsd:string” /> <xsd:element name=”TTolls” type=”xsd”string” /> <xsd:element name="OORMile” type =”xsd:string” /> </xsd:sequence> </xsd:complexType>

4.10 EORStructType This structure will be used to pass back the information associated with the ETA/Out of Route Report in the response associated with the PMWSGetETAOutOfRoute API call.

Elements

Element Definition EOROrigin A LocationOutputType structure which will contain the information

associated with the origin OORLineType A n OORLineType structure which will contain the actual lines of the

ETA/Out of Route report. This structure can repeat. EORDest A LocationOutputType structure which will contain the information

associated with the destination

Abstract <xsd:complexType name=”EORStructType”> <xsd:sequence> <xsd:element name=”EOROrigin” type=”LocationOutputType” /> <xsd:element name="OORLineType" type="OORLineType" /> <xsd:element name=”EORDest” type=”LocationOutputType” /> </xsd:sequence> </xsd:complexType>



4.11 SCLineType This structure will be used to pass the back the state/country line information in the State Report. This structure is embedded within the StStructType structure.

Elements

Element Definition StCntry A string containing the State/Country information STotal A string containing the total miles traveled in that state/country SToll A string containing the toll road miles traveled in that state/country SFree A string containing the non-toll road miles traveled in that state/country SFerry A string containing the ferry miles traveled in that state/country SLoaded A sting containing the loaded miles traveled in that state/country SEmpty A string containing the empty miles traveled in that state/country STolls (in North America) A string containing the toll costs for that state

Abstract <xsd:complexType name=”SCLineType”> <xsd:sequence> <xsd:element name=”StCntry” type=”xsd:string” /> <xsd:element name="STotal" type="xsd:string" /> <xsd:element name=”SToll” type=”xsd:string” /> <xsd:element name=”SFree” type=”xsd:string” /> <xsd:element name="SFerry" type="xsd:string" /> <xsd:element name=”SLoaded” type=”xsd:string” /> <xsd:element name=”SEmpty” type=”xsd:string” /> <xsd:element name=”STolls” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

4.12 StStructType This structure will be used to pass back the State Report. It is embedded within the ReportType structure and will be returned as part the PMWSGetReport API call.

Elements

Element Definition StopMiles A list of StpLineType structures containing the mileage information associated

with that stop; this element may repeat StateMiles A list of SCLineType structures containing the state/country mileage

information; this element may repeat



Abstract <xsd:complexType name=”StStructType”> <xsd:sequence> <xsd:element name=”StopMiles” type=”ArrayOfStpLineType” /> <xsd:element name="StateMiles" type="ArrayOfSCLineType" /> </xsd:sequence> </xsd:complexType>

4.13 RoadLineType This structure will be used to pass back the line information for the Miles by Road Type report, is embedded within the ReportType structure and will be returned as part of the PMWSGetReport API call.

Elements

Element Definition RLStop A LocationOutputType structure containing the address information of the stopLMiles A string containing the data from the leg miles column InterSt A string containing the data from the Interstate miles column InterstNoramp A string containing the data from the Interstate no ramp miles column Divide A string containing the data from the divided highway miles column Prime A string containing the data from the primary road miles column Second A string containing the data from the secondary road miles column Ferry A string containing the data from the ferry miles column Ramp A string containing the data from the ramp miles column Local A string containing the data from the local road miles column Toll A string containing the data from the toll road miles column Disclaimer A string containing a disclaimer regarding the stop

Abstract <xsd:complexType name=”RoadLineType”> <xsd:sequence> <xsd:element name=”RLStop” type=”LocationOutputType” /> <xsd:element name="LMiles" type="xsd:string" /> <xsd:element name=”InterSt” type=”xsd:string” /> <xsd:element name=”InterSt” type=”xsd:string” /> <xsd:element name=”InterstNoramp” type=”xsd:string” /> <xsd:element name=”Divide” type=”xsd:string” /> <xsd:element name="Prime" type="xsd:string" /> <xsd:element name=”Second” type=”xsd:string” /> <xsd:element name=”Ferry” type=”xsd:string” /> <xsd:element name="Ramp" type="xsd:string" />



<xsd:element name=”Local” type=”xsd:string” /> <xsd:element name=”Toll” type=”xsd:string” /> <xsd:element name=”Disclaimer” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

4.14 FuelStopLineType This structure will be used to pass back the Fuel Stop information for the Fuel Optimization report, is embedded within the FuelReportType structure and will be returned as part of the PMWSGetReport API call.

Elements

Element Definition FuelLocation A LocationOutputType structure containing the address information of the fuel

stop FuelPur A string containing the number of gallons of fuel to be purchased FuelCost A string containing the estimated cost associated with this fuel purchase; this

is in U.S. dollars. FuelFill A character containing whether this fuel purchase is to fill the tank.

Abstract <xsd:complexType name=”FuelStopLineType”> <xsd:sequence> <xsd:element name=”FuelLocation” type=”LocationOutputType” /> <xsd:element name="FuelPur" type="xsd:string" /> <xsd:element name=” FuelCost” type=”xsd:string” /> <xsd:element name=” FuelFill” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>

4.15 FuelSummaryType This will be used to pass back the Fuel Summary information for the Fuel Optimization report, is embedded within the FuelReportType structure and will be returned as part of the PMWSGetReport API call.

Elements

Element Definition OptFuel A string containing the optimal amount of fuel for this trip TCost A string containing the total cost of the fuel for this trip



ACostG A string containing the actual cost of the fuel, per gallon ACostM A string containing the actual cost of the fuel, per mile ECost A string containing the effective cost ECostG A string containing the effective cost per gallon ECostM A string containing the effective cost per mile TSave A string containing the total savings SaveG A string containing the savings per gallon SaveM A string containing the savings per mile RtAvg A string containing the route average RtMax A string containing the route maximum RtMin A string containing the route minimum ReAvg A string containing the retail average ReMax A string containing the retail maximum ReMin A string containing the retail minimum

Abstract <xsd:complexType name=”FuelStopLineType”> <xsd:sequence> <xsd:element name=”OptFuel” type=”xsd:string” /> <xsd:element name="TCost" type="xsd:string" /> <xsd:element name=” ACostG” type=”xsd:string” /> <xsd:element name=” ACostM” type=”xsd:string” /> <xsd:element name="ECost" type="xsd:string" /> <xsd:element name="ECostG" type="xsd:string" /> <xsd:element name="ECostM" type="xsd:string" /> <xsd:element name="TSave" type="xsd:string" /> <xsd:element name="SaveG" type="xsd:string" /> <xsd:element name="SaveM" type="xsd:string" /> <xsd:element name="RtAvg" type="xsd:string" /> <xsd:element name="RtMax" type="xsd:string" /> <xsd:element name="RtMin" type="xsd:string" /> <xsd:element name="ReAve" type="xsd:string" /> <xsd:element name="ReMax" type="xsd:string" /> <xsd:element name="ReMin" type="xsd:string" /> </xsd:sequence> </xsd:complexType>



4.16 FuelReportType This structure will be used to pass back the entire Fuel Optimization report, is embedded within the ReportType structure and will be returned as part of the PMWSGetReport API call.

Elements

Element Definition FuelStops A FuelStopLineType structure; this element may repeat FuelSum A FuelSummaryType structure

Abstract <xsd:complexType name=”FuelStopLineType”> <xsd:sequence> <xsd:element name=”FuelStops” type=”FuelStopLineType” /> <xsd:element name=”FuelSum” type=”FuelSummaryType” /> </xsd:sequence> </xsd:complexType>

4.17 RadiusReportType This structure will be used to pass back the list of locations found as part of a POI search, can repeat, is embedded within the ReportType structure and will be returned as part of the PMWSRadiusSearch API call.

Elements

Element Definition RadLoc A LocationOutputType structure containing the pertinent information; for

cities, it will contain the city and state; for postal codes it will contain the zip, the city, and the state; for places and POIs, it will contain the place name, as well as the city, state, and lat/long pair (if available).

RadDist A string containing the distance, in miles, from the radius point

Abstract <xsd:complexType name=”RadiusReportType”> <xsd:sequence> <xsd:element name=”RadLoc” type=”LocationOutputType” /> <xsd:element name=”RadDist” type=”xsd:string” /> </xsd:sequence> </xsd:complexType>



4.18 ReportType This structure will be used to pass back all text based, non-error responses to the requesting system. This structure will be returned with the following API calls:

PMWSGetETAOutOfRoute PMWSSetRoadSpeed PMWSGetReport PMWSGeoCode PMWSSetAvoidFavor PMWSReduceTrip

PMWSRadiusSearch PMWSGetStates

Elements

Element Definition RptType A string describing the report type being returned; this entry will drive

the rest of the report, and specify which elements will be included. TripID A string echoing back what was passed in by the request StopNum A string containing the number of stops CurrentLocationNum A string describing the current location number Origin A LocationOutputType structure defining the origin Destination A LocationOutputType structure defining the destination DirectReport A DirStructType structure containing a Driving Directions report; this

will only be returned if specified in RptType. DetailReport A DtlStructType Structure containing a Detailed Route Report; this

will only be returned if specified in RptType. StateReport A n StStructType structure contain a State Miles report; this will only

be returned if specified in RptType. RoadReport A RoadLineType structure containing a Miles by Road Type report;

this will only be returned if specified in RptType. MilesReport A StpLineType structure contain a Miles report; this will only be

returned if specified in RptType. ComparisonReport A CompLineType structure containing the comparison report Geocode A LocationOutputType structure containing a geocoded addresses or

lat/long pair; this will only be returned if specified in RptType. EORReport A n EORStructType structure containing an ETA/Out of Route

Report; this will only be returned if specified in RptType. GeoTunnel A LocationOutputType structure with populated latitude and longitude

fields; this is a repeating field; will only be returned if specified in RptType.

FuelReport A FuelReportType structure containing a Fuel Optimization report; this will only be returned if specified in RptType.

RadReport A list of RadiusReportType structures containing a Radius Search report; will only be returned if specified in RptType.

LeastCostTripOptions Contains the options combination used for Least Cost Routing; the combinations are Practical, Shortest, Practical Tolls Avoid, Shortest Tolls Avoid.

TrafficDataUsed True or False depending on whether traffic data was used to calculate transit time



Abstract <xsd:complexType name=”ReportType”> <xsd:sequence> <xsd:element name=”RptType” type=”xsd:string” /> <xsd:element name="TripID" type="xsd:string" /> <xsd:element name=”StopNum” type=”xsd:string” /> <xsd:element name=”CurrentLocationNum” type=”xsd:string” /> <xsd:element name=”Origin” type=”LocationOutputType” /> <xsd:element name=”Destination” type=” LocationOutputType” /> <xsd:element name=”TrafficDataUsed” type=”xsd:string” /> <xsd:element name=”DirectReport” type=”ArrayOfDirStructType” /> <xsd:element name="DetailReport" type="ArrayOfDtlStructType" /> <xsd:element name=”StateReport” type=”ArrayOfStStructType” /> <xsd:element name=”RoadReport” type=”ArrayOfRoadLineType” /> <xsd:element name="MilesReport" type="ArrayOfStpStructType" />

<xsd:element name="ComparisonReport" type="ArrayOfCompLineType" /> <xsd:element name=”Geocode” type=”ArrayOfLocationOutputType” /> <xsd:element name=”EORReport” type=”EORStructType” /> <xsd:element name=”GeoTunnel” type=”LocationOutputType” /> <xsd:element name=”FuelReport” type=”FuelReportType” /> <xsd:element name=”RadReport” type=”ArrayOfRadiusReportType” />

<xsd:element name=”LeastCostTripOptions” type=” xsd:string” /> </xsd:sequence> </xsd:complexType>

4.19 MapType This structure will be used to pass back all non-text based, non-error responses to the requesting system. This structure will be returned with the following API calls:

PMWSGetMapRoute PMWSGetMap PMWSGetMapBreadcrumbTrail PMWSSetCustomPlace

Elements

Element Definition ZoomLevel The zoomlevel of the map Origin A LocationOutputType structure which will contain what was geocoded

as the origin of this trip Destination A LocationOutputType structure which will contain what was geocoded

as the destination of this trip TripID A string echoing back what was passed in by the request UpLeft A MapPinLocationType structure with the lat/longs populated and



representing upper left-hand corner of the map LowRt A MapPinLocationType structure with the lat/longs populated and

representing the lower right-hand corner of the map ExUpLeft A MapPinLocationType structure with the lat/longs populated and

representing the expanded upper left-hand corner of the map ExLowRt A MapPinLocator structure with the lat/longs populated and representing

the expanded lower right-hand corner of the map MapSize A n integer containing the size of MapInfo MapInfo A byte array containing the .gif Center A MapPinLocationType structure with the lat/longs populated and

representing the center of the map MapLegendBuffer Consists of MapLegend structure a buffer holding base64-encoded data,

representing the map legends (drawn on a separate layer); one or more legends can be returned.

Abstract <xsd:complexType name=”MapType”> <xsd:sequence> <xsd:element name=”ZoomLevel” type=”xsd:integer” /> <xsd:element name=”Origin” type=”LocationOutputType” /> <xsd:element name="Destination" type="LocationOutputType" /> <xsd:element name=”TripID” type=”xsd:string” /> <xsd:element name=”UpLeft” type=”MapPinLocationType” /> <xsd:element name="LowRt" type="MapPinLocationType" /> <xsd:element name=”ExUpLeft” type=”MapPinLocationType” /> <xsd:element name="ExLowRt" type="MapPinLocationType" /> <xsd:element name=”MapSize” type=”xsd:integer” /> <xsd:element name=”MapInfo” type=”xsd:bytearray” /> <xsd:element name=”Center” type=”MapPinLocationType” /> <xsd:element name=”MapLegendBuffer” type=”ArrayOfMapLegendBuffer” /> </xsd:sequence> </xsd:complexType>



4.20 MapPointInfo This structure will be used to pass back information regarding one or more pins that will appear on the map, if any pins were specified in the request to the following API calls:

PMWSGetMapRoute PMWSGetMap PMWSGetMapBreadcrumbTrail

Elements

Element Definition GroupID This value will always be -1; it is reserved for future use. ID The pin ID property, specified in the request ClassName The Bitmap property, specified in the request Devx The horizontal location of the pin in the map, in device coordinates Devy The vertical location of the pin in the map, in device coordinates Latitude The latitude of the pin on the map Longitude The longitude of the pin on the map

Abstract <xsd:complexType name=”MapPointInfo”> <xsd:sequence> <xsd:element minOccurs="1" maxOccurs="1" name="GroupID" type="xsd:int"/> <xsd:element minOccurs="1" maxOccurs="1" name="ID" type=" xsd:unsignedInt"/> <xsd:element minOccurs="0" maxOccurs="1" name="ClassName" type=" xsd:string"/> <xsd:element minOccurs="1" maxOccurs="1" name="Devx" type=" xsd:int"/> <xsd:element minOccurs="1" maxOccurs="1" name="Devy" type=" xsd:int"/> <xsd:element minOccurs="1" maxOccurs="1" name="Latitude" type=" xsd:int"/> <xsd:element minOccurs="1" maxOccurs="1" name="Longitude" type=" xsd:int"/> </xsd:sequence> </xsd:complexType>

| 150


5.1 Introduction In 2009, ALK Technologies developed its first version of an end-user graphical interface for PC*MILER Web Services which was distributed with Version 23. Since then, there has been significant interest expressed by our customers regarding the ability to pull the graphical user interface (GUI) into their own Web applications in order to create fast, robust sites from ALK’s PC*MILER framework. Customers want to be able to choose the functionality that they need rather than getting the entire Web Services application from ALK. Furthermore, they want to have the ability to customize their Web Services GUI. ALK has developed PC*MILER .NET Web Controls as a response to that dilemma. This application allows our customers to incorporate PC*MILER functionality into their web sites by simply dragging and dropping plug-and-play map components. Users with only basic programming knowledge can now customize the appearance of PC*MILER map data features by using the ASP.NET server controls developed by ALK. Other functionality, including a geocoding control, a route control, and a driving directions report will be included in future releases of PC*MILER Web Services. As an example of what might be accomplished using PC*MILER .NET Web Controls, a map from ALK could be connected to a datasheet from the web application of another vendor; or a Web Control from ALK could show the current route for the stops selected in another web application. PC*MILER .NET Web Controls were created with several criteria in mind, including:

ease of implementation for the end-user;

optimal performance;

scalability;

maintainability;

and localization (English, German, French, and Spanish are supported).

PC*MILER .NET Web Controls provide configurable and extensible user interfaces by supporting:

quick creation of new sites and new pages;

reduction of web development cycle times;

Chapter 5: PC*MILER.NET Web Controls

Chapter 5: PC*MILER.NET Web Controls | 151


Web Controls customization – the user can control the appearance of ALK’s Web Controls by setting designer properties that define elements such as fonts, sizes and icons, and store these customized properties in the database.

5.2 Technical Specifications Support for Microsoft .NET 2.0 and .NET 3.5 Frameworks. As the new .NET

frameworks become available in the future, ALK will migrate the existing Web Controls to the new frameworks.

Data storage uses MS SQL Server; other popular storage management database systems (MDBS) are supported.

A Web Controls development environment such as Visual Studio or Microsoft WebMatrix is needed.

5.3 Using .NET Web Controls With Visual Studio To use .NET Web Controls with Visual Studio, follow the steps below.

1. Reference the Web Controls DLL:

a. In the Solution Window, right-click on your project and select Add Reference… from the pop-up menu.

b. In the Add Reference window, find the DLL location.

c. Add references to System.Web.Extensions and System.Web.Extensions.Design.

d. Add references to AjaxControlToolkit, ALK.AjaxControlToolkit.Support, and ALKAjaxControlToolkit.

2. Register Web Controls in the Web.config file: <system.web> <pages theme="DefaultTheme"> <controls> <add namespace="AlkAjaxControlToolkit" assembly="AlkAjaxControlToolkit" tagPrefix="ajaxMapToolkit"/> </controls> </pages> <httpHandlers> <add path="ALKLightMap.ashx" verb="GET" type="ALK.AjaxControlToolkit.Support.LightMapHandler" /> </httpHandlers>



</system.web>

3. Add the desired Web Controls in the right place by assigning the required properties, for example:

<ajaxMapToolkit:DraggableMapExtender ID="draggableMap" BehaviorID="draggableMapClient" runat="server" TargetControlID="mapbackground" DragHandleID="imgMap1" Region="NA" ZoomElementLeft="16" ZoomElementTop="60" PanElementLeft="2" PanElementTop="240" ServicePath="LocalService.asmx" > </ajaxMapToolkit:DraggableMapExtender>

4. For server side programming:

a. Add a local web service to the website. Make sure the service is derived from the interface defined in ALK.AjaxControlToolkit.Support.ILocalWebService.

b. Add [System.Web.Script.Services.ScriptService] attribute to the service class to enable it to be invoked from JavaScript.

c. Major web method looks like: public JSMapResponse GetMap(string contextKey, Size size, Point center, MapBound mapBound, int zoom, int gridPitch, Region region)

contextKey: optional value. Used to pass additional information to map control, and the control passes back the same informtion to the service.

size: map width and height.

center: center longitude and latitude.

mapBound: longitudes and latitudes of two diagonal corners.

zoom: zoom level from 1 to 12.

gridPitch: logically a map is divided into smaller square tiles. gridPitch is the width and height of a tile. When a search is performed, at most 8 tiles around the search center will be covered instead of searching the entire map.

region: supported map region enumeration such as NA or EU.



5. Sample Code

JSMapResponse resp = new JSMapResponse(); MapProvider mapProvider = new MapProvider(); mapProvider.Login = login; mapProvider.ZoomLevel = zoom; MapPinLocationType mapCenter = new MapPinLocationType(); mapCenter.PinLat = center.Lat.ToString(); mapCenter.PinLong = center.Lon.ToString(); mapProvider.CenterPoint = mapCenter; MapPinLocationType mapCorner1 = new MapPinLocationType(); mapCorner1.PinLat = mapBound.Corner1.Lat.ToString(); mapCorner1.PinLong = mapBound.Corner1.Lon.ToString(); mapProvider.Corner1 = mapCorner1; MapPinLocationType mapCorner2 = new MapPinLocationType(); mapCorner2.PinLat = mapBound.Corner1.Lat.ToString(); mapCorner2.PinLong = mapBound.Corner1.Lon.ToString(); mapProvider.Corner2 = mapCorner2; MapSettingsType settings = new MapSettingsType(); settings.MapHeight = size.Height.ToString(); settings.MapWidth = size.Width.ToString(); settings.Region = region.ToString(); settings.DetailLevel = "4"; mapProvider.MapSettings = settings; MapResponse mapResponse = mapProvider.GetMap(); MapType mapType = mapResponse.RouteMap; resp = new JSMapResponse(mapType, string.Empty); return resp;

5.4 About the Map Control An Ajax extender control complements the target ASP.NET server control, enabling the user to perform tasks that are difficult to do on the server side such as mouse move, or drag events handling using JavaScript. Extenders like Ajax Control Toolkit controls build on the Microsoft Ajax Library, and work with ScriptManager to manage partial-page rendering and script libraries. Also, the client side run-time will handle most web browser compatibility issues. When using the Map Control, the user may be required to write a minimal amount of JavaScript to hook up the client side events.

The Map Control provides the following benefits:

Clearly separates client side code and server side code.

Allows the code to be reused. For example, the user does not need to write JavaScript to handle slider position changes, a drag map function, etc.



Provides the flexibility for building Ajax-enabled map web applications on the fly.

Enhances web performance – Ajax calls to the code on the web page or local web service only post back the necessary parameters to the server, not the whole page.

The ALK Map Control assembly has three extenders: Pan extender, Zoom extender, and Map extender.

Pan extender: Raises pan event when a user clicks on the embedded pan direction icon.

Zoom extender: Changes zoom slider visual position when a user drags or clicks on the slider icons, and raises zoom event.

Map extender: This extender is the core of the assembly. It supports on-map mouse double-click, move and drag events, mouse wheel events, and provides other JavaScript functions for performing simple calculations and HTML visual element manipulation.

| 155


6.1 PC*MILER Routing Types and Options PC*MILER offers two basic route types, Practical, Fastest and Shortest, that may be combined with one or more other route type options: Toll Discouraged, National Network, 53'/102'' Trailer or Twins, Heavy/Light Vehicle, Hub, or Hazardous Materials Routing. NOTE: Air mileage is not an available routing option in PC*MILER Web Services, it can only be calculated using an installation of PC*MILER|Connect.

6.1.1 Practical Routing (OptionsType input structure, RoutingType element) Practical Routes represent distances and driving routes that a driver would normally take to minimize time and cost. Practical Routes model the trade-off between taking the most direct path and staying on major, high quality highways. Interstate highways are given a higher priority than toll roads, which in turn are given a higher priority than secondary highways, and so on. Routing instructions and mileage can be used when actual travel distances and directions are needed. Practical routings consider distance, road quality, terrain, urban/rural classifications, truck-restricted roads, and designated principal and secondary through routes. Practical Route mileage and state-by-state mileage breakdowns can be used to supplement your regular fuel tax reporting documents for many states. Many state audit departments have purchased licenses to incorporate PC*MILER into their audit procedures.

6.1.2 Shortest Routing (OptionsType input structure, RoutingType element) Shortest Routes represent distances and driving routes that a vehicle would take to minimize total distance traveled while still following a reasonable route. For instance, Shortest Route mileage and routes will also avoid truck-restricted roads and, in some cases, may favor a beltway rather than traveling directly through a city. ALK maintains that carriers and shippers alike would all be better served by using a mileage tariff based on actual miles traveled (i.e. similar to those generated using a PC*MILER Practical Route), which would more accurately reflect true transportation costs.

6.1.3 Toll Discouraged Routing (U.S. and Canada only) (OptionsType input structure, TollDiscourage element) For users who desire to avoid long stretches of toll roads, ALK provides a Toll Discouraged routing option. Toll Discouraged routing will avoid long stretches of toll roads but will not take long, impractical detours to

Chapter 6: PC*MILER Feature Descriptions

Chapter 6: PC*MILER Feature Descriptions | 156


avoid toll bridges and tunnels. For example, a routing from Boston, MA to Albany, NY will avoid the Massachusetts Turnpike, but a routing from Camden, NJ to Philadelphia, PA will include a toll bridge.

6.1.4 National Network Routing (U.S. only) (OptionsType input structure, ClassOverrides element) The National Network is a government-designated system of highways originally established by the Surface Transportation Assistance Act of 1982. This routing option is based on the federally-designated National Network system updated in the April, 1992 Code of Federal Regulations, Part 658, Appendix A. The National Network includes the Interstate System (several minor segments are not included), and many selected US and state highways. Highways continue to be added to the National Network by federal and state governments. PC*MILER National Network routing represents distances and driving routes which are most reasonable and legal for the larger trucks authorized by the Surface Transportation Assistance Act of 1982. National Network routing stays on the National Network to the maximum extent possible. Given that many areas are not directly served by the National Network, the origin and stop-offs of your route may not be on the National Network. In these cases PC*MILER will take the shortest reasonable path from the origin and stop-offs to/from the Network. Detailed Route Reports (driving directions) for PC*MILER National Network routes provide a warning wherever the route is forced to use a non-conforming road link. These road segments should be checked before traveling. National Network mileage tends to be higher than Shortest or Practical mileage. These designated highways permit, at a minimum, 102" wide, single 48 ft. trailers and 28 ft. double trailers. The Interstate system and most, but not all, remaining designated routes are open to 80,000 pound vehicles. Certain states, notably Arkansas and Mississippi, have designated certain National Network segments with less than an 80,000 pound capacity. In addition to the National Network highways, access routes and access policies are components of routing STAA dimensioned trucks. The Federal government has mandated that no state may prohibit travel from the National Network for a minimum of one road mile unless safety restrictions apply. Additionally, no state may deny reasonable access to terminals and facilities for food, fuel, repairs and rest. Several states maintain more generous access policies and lists of specifically designated access routes to terminals and facilities. (See Appendix A in this Guide for the current status of access policies. For detailed information about pre-approved access routes, contact the individual states.) Should you need to travel beyond the National Network and beyond the access roads, you must acquire the proper permit. NOTE: These suggested National Network routings are based on official highway maps, the Code of Federal Regulations, and information provided by state governments. It is provided without a warranty of any kind. The user assumes full responsibility for any delay, expense, loss, or damage which may occur as a result of its use.



NOTE ALSO: There are no National Network road segments in Mexico, Canada or anywhere else outside of the United States.

6.1.5 53'/102'' Trailer or Twins Routing (U.S. and Canada only) (OptionsType input structure, ClassOverrides element) The calculations for these routes are based on National Network routing, with the addition of roads that permit 53'/102'' trailers. When the “53' Routing Option” is explicitly invoked in PC*MILER, or when a width of greater than 96'' or a length greater than 48' is entered into PC*MILER as the vehicle size, PC*MILER’s routing algorithm switches to favoring roads designated by the states for “oversize” trucks (meaning over 96'' wide or over 48' long, or twin trailers). In PC*MILER, the routing designations for the following equipment types are included in the “53-Foot Trailer or Twins” (formerly named “53' Trailer”) routing category:

Double trailers no more than 28' long and 102'' wide Semi-trailers longer than 48' or wider than 96'', but no longer than 53' and no wider than 102''

The Detailed Route Reports for PC*MILER 53' Trailer and Twins routes warn that a road is “Not Designated” if that road is necessary to reach an origin, destination or stop-off outside of the maximum access distance for that state. If such a warning appears for a route, then a legal route for 53' equipment is either not possible under current state designations or would be so circuitous that you should either consider assigning smaller equipment or petitioning the state to designate a more direct access route. Users should check the legal requirements on these roads because they vary; for example, delivery may be legal, but stopping for food or services may not be.

6.1.6 Routing for Different Sized Vehicles (OptionsType input structure, OverrideRestrict element) By default, PC*MILER generates routes and mileages for large, heavy trucks of a particular size and weight (in North America, 5-axle tractor-semitrailer combination, 96” wide, 48’ long trailer, 13’6” high, 80,000 lbs GVW; routing for 102” wide 53’ long trailers and 28’ twin trailers is available by checking “53’ Trailer or Twins” in the Route Options dialog box). You can route other sizes and weights of trucks by setting vehicle dimensions, choosing among pre-defined vehicle profiles, or creating a user-defined vehicle profile. See Chapter 9, Using the Route Options Dialog Box, specifically sections 9.2, 9.3 and 9.6; and section 10.1 on custom vehicles profiles. PC*MILER also includes a routing option specifically for automobiles and other light vehicles (vans, pickup trucks, SUVs, etc.) that relaxes all truck and commercial vehicle regulations (see section 9.6.5). Additionally, the “Override Restrictions” setting in the Route Options dialog box is available. This option relaxes truck restrictions for particular sizes and weights, but still avoids roads that are prohibited to or discouraged for all trucks. If a resulting route uses any roads that



have restrictions for particular sizes and weights, the Detailed Route Report will list them. This allows you to determine the largest or heaviest vehicle you can assign to drive that route.

By default Override Restrictions is off, in which case PC*MILER routing will avoid both truck-prohibited and truck-discouraged roads, as well as truck-restricted roads that pertain to the size and weight set in the current vehicle dimensions or profile. In addition, nationwide 13' 6" height restrictions will be taken into account.

6.1.6.1 Light Vehicle Automobile Routing

(TruckConfigType input structure) This capability is for those interested in calculating routes and toll costs for light vehicles such as vans, pickup trucks, SUVs, automobiles, etc. Vehicle dimensions criteria include the following (all criteria must be met):

2 axles; less than 9,000 lbs (or 4,082 kgs) in weight; less than or equal to 7 feet (2.133 meters) in height; less than or equal to 20 feet (6.096 meters) in length; less than or equal to 96 inches (2.438 meters) in width,

When the above criteria are met, PC*MILER will ignore all commercial truck restrictions (Truck Restricted, Truck Prohibited, and Truck Discouraged), allowing the route to take advantage of parkways and other roads that heavier or larger vehicles are not allowed to use; and will also use toll rates that apply to small vehicles with 2 axles (see section 6.5 on toll costs).

6.1.7 Hub Routing (GetReport API, TripHub parameter) This option generates mileage from one origin to a virtually unlimited number of destinations which you enter as stops. To generate a route in Hub mode, set TripHub to “yes” in the GetReport API. The Detailed Route Report and State/Country Distance Summary Report are both available for hub routing. NOTE: Cumulative miles are not generated or displayed in Hub mode.

6.1.8 Least Cost Routing (GetReport API, ReportType parameter; GetMapRoutes API, LeastCost parameter; ReportType output structure, LeastCostTripOptions element) Costing has always been an important use of PC*MILER. Among ALK customers there has been a growing interest in using PC*MILER to help with the trade-off of toll costs, costs per mile, and costs per hour in determining a “least cost” route. In response to the needs of our customers, ALK began to research the relevant costing issues using several cost factors (typical miles per gallon, cost per gallon, fuel cost per mile, other cost per mile, and labor cost per hour for an 18-wheeler) and found that:



a slower (less “practical”) route is the least-cost route 58% of the time, regardless of

diesel price, provided the truck can still make its delivery window and its pickup window for its next load;

if the least-cost route is chosen, there is the potential to save 0.6/% - 0.9% in costs, on average1;

when diesel prices are high, the least-cost route is more likely to be a “shorter” route compared to when diesel prices are low; and

the absolute amount of savings from choosing a least-cost route is insensitive to diesel price.

Of the 90 origin/destination pairs used in ALK’s study2, the O/D with the largest difference in cost, regardless of diesel price, was Chicago, IL to Washington, DC. At a fuel price of $2.71/gallon, the savings if the “least cost” route was chosen would be $79, or 7.8% 3:

Would a customer in the above scenario actually save $79 in cost if they chose the “least cost” route? That would depend on a lot of factors that are external to the route:

where the driver is in their hours of service cycle the delivery time window for the truck and driver’s current load the pickup time window for the truck and driver’s next load alternative opportunities to match a different truck and driver to the next load (for a

dispatcher of company drivers) or to choose a different next load (for an owner-operator)

On the basis of all the above findings, ALK has developed a new Least Cost routing feature that considers user-specified values for miles per gallon, cost per gallon, fuel cost per mile, other costs per mile, labor cost per hour, and stop costs – and includes a parameter for a greenhouse gas emission estimate. Least Cost routing generates a series of alternative routes with distance, time and cost estimates, and lets the dispatcher or driver (or an external system, such as a truck dispatch optimization system) choose an optimal route, considering factors such as those cited above that are external to the route. See section 6.1.12, Trip Costs, on settings that affect Least Cost routing.

Chicago, IL to Washington, DC

Route Miles Hours Cost

Total Tolls Fuel Time Maint

Prac 697.1 11.60 $1,010 $147 $315 $465 $84

Prac|Toll 776.8 12.90 $961 $0 $351 $517 $93

Short 689.9 12.10 $994 $115 $312 $485 $83

Short|Toll 700.1 13.23 $931 $0 $316 $531 $84

Least-cost difference 3.0 1.63 -$79 -$147 $1 $66 $0



______________________________ Reference Notes: 1 - These results are for 48' equipment. It is expected that the potential savings for 53' equipment will be lower, due to

fewer opportunities for legal alternative routes. 2 - The O/D pairs used for the study connect the centers of the 10 largest metro areas in the U.S. 3 - Sources of “average” data used in the study were default values for drivers paid by the hour, along with values from a

recent American Transportation Research Institute (ATRI) study (An Analysis of the Operational Costs of Trucking), the U.S. Energy Administration, and typical miles per gallon for an 18-wheeler.

6.1.9 Time-Based Routing (OptionsType, TimeOptions, and DateAndTimeOptions input structures; and StpLineType, DtLineType, and OORLineType output structures) In recent years, ALK Technologies has become aware that a number of our customers are interested in considering time of day, day of the week, and time zones when calculating and reporting routes, distances, travel times, and toll costs. Up to and including Version 27, PC*MILER’s default routes, distances, travel times and toll costs are calculated based on:

average road speeds by state/province, urban/rural, and class of road; height, length, width, and weight restrictions that apply during the majority of the

commonly traveled seasons of the year, days of the week, and times of day; seasonal roads being open during shipping and receiving seasons, but not to through

traffic; and peak-period toll costs for the most recently updated quarter of the release year.

These fundamental routing criteria work well for many purposes of our users, and will always be foundational to ALK’s industry-leading PC*MILER products. However, time-based feature enhancements now offer more precise travel time estimates allowing users to:

specify a departure or arrival date and time for calculation of estimated time of arrival (ETA) at all stops and toll plazas;

use road-specific travel times based on industry-leading historical, typical, or real-time traffic data in route calculations;

specify how PC*MILER will handle time zone changes in reports; and calculate toll costs specific to the time of day.

Time-based routing can be run with or without the use of traffic data to increase the precision of transit time calculations. When time-based routing is used, ETA/ETD information appears in the Mileage Report and Detailed Route Report. An ETA is calculated for every stop and toll plaza on the route. If a target arrival time is specified, the estimated time of departure (ETD) needed at the origin to meet the ETA goal will be calculated as well. The Time Zone Display option affects how dates/times are reported (not how they are calculated) and can be set to:

Local: Reported ETA/ETD will conform to the time zone where each stop or toll plaza is located.



System: ETA/ETD at stops and toll plazas will be reported based on the time zone setting on the host computer.

Specific: Select a time zone by region. ETA/ETD at all stops and toll plazas will be reported using this time zone.

Note that, when using time-based routing, the calculated ETA/ETD reflects driving times only. Stop durations, break times and border wait times must be specified separately.

6.1.10 Using Traffic Data For Time Estimates (OptionsType input structure; UseTrafficData element) For routes in the U.S. and Canada, time-based routing can be generated using industry-leading INRIX traffic data; and conversely, traffic data may be used whether or not an arrival or departure time has been specified. Using traffic data increases the precision of time estimates. If you choose not to use traffic data, travel times and ETA’s will be calculated in the same manner as in previous versions of PC*MILER, based on average road speeds by class of road in each state/province. Traffic data is collected by road segment. With the Use Traffic Data option turned on, travel times and ETA’s will be calculated based on historical, typical and/or real-time traffic data, depending on the arrive/depart and day/time settings. “Historical” data reflects how average traffic patterns affect road speeds on the road segments used by the generated route. (An “average” pattern is created using a historical time slice: 7 days in a week, with each day divided into 15-minute time slices.) “Typical” data uses road speeds that would occur if there were no traffic on those road segments. “Real-time” data is just that: current traffic patterns that are fed into the system in real-time. If Depart is selected and the day/time is within 15 minutes of the current time, real-time traffic data will be used for the first 15 miles and Historical data will be used for the remainder of the route. When Arrive is selected, Historical data is always used. If day/time information is unknown (Depart/Arrive is blank), Typical data will be used.

6.1.10.1 Time-Based Routing in Reports

After a route has been generated, estimated arrival and departure times at all stops on the route are shown in the Mileage Report in the ETA/ETD column to the far right. This column is inactive when an arrival or departure day/time has not been entered. ETA/ETD information also appears in the far right column of the Detailed Route Report if a day/time was entered for the route. This report column will show the estimated times of arrival at every stop and toll plaza on the route. If a target arrival time was entered, the estimated necessary departure time from the origin will be shown. If a departure time was entered, it will be shown at the origin.



6.1.11 Hazardous Material Routing (OptionsType input structure, HazMatType element; and GetReport API, TripOptions parameter) If Hazardous Materials Routing is available in your login level, you can run routes for various types of hazardous materials using any PC*MILER route type. PC*MILER calculates routes for hazardous materials based on over thirty different road categories. Route options when North America is selected as the region include: General, Corrosive, Explosives, Flammable, Inhalants, and Radioactive. When Europe or Oceania is the selected region, the options are: General, Explosives, Flammable, and Harmful to Water. The default option is None, which generates a normal (non-hazmat) PC*MILER route. Table 1 on the next page shows how each PC*MILER hazmat route type handles each hazmat road category.


PC*MILER Web Services User’s Guide

TABLE 1: PC*MILER Hazardous Material Route Types and Road Categories

favor = routing will prefer these segments no change = routing will not be altered in any way avoid = routing will go around these segments whenever possible discourage = a lesser degree of avoidance, used when a state or road authority allows hazmat only at certain times of day, with

prior notification, by permit, or in limited quantities, and for tunnels not otherwise classified

(continued on next page)



NOTE: U.S. hazardous material routing restriction/designation information taken from The National Hazardous Materials Route Registry provided by the Federal Motor Carrier Safety Administration (FMCSA); and various other state and federal sources. Canadian hazmat/dangerous goods routing data derived from government and municipal sources in each Province and Territory, and includes restrictions for major Canadian bridges and tunnels. NOTE: Canadian dangerous goods routing data is derived from government and municipal sources in each Province and Territory, and includes hazmat restrictions for major Canadian bridges and tunnels.



TABLE 2: U.S. DOT Hazmat Classes and Corresponding PC*MILER Hazmat Route Types The table below shows how the wording used for PC*MILER hazmat routing options, which is derived from industry-standard placarded descriptions of hazardous materials, corresponds to the U.S. Department of Transportation Hazmat classifications.

U.S. DOT Hazmat Classes (corresponding PC*MILER routing options are bolded):

Class 1: Explosives – Explosive Class 2: Compressed Gases 2.1: Flammable Gas – Flammable 2.2: Non-Flammable Compressed Gas – General 2.3: Poisonous Gas – Inhalant

Class 3: Flammable and Combustible Liquid – Flammable Class 4: Flammable Solids 4.1: Flammable Solid – Flammable 4.2: Spontaneously Combustible Material – Flammable 4.3: Dangerous When Wet Material – General Class 5: Oxidizers – General Class 6: Poisons 6.1: (part) Inhalation Hazard – Inhalant 6.1: (balance) – General 6.2: Infectious Substance (Etiologic agent) [“Biohazard”] – General Class 7: Radioactive Materials – Radioactive Class 8: Corrosive Liquids – Corrosive (“Caustic” in PC*MILER 22 and earlier) Class 9: Miscellaneous – General

Routing Multiple Hazmat Classes

For routing a single shipment containing multiple hazmat classes, the following procedures are suggested:

1. First, determine the weight of each commodity and check the U.S. DOT (PHMSA) rule to see if that combination is permissible and if so, which placard(s) are to be used.

2. Then, for each placard, look up the PC*MILER|Hazmat routing options in the table above. a. If all the placards correspond to one routing option, use that option.



b. If the placards correspond to multiple routing options, then run the route for each option, and: i. If all the routes are the same, that common route is the route to be used. ii. If the routes are different, then there may or may not exist a legal route for that combination of commodities

for the specified origin/destination (this will occur only rarely).



6.1.12 Trip Costs (See sections 2.2 – 2.10 for time and cost option settings.) PC*MILER calculates a total cost for each route generated. This cost estimate is determined by multiplying a dollar amount per mile or kilometer by the number of miles. The cumulative cost for each trip is calculated, along with leg and total mileage, time and cost estimates. The trip costs that go into the dollar amount per mile/kilometer have been broken out into fuel costs, labor costs, and “other” maintenance or miscellaneous costs in addition to stop costs (for stop cost explanations, see section 6.1.13 below). For information purposes only, a greenhouse gas emissions value is also included. If available in your login level, the Least Cost routing option (use ReportType with the GetReport API) considers user-specified values for miles per gallon/liter, cost per gallon/liter, fuel cost per mile/kilometer, other costs per mile/kilometer, other cost per hour, cost of time per hour, and stop costs – and includes a parameter for a greenhouse gas emission estimate. Least Cost routing generates a series of alternative routes with distance, time and cost estimates, and lets the dispatcher or driver (or an external system, such as a truck dispatch optimization system) choose an optimal route, considering factors such as those cited above that are external to the route. The PC*MILER default settings for fuel cost per gallon or liter are as follows for all world regions (in U.S. dollars):

If Gallons are the unit of measure = $3.94 If Liters are the unit of measure = $1.0408

The table below shows PC*MILER trip cost default values for all world regions, using gallons, miles and US dollars:

Element Structure PC*MILER Default Value CostofStop StopCostsType 0 Hours PerStop StopCostsType 0 Loaded StopCostsType Yes OnDuty StopCostsType Yes LoadedPerMile RouteCostsType $0.6080 UnlPerMile RouteCostsType $0.6080 MPGLoaded RouteCostsType 6.48 MPGEmpty RouteCostsType 6.48 PricePerGallon RouteCostsType $3.94 TruckStyle RouteCostsType 48 ft. semitrailer GreenHouseGas RouteCostsType 22.2 OtherCostPerMileLoaded RouteCostsType $0.19 OtherCostPerMileEmpty RouteCostsType $0.19 CostTimeLoaded RouteCostsType $36.19 CostTimeEmpty RouteCostsType $36.19 DepartTime TimeCostsType None



BreakInterval TimeCostsType 0 BreakLength TimeCostsType 0 BorderWait TimeCostsType 0

6.1.13 Stop Costs (Time and Cost Estimates for Individual Stops) (See sections 2.2 – 2.10 for time and cost option settings.) Stop Cost options enable you to assign a time and cost estimate for each individual stop on the route. You can also indicate whether the stop time you entered is on-duty or off-duty, whether to include the time and cost estimate for the origin in the totals for the route, and whether the leg between stops is a loaded move or a backhaul. Combined with the trip costs entered for loaded and empty miles, the Stop Costs setting determines the total cost estimate for the trip. As an example, if your route includes eight stops and you assign a 1-hour on-duty stop-off time estimate to each one, the total time estimate for the trip (driving time plus delay time at each stop) will reflect an increase of eight hours. You must indicate a stop to which you wish to assign a time and/or cost, then indicate whether the leg preceding the stop should be considered as Loaded, whether the stop time should be considered On-Duty, and enter the cost and/or time estimate for the stop. You may also choose to include the origin stop time and cost in the totals for the route. NOTE: If a Break Time is entered (see next section), the points at which breaks are indicated in the Detailed Route Report will be affected by whether the hours per stop are On-Duty for each stop. The defaults for the Stop Costs are Loaded, On-Duty, $0.00 per stop, and 0 hours per stop using the origin time and cost in the total estimates.

6.1.13.1 Additional Time

(TimeCostsType input structure) Use the Break Time setting to set the number of on-duty hours allowed between breaks and how many hours each break should be. These settings will determine where breaks are indicated along the route in the Detailed Route Report and Driving Directions Report. Calculations of break times take into account whether time spent at each stop is On-Duty. The default break time is 0 hours. Use the Border Wait setting to indicate any expected delay (in hours) due to a border crossing. The number of hours you enter will affect time estimates for any trip that includes at least one international border crossing, and will be included in the Detailed Route Report and Driving Directions Report.



6.1.14 Average Road Speeds (Estimated Travel Time) (RoadSpeedType input structure) PC*MILER calculates a time estimation for each generated route. This estimate is computed by summing up the estimated time traveled on each road segment on the route, using road speeds based on road type, plus an added stop-off time for each stop along the route if this was set (see section 6.1.13.1 above). There are twelve road speed classes (six road types, with “urban” and “rural” classifications for each). Each class has an average road speed parameter assigned to it. Spreading the estimated average speed over the various road classes gets a more accurate estimate of the total time traveled based on the quality of the road used. See descriptions of road classes below, also see Appendix G for default road speeds in every world region.

6.1.14.1 PC*MILER Road Classifications:

Interstate Highways The primary function of these roads is to move high volumes of

vehicular traffic over medium to long distances at high speeds Can be accessed only via access ramps Always have a barrier or median between opposing lanes of

traffic Multi-lane

Divided Highways These roads are major arteries that move heavy volumes of traffic at moderate speeds

Can be limited access in some areas but may also offer access from local roads

Usually have a barrier or median that prevents movement between lanes of opposing traffic

Medians may have crossovers that are part of the normal traffic pattern

Left turns are often restricted, both off of the highway and onto the highway

Multi-lane Many but not all US highways are in this class

Primary Highways These roads move significant volumes of traffic at moderate speeds

Most state roads fall into this class Secondary Roads These roads move moderate volumes of traffic over short to

moderate distances Serve to carry vehicles from local roads to higher class roads

Local Roads Function is to provide access to homes and properties Ferries Ferry routes (boarding/exit time not included)



6.1.15 Route Optimization (GetMapRoutes API, TripStopsOptimize parameter) Route optimization reorders all the stops in the active route to minimize the total time (when using Practical routing), the total distance (when using Shortest routing), total toll distance (when using Toll Discouraged routing), and distance of the National Network (when using the National Network or 53'/102'' Trailer or Twins routing). In other words, route optimization returns the optimal order of stops for your route. The following route optimization options are available:

Route Through All: Allows PC*MILER to sequence the stops in any order, with the origin remaining fixed.

Destination Fixed: Optimize stops, keeping the origin and destination the same.

NOTE: You need at least three stops to optimize with “Route Through All” and four stops for “Destination Fixed”.

Remember that optimization cannot be undone; the original order of stops cannot be recovered, so you may want to save the original route before optimizing.

6.1.16 Borders Open

(OptionsType input structure, BordersOpen element) For Lite, Standard and Premium users this option applies to Intra-US, Intra-Canada, and Intra-Mexico routing. For Worldwide users, it affects international borders in every world region. If BordersOpen is set to “yes” (this is the default), the generated route will ignore international boundaries when necessary to create the best route. If this option is set to have borders closed, the borders will never be crossed; for example, if all your stops are in the United States, the resulting route will stay in the United States even though the most practical or shortest route would normally involve some Canadian mileage.

6.1.17 Highway Only

(OptionsType input structure, HighwayOnly element) With highway-only routing, routes are calculated using an air distance from the midpoint of the highway segment that is nearest to the destination postal code or city/state. Routes to stops that include a street-level address are calculated to the highway-level road that is closest to the entered address. This functionality matches the base PC*MILER highway product. Highway-only routing is the default for this setting. If HighwayOnly is “no”, PC*MILER calculates the route and driving distance using local streets between the nearest highway segment and the stop. All stops, whether they contain a street-level address or not, clean up to the nearest road (highway or street level).



6.2 Adding Stops To a Route (LocationInputType and PointSearchType input structures) You may enter an unlimited number of stops along a route. PC*MILER will always treat the stop at the top of the stop list as the origin of the route and the last stop on the list as the destination unless you are generating hub distances. The following are valid stop inputs:

City names, followed by their corresponding state or country abbreviation; street addresses may be included if street-level data is available for your Feature Option Level.

3-digit or 5-digit US ZIP Codes, or selected postal codes 6-character Canadian Postal Codes 9-character SPLC Codes Latitude/longitude points

Locations may also be truck stops, CAT Weigh Scale or state weigh stations, or custom places (PointSearchType input structure, SetMapCustomPlace and GetCustomPlace APIs).

6.2.1 City Name and State/Country Abbreviation

VERY IMPORTANT FOR WORLDWIDE FEATURE LEVELS: You must have the proper region selected when you enter a location (LocationInputType input structure, Region element) . If the wrong region is selected, normally either an error message will appear or your input will be matched with a city by the same name in the selected region; for example, if you enter “Paris, FR” when your region is North America, “Paris, AR” will be returned as a stop. However, in certain cases the above rule does not apply. Because trans-regional routing between Europe, Asia, and Africa is now possible, locations can be entered that do not match the selected region when any of these regions are selected. For example, entering “Paris, FR” will return the correct stop if Asia or Africa is the selected region. (LocationInputType input structure, City and State elements) The city name can be any length. The city and state/country do not need to be capitalized, but do need to be separated by either a comma or a space, as in these examples:

chicago, il chicago,il paris fr

If the city name contains two or three words, each portion of the city name must be separated by spaces, for example:

los angeles, ca los angeles,ca salt lake city ut



Mexican place names do not have postal codes. They are entered using a city name plus a two-letter ISO abbreviation. For example:

puerto vallarta, ja or valparaiso, zt Country abbreviations may be entered using FIPS 2-character, ISO 2-character, ISO 3-character, GENC 2-character, or GENC 3-character codes. By default, FIPS codes are accepted. See Appendices C and D in this User’s Guide for a complete list of state and country names and abbreviations.

6.2.2 Address Entry (U.S.,Canada and Europe only) (LocationInputType input structure, Address1 and Address2 elements) If street-level data is available in your Feature Option Level, you can – optionally – specify a street-level address. See Appendix G for valid directional and street type synonyms. HINT: If you enter a ZIP Code and PC*MILER can’t find an address you specify within that ZIP, try expanding your search by entering the city name instead of the ZIP Code.

6.2.3 Entering ZIP and Postal Codes (LocationInputType input structure, ZIP element) Entering a valid 5-digit ZIP Code, 3-digit ZIP Code centroid (e.g. 085 for the area around Princeton, NJ), or international postal creates a search for the corresponding city and state/country name. The selected city name will be accepted as a stop, along with the state abbreviation, county designation, and ZIP Code. If you enter: 08540 (NA region), PC*MILER will return: 08540 Princeton, NJ, Mercer. If you enter: 085, PC*MILER will return: 085, NJ. If the only ZIP Code assigned to a U.S. city is a PO Box ZIP Code, then it is included the PC*MILER database. Also, if the United States Postal Service has designated a street address for a PO Box ZIP Code, it’s included as well. However, if you enter a PO Box that does not fall into either of these categories, you will receive the following error message: “This is a non-routable PO Box”, alerting you to try another ZIP Code.

IMPORTANT NOTE FOR WORLDWIDE FEATURE LEVELS: When you are entering postal codes outside of North America, you need to enter a country abbreviation to avoid being routed to the wrong country in cases where the same postal code exists in more than one country. Enter the postal code, a comma, and the correct two-letter country abbreviation; e.g. “46001, sp” for Valencia, Spain. Remember that the correct region must be selected. Not all countries have postal codes in the database. Users can import absent Postal Codes as Custom Places if needed.



6.2.4 Canadian Postal Codes (LocationInputType input structure, ZIP element) If Canadian Postal Codes are available in your Feature Option Level, a list of six-digit Canadian postal codes is available for stop entry. The codes are always a combination of letters and numbers in the following format: L#L #L#. Entering any valid Canadian postal code will invoke a search for the corresponding city and province name, and these will be entered as a stop along with the postal code. If you enter: K7L 4E7, PC*MILER will return: K7L 4E7 Kingston, ON. NOTE: For Canadian codes, there must be a space between the first three characters and the last three characters.

6.2.5 SPLC (Standard Point Location Codes) (U.S. only) (LocationInputType input structure, SPLC element) If SPLC are available in your Feature Option Level, a SPLC can be entered as a stop for any location in North America that has a SPLC assigned to it. SPLC may be six or nine digits in length. SPLC data used in PC*MILER products is owned, maintained and copyrighted by the National Motor Freight Traffic Association, Inc.

6.2.6 Latitude/Longitude Points (LocationInputType input structure, Lat and Long elements) PC*MILER enables you to enter latitude/longitude points as stops on a route. Latitude and longitudes are in millionths of degrees. To convert decimal degrees to millionths of degrees, multiply by 1,000,000. For example, the longitude of 119.802990*1000000 = 119802990 and the latitude of 35.526076*1000000 = 35526076.

Converting between formats: To convert from degrees-minutes-seconds to decimal degrees use the following formula: dddmmssN ddd + mm/60 + ss/3600.

6.2.7 Truck Stop Locations (U.S. and Canada only) (PointSearchType input structure, POITruck element) The syntax for truck stops when shown on the map is comprised of the "at" symbol [@] marking the entry as a truck stop. Truck stops are represented on the map by small blue gas pump icons ( ). These icons

can be seen when you are zoomed in to detail level 5 or higher.

6.2.8 CAT Scale Weigh Stations (U.S. and Canada only) (PointSearchType input structure, POICat element) CAT Scale weigh station locations ( ) may be entered as stops on a route.



6.2.9 State Weigh Stations (U.S. only) (PointSearchType input structure, POIWS element) You can also search for and enter state weigh stations as stops.

6.3 Reports

(Refer to section 3.1, PMWSGetReport API.)

6.3.1 Trip Distance Report The Trip Distance Report displays PC*MILER industry standard mileage for one trip.

6.3.2 Batch Trip Distance Report (See Example: Batch Report Request in section 3.1) The Batch Trip Distance Report displays PC*MILER industry standard mileage for multiple trips that were batched into one API call.

6.3.3 State/Country Distance Summary Report After a route is generated, you can generate the State/Country Distance Report to display a summary of mileage by state and country traveled. Toll/free, empty/loaded, and ferry mileage are calculated in addition to total miles. If toll costs were calculated, those costs will be included in this report.

6.3.3.1 Order of States in the State/Country Distance Summary Report

In the State/Country Distance Summary Report, the states and countries are normally displayed in alphabetical order (this is the default order).

6.3.4 Detailed Route Report The Detailed Route Report provides detailed route information including direction of travel, roads, interchanges, stops, scheduled break times, empty/loaded status at each stop, on-duty stop times and costs, leg and cumulative times and distances, toll costs (if toll calculation is turned on), and more, depending on the optional parameters used to generate the route. The columns from left to right in the Detailed Route Report give you the following information for each route segment: state/country, toll or free road, turn direction, route (including exit number where available), segment distance, driving time, interchange point, leg mileage and time, cumulative trip mileage and total trip time. If toll costs were calculated, the report will include toll costs by trip leg and the corresponding toll plazas on the far right.



If day/time information was specified for the route, the last column on the right will show ETA/ETD at each stop and toll plaza, with times reflecting the time zone that was set or the default (local time). If a target arrival time was entered, the estimated departure time from the origin will be shown. If a departure time was entered, that time will be shown at the origin. A dollar sign ( $ ) marks segments that are toll roads. Alerts such as height, weight, and 53'/102'' restrictions are noted where they exist, appearing before the pertinent road segment in the report. NOTE: (Applies to North America) Due to the way PC*MILER identifies locations and calculates routes and distances, occasionally a toll barrier won’t be reported in the Detailed Route Report. When this happens anywhere on a route, an alert will appear at the very bottom of the report stating that this has occurred. You can then check all route segments marked with a dollar sign to find the omission.

Reflecting specified time/cost parameters, this report may include a time and cost for each stop, the empty/loaded status for each leg, a border wait time, and the time at which a break should be taken if the number of on-duty hours allowed between breaks was specified for the route. If Hazardous Material Routing is accessible in your Feature Option Level, the Detailed Route Report will include a Restriction column. If you generate a route using one of the hazardous material route types, restricted route segments will be labeled with the appropriate hazmat restriction type. (PC*MILER uses these route segments in its calculations only if no other alternative is possible, or the alternative is extremely impractical.)

6.3.5 Driving Directions Report The Driving Directions Report (in PC*MILER, the “Driver’s Report”) generates easy-to-read detailed driving instructions, including break times, turn direction and distance between turns. This report includes all alerts that appear in the Detailed Report.

6.3.6 Road Type Report The Road Type Report generates a distance breakdown by PC*MILER road category for the active trip. This report does not report total mileage per route. If you are looking for a comprehensive report calculating mileage totals, please generate the Detailed Route Report or the State/Country Distance Report.



6.3.7 Condensed Directions Report This report provides seven (7) levels of condensed directions as shown in the table below.

Condense Level

Information Provided in Output File

Level 0 Provides the least amount of characters in the direction report

Level 1 Provides the turn instruction and distance to travel

Level 2 Turn instruction, distance, and time

Level 3 Turn instruction and Interchange (i.e., more information about the road)

Level 4 Turn instruction, distance, and Interchange

Level 5 Turn instruction, time, and Interchange

Level 6 Turn instruction, distance, time, and Interchange

Examples:

The following is an example of Level 1 output from Edison, NJ, to Hatboro, PA (30 characters):

S Reed St 0.0 L Central Ave 0.1 R Plainfield Ave 1.2 S US 1 21.7 S I 95 11.5 BR X 49 0.2 W PA-332 14.5 R E Montgomery Ave 0.2 S PA-263 0.4 The following is an example of Level 5 output from Princeton, NJ, 1000 Herrontown Rd to Warminster, PA,1174 Nassau Rd (304 characters):

S Herrontown Rd 0.0 + Herrontown Rd US 206 S US 206 8.8 + US 206 Ramp S I 95 9.6 + I 95 X 49 BR X 49 0.2 + X 49 PA-332 W PA-332 11.5 + PA-332 W Bristol Rd R W Bristol Rd 2.2 + W Bristol Rd Log College Dr L Log College Dr 0.3 + Log College Dr Nassau Rd L Nassau Rd 0.1 1174 Nassau Road, Warminster, PA, 18974



Turn Instruction Abbreviations: S = South BR = Bear Right

N = North BL = Bear Left

W = West L = Left

E = East R = Right

X = Exit Str = Straight

6.3.8 ETA/OoR Report (GetETAOutOfRoute API) This report returns estimated time of arrival (ETA) and Out-of-Route (OoR) distance from a vehicle’s current positional longitude and latitude. Following is an explanation of how ETA’s and OoR’s are calculated. ETA and OoR calculations assume that each truck’s planned route is using a PC*MILER route. By default, PC*MILER Practical routes are used, but the route type can be changed to Shortest, National Network, 53' Trailer or Twins, or Toll Discouraged.

6.3.8.1 OoR Calculation

OoR miles are estimated as follows: in the illustration below, a truck’s planned route goes from point A to point B (black line), and the truck is currently at point C.

In this scenario, the distance from A to C and the distance from B to C are added, then the distance from A to B is subtracted from that number. So, the estimated OOR miles for this truck would be 5 (105 – 100). (DTR miles in the illustration reflect the driving distance from a truck’s current position to the closest major intersection along the planned route.) All distances are based on a PC*MILER route between each set of points (A to B, B to C, C to A). For example, let’s say you have a truck going from Bridgeport, CT to Pittsburgh, PA. In Pennsylvania, the planned route starts on I-80, takes I-99 around State College, PA, and then



takes US-22 into Pittsburgh. Your driver, needing a detour around a major traffic accident, opted to stay on I-80 before State College instead of following the Practical route. This is not a bad alternate route if he stays on I-80, although it is slightly longer and takes more time than the PC*MILER Practical route. However, suppose the vehicle in question leaves I-80 and travels north on I-180 to Williamsport, PA. In this case, the OoR calculation may point to a problem that needs to be addressed.

6.3.8.2 ETA Calculation

Each estimated time of arrival (ETA) is calculated from a vehicle’s origin, destination, and current position. Fleetsuite runs a route between a vehicle’s current location and its destination, and the time estimate for that route is used to estimate a time of arrival.

6.3.9 Fuel Optimization Report This report lists the suggested locations for purchasing fuel, and for each location shows how much fuel to purchase and the cost of the fuel. See section 6.4 below.

6.4 PC*MILER|Fuel Optimization (U.S. and Canada only) FuelAdvice®.com has partnered with ALK Technologies to provide you with our PC*MILER fuel optimization service. If you purchased PC*MILER Web Services at the Premium or Enterprise Feature Option Level, you can generate truck-specific fuel and trip plans based on daily fuel prices. To get started, you’ll need to be connected to the Internet and follow the instructions for setting up an account on www.fueladvice.com. As soon as your account has been set up, you can begin using the PC*MILER|Fuel Optimization service. Refer to the following input and output structure definitions: FuelOptType (input), and FuelStopLineType, FuelSummaryType, FuelReportType (output). To generate fuel optimization reports, you need the following information: Login ID (the user ID and password set up on www.fueladvice.com), Fuel Capacity (the vehicle’s total fuel capacity in gallons), Level (the vehicle’s current fuel level in gallons), and MPG (the fuel consumption rate in miles per gallon). PC*MILER Web Services will generate the route you specify and add fuel stops at optimal re-fueling locations during the trip. NOTE: There are over 50 fueling networks available such as Flying J, Love’s, Speedway, etc. These options can be reviewed on the www.fueladvice.com web site.



6.5 PC*MILER|Tolls (U.S. and Canada only) (Elements related to toll calculation may be included in the following APIs and structures: OptionsType, PMWSGetReport, DtlLineType, StpLineType, OORLineType, and SCLineType.) If you purchased PC*MILER Web Services at the Premium or Enterprise Feature Option Level, you can generate accurate, up-to-date toll costs for U.S. and Canadian lanes with these costs integrated directly into the routing database and reported turn-by-turn per trip. Columns for toll costs appear in the Detailed Route Report and State/Country Summary Report, and tolls can be reported in the currency of choice – either U.S. or Canadian dollars. The PC*MILER|Tolls module generates up-to-date, truck-specific toll costs for toll roads, bridges, tunnels, and border crossings for U.S. and Canadian toll authorities. The data provided includes:

Both cash and discount toll program transactions.

Range (ticket) and barrier (coin drop) data in addition to two-way tolls, one-way tolls, and tolls that vary by direction.

Three mid-release toll data updates to ensure toll cost accuracy throughout the year.

Time-of-day variations factored into truck-specific toll rates when and where they occur, including peak and non-peak tolls, if time-based routing is active in the route entry window.

Toll rates for smaller 2-axle vehicles when automobile routing is generated.

Future expected toll rates included as available.

Thirty-seven (37) discount toll programs throughout the U.S. and Canada (states in which each program apply are listed below).

States/Provinces Where Each Discount Program Applies:

SPECIAL NOTE: The “EZPass-WV” or “EZPass-NJ” options apply to those who purchased the EZPass service in West Virginia or New Jersey.

Discount Program Valid In Discount Program Valid In

407 ETR Transponder ON Canada I-Pass IL A25 Transponder QC Canada K-Tag KS A30 EXPRESS Transponder*

QC Canada

Laredo Trade Tag TX

BreezeBy OR LeeWay FL C-Pass FL MACPASS NS Canada Cruise Card GA NC Quick Pass NC Downbeach Express Pass*

NJ

NEXPRESS TOLL MI ON Canada

E-Pass TX

NEXUS* NY ON Canada

E-Pass Canada NS Canada Palmetto Pass SC



(PAL PASS) EXpressToll CO Peach Pass GA EZ Tag TX PikePass OK

EZPass

DE, IL, IN, ME, MD, MA, NH, NJ, NY, NC, OH, ON (Canada), PA, RI, VA, WV

Quickpass BC Canada

EZPass-NJ NJ Smart Tag VA EZPass-WV WV StraitPASS PEI Canada

FAST LANE MA and all E-ZPass-equipped facilities

SunPass FL

FasTrak CA TollTag LA, TX GeauxPass LA TReO* BC Canada Good To Go WA TxTag TX GO-PASS CO Wabash Pass IN

* New in Version 27.

The following discount programs have been discontinued in the database:

Discontinued Program

State Versions Available

Version Discontinued

Reason

I-Zoom IN 21-26 27 Replaced by EZPass B-Pass NB 17-25 26 Toll discontinued M-Tag MD 17-23 24 Replaced by EZPass NH Tokens NH 17, 18 19 Replaced by EZPass O-Pass FL 21-23 24 Absorbed into SunPass Ready Toll OH 17, 18 19 There is no discount

associated with this program, it’s simply a “debit card” used to pay tolls.

Transpass ME 17- 23 24 Replaced by EZPass

GENERAL NOTE on TOLL RATES: Unless the vehicle dimensions and/or axle setting have been customized using TruckConfigType, PC*MILER|Tolls calculates toll costs for an 80,000 pound, 5-axle vehicle. Reported toll amounts are accurate and up-to-date, but not always exact due to several factors: first, several – though not many – toll roads have rates that are based on weight; second, some toll charges (in various states) are time-of-day driven, and in this case, tolls will be calculated using the highest (peak) rate unless PC*MILER’s new time-based routing is used; and third, future and proposed toll rates are incorporated into the database where appropriate and these rate changes may occasionally be cancelled at the last minute. NOTE: Some toll exits in the U.S. and Canada have recently become “electronic only”; for example, starting December 1st, 2008, the 183A toll road in Texas has become cashless. The way to pay for this toll road is either by TXTag (their electronic toll payment method) or Pay By Mail. Pay By Mail is for those who don’t have the electronic discount program – their license plates get



photographed and a bill is mailed to the owner. Commonly referred to as “video tolling” or “video billing”, the rates for this payment method are higher to cover processing costs. All Pay By Mail and video toll rates are considered as “Cash” in PC*MILER toll rate calculations.

NOTE: Those who purchased the EZPass service in West Virginia should choose the “EZPass-WV” program option when calculating toll costs. NOTE: Toll costs on the New York State Thruway for “5-axle 48’ Trailer” and “5-axle 53’ Trailer” vehicles are now accurately reported. The N.Y. Thruway lists separate toll rates for these vehicle types and now PC*MILER|Tolls has been calibrated to report the correct rate depending on the routing option selected. If the Vehicle Dimension length is set to 53’ in the Options dialog box, the corresponding 5-axle 53’ Trailer toll cost will be reported.

6.5.1 Time-Based Toll Cost Reporting Prior to Version 25, PC*MILER calculated toll costs based exclusively on peak hour rates while factoring in vehicle dimension settings that affect those rates. In Version 25 and higher, when a departure or arrival day and time is entered, truck-specific toll costs can be calculated even more precisely because time-of-day variations are factored into toll rates when and where they occur, including peak and non-peak tolls. NOTE: When calculating ETA’s, toll costs will always be calculated in the local time as the planned route crosses the toll booth. If you wish to report the date/time of the toll collection in the local time that was used for tolls calculation, you need to set the time zone setting to Local Time. This is the current default for PC*MILER when you install the program out of the box. If you change the time zone display setting to a system or specific time zone, the date/time of the toll collection will be reported in the time zone specified by that setting.

6.5.2 Customizing Toll Costs by Weight and Axle Jurisdictions in the U.S. and Canada that have toll roads class their toll rates either by vehicle weight or by a vehicle’s number of axles. Setting the vehicle’s dimensions, using TruckConfigType referenced as part of the OptionsType structure (see section 2.5 and 2.6), enables toll cost reporting based on vehicle weight and number of axles. The available toll rates by axle are from 2 up to 14 axles, including multi-trailer or longer combination vehicle rates and automobile routing. Weights up to 132,000 lbs. or 59,874 kg. are acceptable. For toll rates categorized by weight, each toll road authority publishes its own definition of weight classes, and PC*MILER categorizes and reports these toll rates based on the published weight category and range provided. For those who are new to the arena of toll cost reporting, the jurisdictions that charge toll costs by weight and those that charge by axle are identified below. This information is



important to know if you intend to use PC*MILER Web Services APIs to generate toll costs that are customized by weight and axle.

Jurisdictions Charging Tolls by Vehicle Weight: MI, NJ, NS, ON, PA

Jurisdictions Charging Tolls by Axle: AL, AK, BC, CA, CO, DE, FL, GA, IN, IL, KS, LA, MA, ME, MD, MI, MN, NB, NH, NJ, NS, NY, OK, OR, PA, PEI, RI, SC, TX, UT, VA, WA, and WV

IMPORTANT NOTE: Twin trailers with 7 or more axles are not allowed on the Massachusetts Turnpike east of Exit 14. If you enter 7 or more axles for a longer combination vehicle, PC*MILER will return a $0 toll rate for that section without a warning. NOTE: Two-axle toll costs in the database include two axle dual rear wheel vehicles only. NOTE: The New York State Thruway lists separate toll rates for “5-axle 48' Trailer” and “5-axle 53' Trailer” vehicle types. When generating a route, PC*MILER now reports “5-axle 48' Trailer” toll costs as the default unless users actively set the trailer length to “53” in the Vehicle Dimension to report “5-axle 53' Trailer” toll costs. (BE AWARE: Changing the routing option to “53' Trailer or Twins” will not impact toll cost calculations.)

6.6 infoUSA Points of Interest on the Map (U.S. only) (PointSearchType input structure) PC*MILER now offers as a standard feature the ability to search, display and route to 12 million points of interest (“POI”) from infoUSA’s U.S. business database. Truck stops, weigh stations, business locations, and other landmarks are included. POI are represented on the RouteMap by icons that indicate a POI category as shown below. On the RouteMap you will see map pins identifying such locations and other related locations as follows:

Airport Geographic Features 1 Police Station

Attractions Government Railway Station

Auto Dealership Grocery Store Rent A Car

Bank Guest House Rest Area

Border Crossings Highway Exit Restaurant

Bridges & Tunnels Hotel or Motel Retail

Bus/Taxi/Limo Intermodal Ramp ‐ Large RV Services

CAT Scales Intermodal Ramp ‐ Medium Schools & Universities



City Hall Intermodal Ramp ‐ Small Sports & Recreation

Custom Places LCV Lot 2 Travel & Transportation

Diesel Exhaust Fluid Marina Truck Services

Emergency & Medical Municipal Vehicle Repair

Entertainment Other Weigh Station

Event Facility Parking Different POIs grouped together at same location

Ferry Terminal Parks

Gas Station Places of Worship

_______________________________________________

1 Geographic Features icons identify the location of naturally occurring features on the

earth’s surface. This category groups several geographic features together, including the following:

Arches Benches Cliffs Flats Islands Oilfields Ridges Swamps Arroyos Bends Craters Gaps Isthmus Pillars Slopes Valleys Basins Canals Crossings Glaciers Lavas Plains Springs Wells Bays Capes Dams Guts Levees Ranges Streams Beaches Channels Falls Harbors Mines Rapids Summits

2 Most LCV lots require gate permits and are reserved for authorized, certified and

registered companies only. Before you plan on utilizing these areas or using them in route calculations, please make sure you’ve obtained the proper permits.

6.7 Mapping and Map Options

6.7.1 Map Controls

Detail > Add to, reduce or return to the default number of roads, road names and place names drawn on the map. (Choose More, Less, or Default).

Legends > The legends available on the RouteMap with the Lite or Standard feature option level are: Road, Route and Scale of Miles. At the



Premium level, a Restrictions legend for HazMat routing and Traffic legends for the Traffic Display option are available.

Road Legend: See section 6.1.14.1, PC*MILER Road Classifications, for further descriptions of these road classes.

Restrictions Legend:

Scale of Miles:

Route Legend:

Traffic Legends:

Traffic Congestion in Real-time

Historical Road Speeds

6.7.2 Mapping Icons A mapping icon is a text string usually, but not always, composed of two parts: type and color. Since Version 21, a file extension is no longer needed. Available icons are shown below (examples are scaled larger than true size). You can make and use your own icons as well.

NOTE: Size the canvas first before beginning to paint your bitmap. Files must be in

.BMP or .PNG format to load, but do not need a file extension.



Available Icons (not true size):

Warehouse Large Truck Package

Tag Large Pushpin Circle

Trailer Large Package Box

Truck Large Warehouse Large Box

Pushpin Large Tag

ICON COLORS Filename EXAMPLE

Warehouse Red, Green, Blue, Yellow, Pink, Darkblue, DarkYellow bldg_r Tag Yellow, Green, Pink, Blue tag_y Trailer Red, Yellow, Green, Blue trler_bl Truck Red, Yellow, Green truck_g Pushpin Yellow, Green, Blue, Purple pin_y Package DarkYellow package Large Truck Red, Yellow, Green, Blue ltruck_bl Large Pushpin Yellow, Green, Blue, Purple lpin_pu Large Package DarkYellow lpackage Large Warehouse

Red, Green, Blue, Yellow, Pink, DarkBlue, DarkYellow lbldg_r

Large Tag Yellow, Green, Pink ltag_p Box Red, Blue, Green, Yellow, Gray, White, DarkGreen,

DarkYellow, DarkBlue, DarkGray box_dbl

Large Box same as above lbox_y Circle Red, Blue, Green, Yellow, Gray, White, DarkGreen,

DarkYellow, DarkBlue, DarkGray circle_r

| 186


ALK Technologies, Inc., headquartered in Princeton, NJ, was founded in 1979 as a transportation industry pioneer. ALK harnesses the power of information technology to enhance transportation and mobility, supporting competitive advantage and improved quality of life. Today, ALK is a global leader in GeoLogistics™ and navigation software. GeoLogistics is our portfolio of specialized enterprise solutions for worldwide routing, mileage and mapping, used by customers in transportation, logistics, manufacturing, mobile workforce management and government. Our commercial trucking applications are relied upon by companies worldwide and our in-vehicle GPS navigation and route guidance solutions are among the most award-winning solutions in the world. We pride ourselves on being a market leader in transportation and travel technology. ALK's leadership in applying that technology to solve important problems continues as strongly today as when we began over 30 years ago. Now part of Trimble's (NASDAQ: TRMB) international Transportation and Logistics division, we remain committed to providing our customers with solutions that work for them to lower costs, improve service and safety and minimize harm to the environment. See section 6.1 below for an overview of ALK’s Enterprise Solutions. For detailed product information, visit us at www.alk.com or www.pcmiler.com.

Chapter 7: About ALK Technologies

Chapter 7: About ALK Technologies | 187


7.1 Enterprise Solutions from ALK Technologies

PC*MILER — PC*MILER is truck-specific, point to point routing, mileage and mapping software that the transportation and logistics industry depends on to succeed. Accuracy and reliability have positioned PC*MILER as the software used by 98 of the top 100 motor carrier, 46 of the top 50 freight transportation firms and 48 of the top 50 logistics companies in North America. The U.S. Department of Defense (DoD), the General Services Administration (GSA) and the Federal Motor Carrier Safety Administration (FMCSA) also rely on PC*MILER as their worldwide distance standard.

PC*MILER|Traffic — PC*MILER|Traffic calculates more accurate transit times and ETAs with real time, historical and predictive traffic speed data. It allows visualization of traffic trends directly on the PC*MILER map. PC*MILER|Traffic includes a “Fastest” routing type that optimizes overall transit time, taking into account real time traffic congestion and predictive traffic speeds, by the hour and by the day.

PC*MILER|Tolls — PC*MILER|Tolls calculates truck-specific toll costs based on a vehicle’s weight, axle count, trailer count, transaction type (cash or discount program), and time of day travel in the U.S. and Canada. It is driven by the same technology and map dataset as ALK's industry-standard PC*MILER routing, mileage and mapping software. When generating routes, truck-specific toll costs are added into a route’s overall calculation. Determine whether it's more cost-effective to take a toll route, or a non-toll route with a few additional miles, before routing a vehicle.

PC*MILER|HazMat — PC*MILER|HazMat generates point to point and

street-level routes, mileage and driving directions for hauling hazardous materials and dangerous goods in the U.S. and Canada. Federal government mandates state that shippers and carriers are to implement security plans regarding the transport of hazardous materials. A major step in that process is providing drivers with routes and mileage that ensure compliance with these federal, state/province and local restrictions and route designations. To ensure fleet and driver safety, PC*MILER|HazMat identifies where drivers should legally be traveling for the particular type of hazardous commodity they are hauling.

PC*MILER|Fuel Optimization — (Available with PC*MILER|Connect, PC*MILER Web and/or PC*MILER Web Services only) PC*MILER|Fuel Optimization determines where to purchase the most cost-effective fuel and tell drivers where to find it. With PC*MILER|Fuel Optimization, optimized fuel purchase plans based on daily fuel prices are seamlessly integrated into PC*MILER’s routes, reports and driving directions. The optimized fuel plan provides purchasing information within the fleet’s fueling networks, indicating where to make fuel purchases and how much fuel to buy at a given



location. With fuel prices constantly changing, optimized fuel purchase plans can save 4 to 11 cents per gallon — a conservative average annual savings of $1,100 per truck per year.

PC*MILER|Worldwide — PC*MILER|Worldwide is point-to-point routing, mileage and mapping software that generates routes, distances, maps and driving directions over the entire international highway network. Employ the functionality of PC*MILER across worldwide data coverage, including North America, South America, Europe, Africa, Asia, and Oceania. Additionally, street-level address data modules are available for Argentina/Brazil, Europe, and Australia/New Zealand.

PC*MILER|Streets — PC*MILER|Streets is street-level routing, mileage and mapping software designed to provide dock-to-dock driving directions over truck-specific routes. It includes all the features and functionality of PC*MILER plus an enhanced street-level routing network, map database, and street address database. Ensure that your vehicles and loads get to the right place using the most precise truck-specific route possible, taking into consideration truck-preferred and truck-restricted roads. PC*MILER|Streets data is available for the U.S. and Canada and, with PC*MILER|Worldwide, for Argentina/Brazil, Europe, and Australia/New Zealand.

PC*MILER|FuelTax — PC*MILER|FuelTax fully automates fuel and mileage tax tracking, calculation and reporting. The software includes easy-to-use tax forms and rates for all jurisdictions, and generates post-operations analysis reports that help identify fuel purchase and trip conflicts in self-audits. PC*MILER|FuelTax can be used as a stand-alone product or integrated with PC*MILER to automatically generate distances within the provided trip sheets.

PC*MILER|Rail — PC*MILER|Rail is the rail and logistics industry's leading routing, mileage and mapping software. Widely used in fuel surcharge calculation, equipment management, rail car mileage auditing, carrier selection, rate determination and negotiation, and ad valorem tax reporting, PC*MILER|Rail determines actual operating or fuel surcharge routes and mileage using station/state abbreviations or railroad industry codes. Through ALK’s close working relationship with all major railroads, PC*MILER|Rail features the most accurate digital representation of the North American rail network.

PC*MILER Navigator — PC*MILER Navigator is the first all-in-one GPS navigation system specifically designed for company drivers, owner operators, and leased operators to provide industry-standard PC*MILER directions in the cab. Powered by ALK’s award-winning CoPilot mobile navigation technology, PC*MILER Navigator is changing the way commercial truck drivers work, making it possible for spoken street-level directions to be generated anywhere within seconds.



CoPilot® Truck — CoPilot Truck offers an easy to use, intuitive interface with spoken turn-by-turn directions and easy to follow, non-distracting guidance displays. Unlike standard car navigation systems, it calculates efficient routes based on your vehicle profile information, routing parameters and load type, including hazardous materials. Running conveniently on a wide range of smartphones, tablets and laptops, CoPilot Truck uses street-level ALK Digital Maps™ enhanced with industry standard PC*MILER truck-specific attributes featuring 3.52 million commercial truck restrictions and allowances. With powerful multi-stop routing it effortlessly provides the optimal route for any itinerary, while automatically avoiding commercial truck restrictions to increase efficiency, reduce mileage and help avoid costly fines and vehicle damage.

CONNECTIVITY and INTERFACE PRODUCTS

PC*MILER|Connect — PC*MILER|Connect seamlessly interfaces PC*MILER routes, mileage and reports with third-party and custom systems, such as transportation and logistics management software systems. Client applications are able to retrieve PC*MILER distances, detailed driving directions, drive times, state-by-state mileage summaries, stop optimization functionalities and more.

Multi-Version Switch (MVS) — Multi-Version Switch is a high-end function of PC*MILER|Connect that serves as an integration tool designed to simultaneously support multiple versions of PC*MILER that are installed on one server or on several different servers. Instead of manually querying data from each individual version, the Multi-Version Switch functions as the main connection point to programmatically gain access to the version of choice.

PC*MILER Web Services — PC*MILER Web Services is an integration tool designed to efficiently fulfill all PC*MILER routing, mileage and mapping transactions in a simple hardware and software-agnostic system interface to any computing platform. It offers a standardized way of integrating PC*MILER with Web Services, .NET, or Web-based applications using XML (Extensible Markup Language) and SOAP (Simple Object Access Protocol) over an Internet Protocol Backbone – all developed in Microsoft® .NET.

PC*MILER|Mapping — PC*MILER|Mapping seamlessly interfaces PC*MILER routes and geographic data on maps for integration with real-time dispatch and operations analysis programs. PC*MILER|Mapping allows you to include commands in spreadsheets, databases and custom systems to obtain a visual overview of your data.



PC*MILER|Spreadsheets — PC*MILER|Spreadsheets gives you the ability to access PC*MILER features and functionality from within your own spreadsheet software. Generate point-to-point or street-level mileage and drive times within a spreadsheet program, and then use built-in functions to summarize and analyze your data. PC*MILER|Spreadsheets provides a seamless interface with PC*MILER and Microsoft® Excel®, allowing you to perform customized data analyses.

PC*MILER|BatchPro — PC*MILER|BatchPro is a batch-processing tool that permits the simultaneous processing of large volumes of lanes (set as origin/destination pairs) entered as city/state combinations, ZIP or Postal Codes, or latitude/longitude coordinates rather than entering routes individually. It gives you the ability to generate routes, mileage, as well as cost and time information per route.

PC*MILER|TCP/IP — PC*MILER|TCP/IP is an integration tool that provides an interface to PC*MILER|Connect running in a Windows® environment to an application residing on another platform. Through a TCP/IP network, client applications can access a text-based interface to call PC*MILER|Connect's features and functionality. The interface opens cross platform communications in a thread-safe manner, giving you the flexibility to transmit the output of PC*MILER|Connect to multiple networks within your organization.

POSTAL CODE & SPLC ADD-ON DATA MODULES

Canadian Postal Codes — Enhance the PC*MILER database with six-digit Canadian Postal Codes. Enables search and display of corresponding city/province names to enter them as stops along a route.

Standard Point Location Codes (SPLC) — Add SPLC to the PC*MILER database to generate routes for rating and freight bill auditing. A SPLC provides each point originating freight and each point receiving freight in North America with a unique code number that identifies the point by its geographic location.

| 191


APPENDICES

A: Access Policies from National Network Routes to Terminals and Services

B: Canadian Counties & Tourism Regions C: North American State/Province/Estado Abbreviations D: Country Abbreviations & Postal Code Access E: Postal Code Formats in Worldwide Regions F: PC*MILER Web Errors & Warnings G: Valid Entries for Street Addresses H: Default Road Speeds by Jurisdiction I: Migrating Applications from ALK|FleetSuite Directions to

PC*MILER Web Services J: Sample Code in C# K: Toll Plaza Names in Reports L: Toll Roads Requiring Electronic Payment

| 192


Appendix A: Access Policies from National Network Routes to Terminals and Services

Reasonable Access

Reasonable access is the deviation allowed between the specified truck network and any allowable stops. A stop is typically defined as a place of loading or unloading or facilities for food, fuel, repairs and rest. In all cases, local signs and warnings prohibiting truck access or providing an applicable restriction take precedence over reasonable access rules. In some states, the deviation allowed from the National Network or 53 Foot Designated Truck Network may vary depending on the roads used to get to the stop. If this is the case, we have differentiated between reasonable access from the truck route and on a state highway versus local roads.

National Network 53 Foot Designated Truck Network

Notes

Alabama 1 mile on state highways; 1 mile on local roads

1 mile on state highways; 1 mile on local roads

One mile of reasonable access is allowed as long as the pavement is12' wide.

Alaska Unlimited on state highways; Unlimited on local roads

Unlimited on state highways; Unlimited on local roads

Arizona 1 mile on state highways; 1 mile on local roads


Arkansas Unlimited on state highways; 1 mile on local roads

Unlimited on state highways; 1 mile on local roads

California 1 mile on state highways; 1 mile on local roads

No access on state highways; No access on local roads

Reasonable access of one mile off of the National Network is only allowed where the "S" sign indicates.

Appendix A: Access Policies from National Network Routes | 193


Colorado Unlimited on state highways; 1 mile on local roads


Connecticut 1 mile on state highways; 1 mile on local roads


Reasonable access of one mile is permitted for access to a place of loading or unloading, terminals, food, fuel, repair and rest. Commercial vehicles are not allowed on parkways.

Delaware 1 mile on state highways; 1 mile on local roads


District of Columbia No access on state highways; No access on local roads


All 53' trailers require a permit for reasonable access.

Florida Unlimited on state highways; 1 mile on local roads


Georgia 1 mile on state highways; 1 mile on local roads


Hawaii Unlimited on state highways; Unlimited on local roads


Idaho Unlimited on state highways; 1 mile on local roads


A 53' trailer is legally allowed to travel on all state roads



without other restrictions, such as height or weight, to their delivery point.

Illinois 5 miles on state highways; 1 mile on local roads


Reasonable access of five miles on state roads from Class I-III roads is permitted unless prohibited by other restrictions, such as height or weight, to a place of loading or unloading, terminals, food, fuel, repair and rest. Reasonable access of one mile on roads from Class I roads is permitted unless prohibited by other restrictions, such as height or weight, to a place of loading or unloading, terminals, food, fuel, repair and rest.

Indiana Unlimited on state highways; 1 mile on local roads


Non-permitted loads are legally allowed to travel on all state roads without other restrictions, such as height or weight, to a delivery.



Iowa 1 mile on state highways; 1 mile on local roads


Kansas Unlimited on state highways; 1 mile on local roads


A 53' trailer is legally allowed to travel on all state roads without other restrictions, such as height or weight, to their delivery point.

Kentucky 5 miles on state highways; 1 mile on local roads


Please see Section 5 of 603 KAR 5:250,"Selection of National Truck Network highways and reasonable access to these highways", for exceptions.

Louisiana 10 mile on state highways; 10 mile on local roads


Maine Unlimited on state highways; 1 mile on local roads


Maryland 1 mile allowed off for food, fuel, rest or shortest practical route to destination

1mile allowed off for food, fuel, rest or shortest practical route to destination

The shortest practical access route between a highway designated [as national network or state oversize] and a truck terminal, point of origin or destination cargo must be used

Massachusetts Unlimited on state highways; 1 mile on local roads


Michigan 5 miles on state highways; 1 mile on local roads

5 miles on state highways; No access on local roads

Reasonable access of five miles is permitted on state roads for access to terminals, food, fuel, repair and rest. Reasonable access of



one mile on local roads is only permitted off of interstate freeways.

Minnesota 1 mile on state highways; 1 mile on local roads


Mississippi Unlimited on state highways; 1 mile on local roads


A 53' trailer does not require a permit, so it is legally allowed to travel on all state roads without other restrictions, such as height or weight, to their delivery point.

Missouri 10 miles on state highways; 10 miles on local roads

10 miles on state highways; 10 miles on local roads

Montana Unlimited on state highways; 1 mile on local roads



Nebraska Unlimited on state highways; 1 mile on local roads


Non-permitted loads are legally allowed to travel on all state roads without other restrictions, such as height or weight, to their delivery point.

Nevada Unlimited on state highways; 1 mile on local roads





New Hampshire 1 mile on state highways; 1 mile on local roads


Reasonable access of one mile is permitted on roads without other restrictions, such as height or weight, to a place of loading or unloading, terminals, food, fuel, repair and rest.

New Jersey Unlimited on state highways; Unlimited on local roads


New Mexico Unlimited on state highways; 1 mile on local roads



New York 1 mile on state highways; 1 mile on local roads


North Carolina 3 miles on state highways; 3 miles on local roads


Reasonable access of three miles is permitted on roads without other restrictions, such as height or weight, to terminals, food, fuel, repair and rest.

North Dakota Unlimited on state highways; 1 mile on local roads


A 53' trailer does not require a permit, so it is legally allowed to travel on all state roads without other restrictions, such as height or weight, to a delivery point.

Ohio Unlimited on state highways; 1 mile on local roads




Oklahoma Unlimited on state highways; 1 mile on local roads



Oregon 1 mile on state highways; 1 mile on local roads


Pennsylvania 1 mile on state highways; 1 mile on local roads


One mile of reasonable access is allowed as long as the pavement is 10' wide.

Rhode Island 1 mile on state highways; 1 mile on local roads


South Carolina Unlimited on state highways; 1 mile on local roads


South Dakota Unlimited on state highways; 1 mile on local roads


A 53' trailer is legally allowed to travel on all state roads without other restrictions, such as height or weight, to their delivery point.

Tennessee 15 miles on state highways; 15 miles on local roads


Texas Unlimited on state highways; 1 mile on local roads


Utah Unlimited on state highways; 1 mile on local roads





Vermont 1 mile on state highways; 1 mile on local roads


Virginia 1 mile on state highways; 1 mile on local roads


Reasonable access of one mile is permitted on roads without other restrictions, such as height or weight, to terminals, food, fuel, repair and rest, except in incorporated towns and cities as well as Henrico and Arlington Counties.

Washington Unlimited on state highways; 1 mile on local roads



West Virginia 2 miles on state highways; 2 miles on local roads


Reasonable access of two miles is permitted on roads without other restrictions, such as height or weight, to terminals, food, fuel, repair and rest.

Wisconsin 5 miles on state highways; 5 miles on local roads


Wyoming Unlimited on state highways; 1 mile on local roads



| 200


Appendix B: Canadian Counties & Tourism Regions

Province Counties & Tourism Region

Alberta (No Counties)

British Columbia (Contains a County) CARIBOO

Manitoba (No Counties)

New Brunswick (Contains Counties) ALBERT CARLETON CHARLOTTE GLOUCESTER KENT KINGS MADAWASKA NORTHUMBERLAND QUEENS RESTIGOUCHE ST. JOHN SUNBURY VICTORIA WESTMORLAND YORK

Newfoundland (No Counties)

Northwest Territories (No Counties)

Nova Scotia (Contains Counties) ANNAPOLIS ANTIGONISH CAPE BRETON COLCHESTER CUMBERLAND DIGBY GUYSBOROUGH HALIFAX HANTS INVERNESS KINGS LUNENBURG PICTOU QUEENS RICHMOND

Appendix B: Canadian Counties & Tourism Regions | 201


SHELBURNE VICTORIA YARMOUTH

Nunavut (No Counties)

Ontario (Contains Counties) ALGOMA BRANT BRUCE COCHRANE DUFFERIN DURHAM ELGIN ESSEX FRONTENAC GREY HALDIMAND HALIBURTON HASTINGS HURON KENORA KENT LAMBTON LANARK MANITOULIN MIDDLESEX NIPISSING NORFOLK NORTHUMBERLAND OTTAWA - CARLETON OXFORD PARRY SOUND PERTH PETERBOROUGH PRINCE EDWARD RAINY RIVER RENFREW SIMCOE SUDBURY RM THUNDER BAY TIMISKAMING TORONTO VICTORIA WELLINGTON

Prince Edward Island (Contains Counties) KINGS PRINCE QUEENS

Appendix B: Canadian Counties & Tourism Regions | 202


Quebec (Contains Tourism Regions) ABITIBI-TEMISCAMINGUE BAS-SAINT-LAURENT CENTRE-DU-QUEBEC CHAUDIERE - APPALACHES COMMUNAUTE-URBAINE-DE-MONTREAL COTE-NORD DUPLESSIS ESTRIE GASPESIE-ILES-DE-LA-MADELEINE LA COTE-DE-BEAUPRE LANAUDIERE LAURENTIDES LES JARDINS-DE-NAPIERVILLE MAURICIE MONTEREGIE MONTREAL OUTAOUAIS QUEBEC SAGUENAY - LAC-SAINT-JEAN

Saskatchewan (No Counties)

Yukon (No Counties)

| 203


Appendix C: North American State/Province/Estado Abbreviations

States/Provinces in the United States & Canada (For country abbreviations in North America, see “North America” in the Country Codes section of this appendix)

AL Alabama

AK Alaska

AB Alberta

AZ Arizona

AR Arkansas

BC British Columbia

CA California

CO Colorado

CT Connecticut

DE Delaware

DC Dist. of Columbia

FL Florida

GA Georgia

ID Idaho

IL Illinois

IN Indiana

IA Iowa

KS Kansas

KY Kentucky

LA Louisiana

ME Maine

MB Manitoba

MD Maryland

MA Massachusetts

MI Michigan

MN Minnesota

MS Mississippi

MO Missouri

MT Montana

NE Nebraska

NV Nevada

NB New Brunswick

NH New Hampshire

NJ New Jersey

Appendix C: North American State/Province/Estado Abbreviations | 204


NM New Mexico

NY New York

NL Newfoundland & Labrador

NC North Carolina

ND North Dakota

NT Northwest Territory

NS Nova Scotia

NU* Nunavut

OH Ohio

OK Oklahoma

ON Ontario

OR Oregon

PA Pennsylvania

PE Prince Edward Island

QC Quebec

RI Rhode Island

SK Saskatchewan

SC South Carolina

SD South Dakota

TN Tennessee

TX Texas

UT Utah

VT Vermont

VA Virginia

WA Washington

WV West Virginia

WI Wisconsin

WY Wyoming

YT Yukon Territory

* The same FIPS code, NU, is used for Nicaragua and the province of Nunavut, Canada in the PC*MILER database.

Mexican Estados

AG Aguascalientes

BJ Baja California

BS Baja California Sur

CP Campeche

CH Chiapas

Appendix C: North American State/Province/Estado Abbreviations | 205


CI Chihuahua

CU Coahuila de Zaragoza

CL Colima

DF Distrito Federal

DG Durango

GJ Guanajuato

GR Guerrero

HG Hidalgo

JA Jalisco

EM Mexico (Estado)

MH Michoacan de Ocampo

MR Morelos

NA Nayarit

NX * Nuevo Leon

OA Oaxaca

PU Puebla

QA Queretaro Arteaga

QR Quintana Roo

SL San Luis Potosi

SI Sinaloa

SO Sonora

TA Tabasco

TM Tamaulipas

TL Tlaxcala

VZ Veracruz

YC Yucatan

ZT Zacatecas

* Please note that by default, “NX” is used for Nuevo Leon in Mexico (EM) because the province of Newfoundland and Labrador in Canada already utilizes “NL” in the database. If NL is passed as the state and EM as the country, geocoding will fail and the following warning will display: “GeoWarning: Check Country Setting”.

| 206


Appendix D: Country Abbreviations and Postal Code Access Region abbreviations are: AF (Africa), AS (Asia), EU (Europe), NA (North America), OC (Oceania), and SA (South America). State/country abbreviations and postal code accessibility are listed in the tables on the following pages for each region. Highway and Street-Level Data Coverage by Region

Region # of countries Highway Distance

(Km)

Streets Distance1

(Km) # of Cities

# of Postal Codes

Africa 58

1,226,695 -

28,821 5,293

Asia 52

1,771,985 -

530,845 421,435

Europe 47

2,763,070 7,924,3141

594,307 1,016,289

North America 14

1,368,278 11,968,4551

272,803 900,5092

Oceania 25

257,848 1,019,9993

21,758 33,217

South America 40

863,831 845,7563

134,304 54,155 TOTAL 236 8,251,707 21,758,524 1,582,838 2,430,898

1 Available with purchase of PC*MILER|Streets add-on module 2 Includes Canadian Postal Codes available with purchase of data add-on 3 Not available for PC*MILER Web Services ASMX service

Worldwide Data Coverage

The map on the next page shows the current level of PC*MILER road network coverage worldwide. Version 27.1 Highlights:

Added countries: Carribean Netherlands, Curacao, Gaza Strip, Kosovo, Saint Barthelemy, Saint Martin, Sint Maarten, South Sudan,Timor-Leste, West Bank and Western Sahara.

Added full coverage in Albania, Bosnia and Heregovina, Brunei Darussalam, Indonesia, Kosovo, Macedonia, Malaysia, Montenegro, Philippines, Serbia, Singapore, Taiwan and Thailand.

Extensive data updates in over 55 countries.

Appendix D: Country Abbreviations and Postal Code Access | 207


Coverage Level Road Coverage Locations Truck-Specific

Attributes

Comprehensive High + Street Level

Network Cities, postal codes,

addresses Yes

High Intermediate + Complete

Highway Network Cities, postal codes Yes

Intermediate Basic + Most primary &

secondary roads Cities, postal codes No

Basic City to city road network Cities No

Country Codes For All Worldwide Regions

Africa

COUNTRY NAME FIPS ISO2 ISO3 GENC2 GENC3

Algeria AG DZ DZA DZ DZA

Angola AO AO AGO AO AGO

Benin BN BJ BEN BJ BEN

Botswana BC BW BWA BW BWA

Burkina Faso UV BF BFA BF BFA




Burundi BY BI BDI BI BDI

Cameroon CM CM CMR CM CMR

Cape Verde CV CV CPV CV CPV

Central African Republic CT CF CAF CF CAF

Chad CD TD TCD TD TCD

Comoros CN KM COM KM COM

Congo Democratic Republic (Kinshasa) CG CG COD CD COD

Congo Republic (Brazzaville) CF CD COG CG COG

Djibouti DJ DJ DJI DJ DJI

Egypt EG EG EGY EG EGY

Equatorial Guinea EK GQ GNQ GQ GNQ

Eritrea ER ER ERI ER ERI

Ethiopia ET ET ETH ET ETH

Gabon GB GA GAB GA GAB

Gambia GA GM GMB GM GMB

Ghana GH GH GHA GH GHA

Guinea GV GN GIN GN GIN

Guinea‐Bissau PU GW GNB GW GNB

Ivory Coast IV CI CIV CI CIV

Kenya KE KE KEN KE KEN

Lesotho LT LS LSO LS LSO

Liberia LI LR LBR LR LBR

Libya LY LY LBY LY LBY

Madagascar MA MG MDG MG MDG

Malawi MI MW MWI MW MWI

Mali ML ML MLI ML MLI

Mauritania MR MR MRT MR MRT

Mauritius MP MU MUS MU MUS

Mayotte MF YT MYT YT MYT

Morocco MO MA MAR MA MAR

Mozambique MZ MZ MOZ MZ MOZ

Namibia WA NA NAM NA NAM

Niger NG NE NER NE NER

Nigeria NI NG NGA NG NGA

Reunion RE RE REU RE REU

Rwanda RW RW RWA RW RWA

Saint Helena SH SH SHN SH SHN

Sao Tome and Principe TP ST STP ST STP

Senegal SG SN SEN SN SEN

Seychelles SE SC SYC SC SYC

Sierra Leone SL SL SLE SL SLE

Somalia SO SO SOM SO SOM




South Africa SF ZA ZAF ZA ZAF

South Sudan OD SD SDW SS SSD

Sudan SU SD SDN SD SDN

Swaziland WZ SZ SWZ SZ SWZ

Tanzania TZ TZ TZA TZ TZA

Togo TO TG TGO TG TGO

Tunisia TS TN TUN TN TUN

Uganda UG UG UGA UG UGA

Western Sahara WI EH ESH EH ESH

Zambia ZA ZM ZMB ZM ZMB

Zimbabwe ZI ZW ZWE ZW ZWE

Asia

Afghanistan AF AF AFG AF AFG

Armenia AM AM ARM AM ARM

Azerbaijan AJ AZ AZE AZ AZE

Bahrain BA BH BHR BH BHR

Bangladesh BG BD BGD BD BGD

Bhutan BT BT BTN BT BTN

Brunei BX BN BRN BN BRN

Burma (Myanmar) BM MM MMR MM MMR

Cambodia CB KH KHM KH KHM

China CH CN CHN CN CHN

Cyprus CY CY CYP CY CYP

Gaza Strip GZ ‐‐ XGZ XG XGZ

Georgia GG GE GEO GE GEO

Hong Kong HK HK HKG HK HKG

India IN IN IND IN IND

Indonesia ID ID IDN ID IDN

Iran IR IR IRN IR IRN

Iraq IZ IQ IRQ IQ IRQ

Israel IS IL ISR IL ISR

Japan JA JP JPN JP JPN

Jordan JO JO JOR JO JOR

Kazakhstan KZ KZ KAZ KZ KAZ

Korea, North KN KP PRK KP PRK

Korea, South KS KR KOR KR KOR

Kuwait KU KW KWT KW KWT

Kyrgyzstan KG KGZ KGZ KG KGZ

Lao People's Democratic Republic LA LA LAO LA LAO

Lebanon LE LB LBN LB LBN




Macao MC MO MAC MO MAC

Malaysia MY MY MYS MY MYS

Maldives MV MV MDV MV MDV

Mongolia MG MN MNG MN MNG

Nepal NP NP NPL NP NPL

Oman MU OM OMN OM OMN

Pakistan PK PK PAK PK PAK

Palestinian Territory ‐‐ PS PSE PS PSE

Papua New Guinea PP PG PNG PG PNG

Philippines RP PH PHL PH PHL

Qatar QA QA QAT QA QAT

Saudi Arabia SA SA SAU SA SAU

Singapore SN SG SGP SG SGP

Sri Lanka CE LK LKA LK LKA

Syria SY SY SYR SY SYR

Taiwan TW TW TWN TW TWN

Tajikistan TI TJ TJK TJ TJK

Thailand TH TH THA TH THA

Timor‐Leste TT ‐‐ TMP TL TMP

Turkmenistan TX TM TKM TM TKM

United Arab Emirates AE AE ARE AE ARE

Uzbekistan UZ UZ UZB UZ UZB

Vietnam VM VN VNM VN VNM

West Bank WE ‐‐ XWB XW XWB

Yemen YM YE YEM YE YEM

Europe

Akrotiri AX ‐‐ ‐‐ QZ XQZ

Albania AL AL ALB AL ALB

Andorra AN AND AND AD AND

Austria AU A AUT AT AUT

Belgium BE B BEL BE BEL

Belarus BO BY BLR BY BLR

Bosnia and Herzegovina BK BIH BIH BA BIH

Bulgaria BU BG BGR BG BGR

Croatia HR HR HRV HR HRV

Czech Republic EZ CZ CZE CZ CZE

Denmark DA DK DNK DK DNK

Dhekelia DX ‐‐ ‐‐ XD XXD

Estonia EN EST EST EE EST

Faroe Islands FO FO FRO FO FRO




Finland FI FIN FIN FI FIN

France FR F FRA FR FRA

Germany GM D DEU DE DEU

Gibraltar GI GI GIB GI GIB

Greece GR GR GRC GR GRC

Guernsey GK ‐‐ ‐‐ GG GGY

Hungary HU H HUN HU HUN

Iceland IC IS ISL IS ISL

Ireland EI IRL IRL IE IRL

Isle of Man IM ‐‐ IMN IM IMN

Italy IT I ITA IT ITA

Jersey JE ‐‐ ‐‐ JE JEY

Kirghizia KG KG ‐‐ ‐‐ ‐‐

Kosovo KV ‐‐ XKS XK XKS

Latvia LG LV LVA LV LVA

Liechtenstein LS FL LIE LI LIE

Lithuania LH LT LTU LT LTU

Luxembourg LU L LUX LU LUX

Macedonia MK MK MKD MK MKD

Malta MT M MLT MT MLT

Moldova MD MD MDA MD MDA

Monaco MN MC MCO MC MCO

Montenegro MJ MNE MNE ME MNE

Netherlands NL NL NLD NL NLD

Norway NO N NOR NO NOR

Poland PL PL POL PL POL

Portugal PO P PRT PT PRT

Romania RO RO ROU RO ROU

Russian Federation RS RUS RUS RU RUS

San Marino SM RSM SMR SM SMR

Slovakia LO SK SVK SK SVK

Slovenia SI SLO SVN SI SVN

Spain SP E ESP ES ESP

Svalbard and Jan Mayen Islands SV SJ SJM XR XSV

Sweden SW S SWE SE SWE

Switzerland SZ CH CHE CH CHE

Turkey TU TR TUR TR TUR

Ukraine UP UA UKR UA UKR

United Kingdom UK UK GBR GB GBR

Vatican City VT V VAT VA VAt

Serbia RI SRB SRB RS SRB




North America (includes Central American countries)

Belize BH BZ BLZ BZ BLZ

Bermuda BD BM BMU BM BMU

Bonair, Sint Eustatius Saba ‐‐ ‐‐ ‐‐ BQ BES

Canada CA CA CAN CA CAN

Costa Rica CS CR CRI CR CRI

Curacao UC ‐‐ ‐‐ CW CUW

El Salvador ES SV SLV SV SLV

Greenland GL GL GRL GL GRL

Guantanamo Bay ‐‐ ‐‐ ‐‐ A2 AX2

Guatemala GT GT GTM GT GTM

Honduras HO HN HND HN HND

Mexico MX MX MEX MX MEX

Nicaragua* NU* NI NIC NI NIC

Panama PM PA PAN PA PAN

Puerto Rico** PR** PR PRI PR PRI

Saint Pierre and Miquelon SB PM SPM PM SPM United States

US US USA US USA * The same FIPS code, NU, is used for Nicaragua and the province of Nunavut, Canada in the PC*MILER database.

** Note: “PR” for Puerto Rico is a USPS code, not a FIPS code.

Oceania

American Samoa AQ AS ASM AS ASM

Australia* AS AU AUS AU AUS

Cook Islands CW CK COK CK COK

Fiji FJ FJ FJI FJ FJI

French Polynesia FP PF PYF PJ PYF

French Southern and Antarctic Islands FS TF ATF TF ATF

Guam GQ GU GUM GU GUM

Kiribati KR KI KIR KI KIR

Marshall Islands RM MH MHL MH MHL

Micronesia, Federated States of FM FM FSM FM FSM

Midway Island MQ UM ‐‐ QM XMW

Nauru NR NR NRU NR NRU

New Caledonia NC NC NCL NC NCL

New Zealand NZ NZ NZL NZ NZL

Niue NE NU NIU NU NIU

Norfolk Island NF NF NFK NF NFK




Northern Mariana Islands CQ MP MNP MP MNP

Palau PS PW PLW PW PLW

Pitcairn PC PN PCN PN PCN

Solomon Islands BP SB SLB SB SLB

Tokelau TL TK TKL TK TKL

Tonga TN TO TON TO TON

Tuvalu TV TV TUV TV TUV

Vanuatu NH VU VUT VU VUT

Wake Island WQ WQ XWK QW XWK

Wallis and Futuna Islands WF WF WLF WF WLF

Western Samoa WS WS WSM WS WSM

* When using the Streets Oceania data set, use state or territory abbreviations instead of the “AS” country abbreviation for locations in Australia – see the Jurisdictions section at the beginning of this appendix.

South America

Anguilla AV AI AIA AI AIA

Antigua and Barbuda AC AG ATG AG ATG

Argentina AR AR ARG AR ARG

Aruba AA AW ABW AW ABW

Bahamas BF BS BHS BS BHS

Barbados BB BB BRB BB BRB

Bolivia BL BO BOL BO BOL

Brazil BR BR BRA BR BRA

British Virgin Islands VI VG VGB VG VGB

Caribbean Netherlands NT AN BES BQ BES

Cayman Islands CJ KY CYM KY CYM

Chile CI CL CHL CL CHL

Colombia CO CO COL CO COL

Cuba CU CU CUB CU CUB

Curacao UC ‐‐ ‐‐ CUW CUW

Dominica DO DM DMA DM DMA

Dominican Republic DR DO DOM DO DOM

Ecuador EC EC ECU EC ECU

Falkland Islands (Malvinas) FK FK FLK FK FLK

French Guiana FG GF GUF GF GUF

Grenada GJ GD GRD GD GRD

Guadeloupe GP GP GLP GP GLP

Guantanamo Bay ‐‐ ‐‐ ‐‐ A2 AX2

Guyana GY GY GUY GY GUY

Haiti HA HT HTI HT HTI

Jamaica JM JM JAM JM JAM




Martinique MB MQ MTQ MQ MTQ

Montserrat MH MS MSR MS MSR

Paraguay PA PY PRY PY PRY

Peru PE PE PER PE PER

Saint Barthalemy TB ‐‐ BLM BL BLM

Saint Kitts and Nevis Islands SC KN KNA KN KNA

Saint Martin RN ‐‐ MAF MF MAF

Saint Lucia ST LC LCA LC LCA

Saint Vincent and the Grenadines VC VC VCT VC VCT

Sint Maarten NN ‐‐ SXM SX SXM

Suriname NS SR SUR SR SUR

Trinidad and Tobago TD TT TTO TT TTO

Turks and Caicos Islands TK TC TCA TC TCA

United States Virgin Islands VQ VI VIR VI VIR

Uruguay UY UY URY UY URY

Venezuela VE VE VEN VE VEN Official Sources FIPS Country Codes: http://geonames.nga.mil/ggmagaz/geonames4.asp and http://www.state.gov/s/inr/rls/4250.htm ISO2 Country Codes: http://www.iso.org/iso/country_codes/iso_3166_code_lists/english_country_names_and_code_elements.htm and http://www.iso.org/iso/english_country_names_and_code_elements#s ISO 3 Country Codes: http://unstats.un.org/unsd/methods/m49/m49alpha.htm GENC2 and GENC3 Country Codes (Geopolitical Entities, Names and Codes): Issued by the National Geospatial-Intelligence Agency https://www1.nga.mil/Pages/default.aspx

| 215


Appendix E: Postal Code Formats in Worldwide Regions

Legend: A = alphabetic (A,B,C,…Z) N = numeric (0,1,2,...9)

North America Canada ANA NAN or ANANAN

USA NNNNN

Mexico, starting in PCM25 NNNNN

South America Brazil, starting in PCM24 NNNNN

Europe United Kingdom AANA N or AAN N or AANN N or, starting in PCM24, AANAN or AANN or AANNN or, starting in PCM25, AANA NAA or AANANAA or AAN NAA or AANNAA or AANN NAA or AANNNAA

Russia, starting in PCM22 NNNNNN

Romania, starting in PCM23 NNNNNN

France, Germany, Italy, Vatican City, Spain, and Finland NNNNN

Estonia and Croatia, starting in PCM22 NNNNN

Lithuania, starting in PCM23 NNNNN

Ukraine and Turkey, starting in PCM24 NNNNN

Appendix E: Postal Code Formats in Worldwide Regions | 216


Netherlands, Belgium, Luxemburg, Austria, Switzerland, Liechtenstein, Denmark, Norway and Hungary NNNN

Latvia and Slovenia, starting in PCM22 NNNN

Bulgaria, starting in PCM23 NNNN

Iceland NNN

Ireland (Dublin only) NN (single digit postcodes N are not supported for input in PC*MILER)

Poland NN-NNN or, starting in PCM24: NNNNN

Portugal NNNN or, starting in PCM24: NNNN-NNN or NNNNNNN

Sweden NNN or, starting in PCM22: NNN NN or NNNNN

Czech Republic and Slovakia NNN NN or NNNNN

Greece, starting in PCM22 NNN NN or NNNNN

Africa South Africa, starting in PCM24 NNNN

Asia Japan, starting in PCM24 NNN-NNNN or NNNNNNN

India, starting in PCM24 NNNNNN

Oceania Australia, starting in PCM24 NNNN

| 217


Appendix F: PC*MILER Web Errors & Warnings

Definitions: Error Any fatal condition which will prevent the system from fulfilling the request. Warning Any non-fatal condition which may, or may not, change the applicability of the returned information fulfilling the user’s request. This information is provided so the user can make that determination.

System Error: ErrorCode: 100 ErrorDesc: “Unable to fulfill request – please contact ALK Tech Support” This error will be generated if there is really something wrong with the system. If we’re generating this, basically the system is down.

Schema Error: ErrorCode: 200 ErrorDesc: “Schema translation error [incorrect element]” This error will be generated if there is a mismatch between the input schema, and the “current” schema. It may also occur if element tags are misspelled, and in that case the tag will be returned.

Log-in Errors: Incorrect Log-in ErrorCode: 300 ErrorDesc: “The log-in was incorrect” This error will be generated if there was a problem with the log-in information. This may be because the log-in does not exist, the password was wrong, or the account was wrong. Disabled Log-in ErrorCode: 310 ErrorDesc: “Your log-in has been disabled. Please contact tech support” This error will be generated in two cases. Most prevalent will be if the log-in has been disabled due to expiration, or some user error. Also, it will be generated after five straight unsuccessful attempts to log-in.

Appendix F: PC*MILER Web Errors and Warnings | 218


Geocoding Errors: Address Not Found ErrorCode: 400 ErrorDesc: “Address [input address, city, state, zip] was not found” This error will be generated if an address, as part of a Location structure, was not able to be geocoded. City/Zip Mismatch ErrorCode: 410 ErrorDesc: “City [input city, state] does not match input zip code [input zip code]” This error will be generated if the input address is not geocodable because the zip code portion of the request is not valid for the city portion of the request. Zip Code Not ErrorCode: 420 ErrorDesc: “Zip code [input zip code] was not found” This error will be generated if the input zip code was not found. Jurisdiction Mismatch ErrorCode: 430 ErrorDesc: “City [input city, state] does not reside in input jurisdiction [input jurisdiction]” This error will be generated if there is a mismatch between the input city/state combination and the input jurisdiction. Invalid Place Name ErrorCode: 440 ErrorDesc: “Invalid Custom Place Name [input placename]” This error will be generated if the input PlaceName is not one associated with the login account. Invalid State Name ErrorCode: 450 ErrorDesc: “Invalid State Name [input state]” This error will be generated if the input state is not a USPS valid state abbreviation.

Format Errors: Missing Parameter ErrorCode: 500 ErrorDesc: “[element name] is required for this request” This error will be generated if the input fails to have a required piece of data. Incorrect Value ErrorCode: 510 ErrorDesc: “[element name] requires values of [list of acceptable values]”



This error will be generated if the input does not conform to the edits for that field. For example, the interfacing system passes a “P” in a StopCostsType.Loaded field, which only has acceptable values of “Y” and “N” this error would be returned. Incorrect Type ErrorCode: 520 ErrorDesc: “[element name] must be of type [the correct type]” This error will be generated if the input value for that field does not match the type. For instance, if an alpha is passed in a numeric field. Incorrect Lat/Long ErrorCode: 530 ErrorDesc: “Invalid latitude/longitude value: [invalid element] is invalid” This error will be generated if the input value for a lat/long field is in an invalid format. Incorrect Route Name ErrorCode: 540 ErrorDesc: “Invalid route name for this state. Make sure that the route is formatted properly” This error will be generated if the input value for a lat/long field is in an invalid format.

Fuel Optimization error: FuelAdvice Error ErrorCode: 600 ErrorDesc: “Fuel Optimization: [error from FuelAdvice]” This error will be generated if there was an error returned from the FuelAdvice server. The text will be verbatim from that server.

Geocoding Warnings: Parity Error ErrorCode: 1000 ErrorDesc: “There is a parity mismatch with the address range” This warning will be returned if we have the address number within our overall data range, but not in the odd or even range for that link. No address number ErrorCode: 1010 ErrorDesc: “The address provided had no number” This warning will be returned if the supplied address did not contain a number, e.g. Herrontown Rd. instead of 1000 Herrontown Rd.



Street directional mismatch ErrorCode: 1020 ErrorDesc: “The street directional does not match” This warning will be returned if the “best match” address has a different street directional from the input address. Street type mismatch ErrorCode: 1030 ErrorDesc: “The street type does not match” This warning will be returned if the “best match” address has a different street type from the input address, e.g. Herrontown St. vs. Herrontown Rd. Street name misspelled ErrorCode: 1040 ErrorDesc: “The street name is misspelled” This warning will be returned if the street was matched through soundex, but did not match the name on the data link, e.g. Main vs. Maine Multiple Matches ErrorCode: 1050 ErrorDesc: “Street has multiple exact matches” This warning will be returned if the geocoder returned a confidence level of 100%, but more than one match. No Street Name ErrorCode: 1060 ErrorDesc: “No street name” This warning will be returned if there was no. Address number out of range ErrorCode: 1070 ErrorDesc: “Address number out of range” This warning will be returned if the number received in the XML exceeds the highest address number contained in the data for that street. Zip/Street mismatch ErrorCode: 1080 ErrorDesc: “Street is not within zip code specified” This warning will be returned if the zip code contained on the link does not match the one received through the XML request. Zip Centroid ErrorCode: 1090 ErrorDesc: “The coordinates returned are for the zip centroid” This warning will be returned if “the best” is the zip centroid for the address received.



General Warnings: Extraneous Information ErrorCode: 2000 ErrorDesc: “Data was not necessary for requested transaction [the extra field or structure]” This warning will be returned if the user provided a field, or structure, that was not needed for the API they used, but was not problematic either.

| 222


Appendix G: Valid Entries for Street Addresses (U.S. and Canada only)

Valid directional and street type abbreviations for street address entry in North America are listed below. Spelling out the whole word is also acceptable. Capitalization is not necessary.

Directional Synonyms for Address Entry – Prefix or Suffix

Full Spelling Valid in PC*MILER

EAST E EAST E. NORTH N NORTH N. NORTH NO NORTH NO. NORTHEAST N-E NORTHEAST N.E NORTHEAST N.E.NORTHEAST NE NORTHEAST NE. NORTHEAST NORTH-EASTNORTHWEST N-WNORTHWEST N.WNORTHWEST. N.W.NORTHWEST NORTH-WESTNORTHWEST NW NORTHWEST NW.SOUTH S SOUTH S. SOUTH SO SOUTH SO. SOUTHEAST S-E SOUTHEAST S.E SOUTHEAST S.E. SOUTHEAST SE SOUTHEAST SE. SOUTHEAST SOUTH-EASTSOUTHWEST S-WSOUTHWEST S.W SOUTHWEST S.W.SOUTHWEST SOUTH-WESTSOUTHWEST SW SOUTHWEST SW. WEST W WEST W.

| 223


Synonyms for Street Types


Alley Al Alley Al. Alley All Alley All. Alley Aly Alley Aly. Arcade Arc Arcade Arc. Avenue Av Avenue Av. Avenue Avda Avenue Avda. Avenue Ave Avenue Ave. Avenue Aven Avenue Aven. Avenue Avenida Boulevard Blvd Boulevard Blvd. Boulevard Boul Bridge Brdg Bridge Brdg. Bridge Brg Bridge Brg. Bypass Byp Bypass Byp. Causeway Cause Causeway Cause. Causeway Cswy Causeway Cswy. Center Cntr Center Cntr. Center Ctr Center Ctr. Circle Cir Circle Cir. Circle Circ Circle Circ. Court Crt Court Crt. Court Ct Court Ct. Cove Cv Cove Cv.


Crescent Cres Crescent Cres. Crescent Cresc Crescent Cresc. Crescent Cresnt Crossing Crsg Crossing Crsg. Crossing Xing Crossing Xing. Drive Dr Drive Dr. Drive Drv Drive Drv. Expressway Expr Expressway Expr. Expressway Expy Expressway Expy. Expressway Exwy Expressway Exwy. Farm-To-Market F-M Farm-To-Market FM Freeway Frwy Freeway Frwy. Harbor Hbr Heights Hts Highway Hwy Highway Hwy. Highway Hy Highway Hy. Lane La Lane La. Lane Ln Lane Ln. Loop Lp Loop Lp. Mall Ml Mall Ml. Motorway Mrwy Motorway Mrwy. Motorway Mtrwy Motorway Mtrwy. Motorway Mtwy Motorway Mtwy. Overpass Over Overpass Over. Overpass Ovps

Appendix G: Valid Entries for Street Addresses (U.S. and Canada) | 224



Overpass Ovps. Overpass Ovrps Overpass Ovrps. Park Pk Park Pk. Park Prk Park Prk. Parkway Pkwy Parkway Pkwy. Parkway Prkwy Parkway Prkwy. Pass Ps Pass Ps. Path Pth Path Pth. Pike Pke Pike Pke. Place Pl Place Pl. Place Pla Place Pla. Place Plac Place Plac. Place Plc Place Plc. Plaza Plz Plaza Plz. Point Pnt Point Pnt. Point Pt Point Pt. Ramp Rmp Ramp Rmp. Road Rd Road Rd. Skyway Skwy Skyway Skwy. Square Sq Square Sq. Square Sqr Square Sqr. Street St Street St. Street Str Street Str. Terrace Ter


Terrace Ter. Terrace Terr Terrace Terr. Terrace Trc Terrace Trc. Throughway Thruway Throughway Thwy Throughway Thwy. Trafficway Tfcwy Trafficway Tfcwy. Trafficway Tfwy Trafficway Tfwy. Trafficway Trwy Trail Trl Trail Trl. Tunnel Tun Tunnel Tun. Tunnel Tunl Tunnel Tunl. Tunnel Tunn Tunnel Tunn. Turnpike Tpk Turnpike Tpk. Turnpike Tpke Turnpike Tpke. Underpass Unp Underpass Unp. Underpass Unps Underpass Unps. Underpass Unrps Underpass Unrps. Way Wy Way Wy.

| 225


Appendix H: Default Road Speeds by Jurisdiction and Road Category The tables below list, for each world region, default road speeds in PC*MILER and PC*MILER|Worldwide by jurisdiction and PC*MILER road category. Speeds are in miles per hour. See Appendices C and D in this User’s Guide for a complete list of state and country names and abbreviations.

Region State FIPS Interstate Highway

Divided Highway

Primary Highway

Secondary Highway Local Ferries

Rural Urban Rural Urban Rural Urban Rural Urban Rural Urban Rural Urban

Africa Algeria AG 62 56 56 43 50 31 37 25 25 18 26 26

Africa Angola AO 50 45 40 35 35 30 30 25 20 15 18 18

Africa Botswana BC 50 45 40 35 35 30 30 25 20 15 21 21

Africa Benin BN 50 45 40 35 35 30 30 25 20 15 18 18

Africa Burundi BY 50 45 40 35 35 30 30 25 20 15 18 18

Africa Chad CD 50 45 40 35 35 30 30 25 20 15 21 21

Africa Congo CF 50 45 40 35 35 30 30 25 20 15 18 18

Africa Republic of Congo CG 50 45 40 35 35 30 30 25 20 15 23 23

Africa Cameroon CM 50 45 40 35 35 30 30 25 20 15 21 21

Africa Comoros CN 50 45 40 35 35 30 30 25 20 15 15 15

Africa Central African Republic CT 50 45 40 35 35 30 30 25 20 15 18 18

Africa Cape Verde CV 50 45 40 35 35 30 30 25 20 15 23 23

Africa Djibouti DJ 50 45 40 35 35 30 30 25 20 15 21 21

Africa Egypt EG 62 56 56 43 37 31 25 25 18 12 27 27

Africa Equatorial Guinea EK 50 45 40 35 35 30 30 25 20 15 21 21

Africa Eritrea ER 50 45 40 35 35 30 30 25 20 15 21 21

Africa Ethiopia ET 62 56 56 43 50 31 37 25 25 18 18 18

Africa Gambia GA 50 45 40 35 35 30 30 25 20 15 21 21

Appendix H: Default Road Speeds by Jurisdiction and Road Category | 226



Divided Highway

Primary Highway



Africa Gabon GB 50 45 40 35 35 30 30 25 20 15 18 18

Africa Ghana GH 62 56 56 43 50 31 37 25 25 18 21 21

Africa Guinea GV 50 45 40 35 35 30 30 25 20 15 18 18

Africa Ivory Coast IV 50 45 40 35 35 30 30 25 20 15 18 18

Africa Kenya KE 62 56 56 43 50 31 37 25 25 18 21 21

Africa Liberia LI 50 45 40 35 35 30 30 25 20 15 18 18

Africa Lesotho LT 50 45 40 35 35 30 30 25 20 15 23 23

Africa Libya LY 50 45 40 35 35 30 30 25 20 15 26 26

Africa Madagascar MA 50 45 40 35 35 30 30 25 20 15 15 15

Africa Mayotte MF 50 45 40 35 35 30 30 25 20 15 18 18

Africa Malawi MI 62 56 56 43 50 31 37 25 25 18 21 21

Africa Mali ML 50 45 40 35 35 30 30 25 20 15 18 18

Africa Morocco MO 62 56 56 43 50 31 37 25 25 18 26 26

Africa Mauritius MP 50 45 40 35 35 30 30 25 20 15 18 18

Africa Mauritania MR 50 45 40 35 35 30 30 25 20 15 18 18

Africa Mozambique MZ 50 45 40 35 35 30 30 25 20 15 21 21

Africa Niger NG 50 45 40 35 35 30 30 25 20 15 21 21

Africa Nigeria NI 62 56 56 43 50 31 37 25 25 18 21 21

Africa South Sudan OD 50 45 40 35 35 30 30 25 20 15 18 18

Africa Guinea‐Bissau PU 50 45 40 35 35 30 30 25 20 15 18 18

Africa Reunion RE 50 45 40 35 35 30 30 25 20 15 18 18

Africa Rwanda RW 50 45 40 35 35 30 30 25 20 15 18 18

Africa Seychelles SE 50 45 40 35 35 30 30 25 20 15 18 18

Africa South Africa SF 68 62 56 43 50 31 37 25 25 18 24 24

Africa Senegal SG 50 45 40 35 35 30 30 25 20 15 21 21

Africa Saint Helena SH 50 45 40 35 35 30 30 25 20 15 18 18

Africa Sierra Leone SL 50 45 40 35 35 30 30 25 20 15 18 18




Divided Highway

Primary Highway



Africa Somalia SO 50 45 40 35 35 30 30 25 20 15 21 21

Africa Sudan SU 50 45 40 35 35 30 30 25 20 15 18 18

Africa Togo TO 50 45 40 35 35 30 30 25 20 15 18 18

Africa Sao Tome and Principe TP 50 45 40 35 35 30 30 25 20 15 21 21

Africa Tunisia TS 62 56 56 43 50 31 37 25 25 18 26 26

Africa Tanzania TZ 62 56 56 43 50 31 37 25 25 18 23 23

Africa Uganda UG 62 56 56 43 50 31 37 25 25 18 23 23

Africa Burkina Faso UV 50 45 40 35 35 30 30 25 20 15 18 18

Africa Namibia WA 50 45 40 35 35 30 30 25 20 15 21 21

Africa Western Sahara WI 50 45 40 35 35 30 30 25 20 15 18 18

Africa Swaziland WZ 50 45 40 35 35 30 30 25 20 15 18 18

Africa Zambia ZA 50 45 40 35 35 30 30 25 20 15 21 21

Africa Zimbabwe ZI 62 56 50 43 43 31 37 25 25 18 23 23

Asia Afghanistan AF 56 56 56 50 43 31 31 25 25 18 16 16

Asia Azerbaijan AJ 56 56 56 50 43 31 31 25 25 18 20 20

Asia Armenia AM 56 56 56 50 43 31 31 25 25 18 16 16

Asia Bahrain BA 56 56 56 50 43 31 31 25 25 18 25 25

Asia Bangladesh BG 50 50 50 43 43 31 31 18 25 12 21 21

Asia Burma (Myanmar) BM 50 50 50 43 43 31 31 18 25 12 21 21

Asia Bhutan BT 50 50 50 43 43 31 31 18 25 12 16 16

Asia Brunei Darussalam BX 50 50 50 43 43 31 31 18 25 12 18 18

Asia Cambodia CB 56 56 56 50 43 31 31 25 25 18 18 18

Asia Sri Lanka CE 50 50 50 43 43 31 31 18 25 12 22 22

Asia China CH 68 62 56 50 50 31 37 18 25 12 27 27

Asia Cyprus CY 56 56 56 50 43 31 31 25 25 18 25 25

Asia Georgia GG 56 56 56 50 43 31 31 25 25 18 20 20

Asia Gaza Strip GZ 56 56 56 50 43 31 31 25 25 18 25 25




Divided Highway

Primary Highway



Asia Hong Kong HK 31 31 31 31 25 25 18 18 12 12 27 27

Asia Indonesia ID 50 50 50 43 43 31 31 18 25 12 27 27

Asia India IN 62 49 49 37 43 31 31 18 25 12 22 22

Asia Iran (Islamic Republic of) IR 56 56 56 50 43 31 31 25 25 18 25 25

Asia Israel IS 56 56 56 50 43 31 31 25 25 18 25 25

Asia Iraq IZ 56 56 56 50 43 31 31 25 25 18 21 21

Asia Japan JA 62 56 50 43 37 31 31 18 25 12 26 26

Asia Jordan JO 56 56 56 50 43 31 31 25 25 18 16 16

Asia Kyrgyzstan KG 56 56 56 50 43 31 31 25 25 18 16 16

Asia Korea, North KN 56 56 56 50 43 31 31 25 25 18 21 21

Asia Korea, South KS 56 56 56 50 43 31 31 25 25 18 21 21

Asia Kuwait KU 56 56 56 50 43 31 31 25 25 18 20 20

Asia Lao People's Democratic Republic LA 56 56 56 50 43 31 31 25 25 18 16 16

Asia Lebanon LE 56 56 56 50 43 31 31 25 25 18 25 25

Asia Macao MC 50 50 50 43 43 31 31 18 25 12 27 27

Asia Mongolia MG 56 56 56 50 43 31 31 25 25 18 16 16

Asia Oman MU 56 56 56 50 43 31 31 25 25 18 21 21

Asia Maldives MV 56 56 56 50 43 31 31 25 25 18 22 22

Asia Malaysia MY 50 50 50 43 43 31 31 18 25 12 27 27

Asia Nepal NP 50 50 50 43 43 31 31 18 25 12 16 16

Asia Pakistan PK 56 56 56 50 43 31 31 25 25 18 21 21

Asia Papua New Guinea PP 50 50 50 43 43 31 31 18 25 12 18 18

Asia Qatar QA 56 56 56 50 43 31 31 25 25 18 25 25

Asia Philippines RP 50 50 50 43 43 31 31 18 25 12 25 25

Asia Saudi Arabia SA 62 56 56 43 37 31 31 18 25 12 25 25




Divided Highway

Primary Highway



Asia Singapore SN 56 56 56 50 43 31 31 25 25 18 27 27

Asia Syrian Arab Republic SY 56 56 56 50 43 31 31 25 25 18 16 16

Asia United Arab Emirates AE 68 62 62 56 50 37 37 25 25 18 27 27

Asia Thailand TH 50 50 50 43 43 31 31 18 25 12 21 21

Asia Tajikistan TI 50 43 40 31 31 25 25 16 18 12 16 16

Asia East Timor TT 50 50 50 43 43 31 31 18 25 12 18 18

Asia Taiwan TW 50 50 50 43 43 31 31 18 25 12 25 25

Asia Turkmenistan TX 56 56 56 50 43 31 31 25 25 18 20 20

Asia Vietnam VM 50 50 50 43 43 31 31 18 25 12 21 21

Asia West Bank WE 56 56 56 50 43 31 31 25 25 18 25 25

Asia Yemen YM 56 56 56 50 43 31 31 25 25 18 21 21

Europe Albania AL 50 43 40 31 31 25 25 16 18 12 16 16

Europe Andorra AN 50 43 40 31 31 25 25 16 18 12 16 16

Europe Austria AU 50 50 34 31 34 25 25 16 18 12 16 16

Europe Belgium BE 56 56 45 31 30 25 25 16 18 12 16 16

Europe Bosnia and Herzegovina BK 62 43 50 31 39 25 25 16 18 12 16 16

Europe Belarus BO 62 56 40 31 39 25 25 16 18 12 16 16

Europe Bulgaria BU 62 62 34 31 34 25 25 16 18 12 16 16

Europe Denmark DA 50 50 34 31 34 25 25 16 18 12 16 16

Europe Ireland EI 50 50 40 31 39 25 25 16 18 12 16 16

Europe Estonia EN 56 43 45 31 45 25 25 16 18 12 16 16

Europe Czech Republic EZ 50 50 40 31 39 25 25 16 18 12 16 16

Europe Finland FI 50 50 40 31 39 25 25 16 18 12 16 16

Europe Faroe Islands FO 50 43 40 31 31 25 25 16 18 12 16 16

Europe France FR 56 43 40 31 31 25 25 16 18 12 16 16

Europe Gibraltar GI 50 43 40 31 31 25 25 16 18 12 16 16




Divided Highway

Primary Highway



Europe Germany GM 50 43 35 31 30 25 25 16 18 12 16 16

Europe Greece GR 43 43 34 31 34 25 25 16 18 12 16 16

Europe Croatia HR 50 50 34 31 34 25 25 16 18 12 16 16

Europe Hungary HU 50 43 40 31 31 25 25 16 18 12 16 16

Europe Iceland IC 50 43 40 31 31 25 25 16 18 12 16 16

Europe Isle of Man IM 50 43 40 31 31 25 25 16 18 12 16 16

Europe Italy IT 50 43 35 31 34 25 25 16 18 12 16 16

Europe Kosovo KV 50 50 34 31 34 30 25 16 18 12 16 16

Europe Kazakhstan KZ 50 43 40 31 31 25 25 16 18 12 16 16

Europe Latvia LG 50 50 40 31 39 25 25 16 18 12 16 16

Europe Lithuania LH 50 43 40 31 31 25 25 16 18 12 16 16

Europe Slovakia LO 50 50 40 37 39 30 25 16 18 12 16 16

Europe Liechtenstein LS 50 43 40 31 31 25 25 16 18 12 16 16

Europe Luxembourg LU 56 56 38 31 38 25 25 16 18 12 16 16

Europe Moldavia MD 50 43 40 31 31 25 25 16 18 12 16 16

Europe Montenegro MJ 50 43 40 31 31 25 25 16 18 12 16 16

Europe Macedonia MK 43 43 34 31 34 25 25 16 18 12 16 16

Europe Monaco MN 50 43 40 31 31 25 25 16 18 12 16 16

Europe Malta MT 50 43 40 31 31 25 25 16 18 12 16 16

Europe Netherlands NL 50 50 40 31 39 25 25 16 18 12 16 16

Europe Norway NO 50 50 40 31 39 25 25 16 18 12 16 16

Europe Poland PL 50 50 40 31 34 25 25 16 18 12 16 16

Europe Portugal PO 50 50 34 25 34 20 25 16 18 12 16 16

Europe Serbia RI 50 50 34 31 34 30 25 16 18 12 16 16

Europe Romania RO 56 56 40 31 34 25 25 16 18 12 16 16

Europe Russian Federation RS 62 56 40 31 39 25 25 16 18 12 16 16

Europe Slovenia SI 50 50 34 31 34 25 25 16 18 12 16 16




Divided Highway

Primary Highway



Europe San Marino SM 50 43 40 31 31 25 25 16 18 12 16 16

Europe Spain SP 56 43 40 31 34 25 25 16 18 12 16 16

Europe Svalbard and Jan Mayen Islands SV 50 43 40 31 31 25 25 16 18 12 16 16

Europe Sweden SW 50 50 40 31 39 25 25 16 18 12 16 16

Europe Switzerland SZ 50 50 40 31 39 25 25 16 18 12 16 16

Europe Turkey TU 62 56 40 31 39 25 25 16 18 12 16 16

Europe United Kingdom UK 60 40 46 30 32 24 25 16 18 12 16 16

Europe Ukraine UP 62 56 40 31 39 25 25 16 18 12 16 16

Europe Uzbekistan UZ 50 43 40 31 31 25 25 16 18 12 16 16

Europe Vatican City VT 50 43 40 31 31 25 25 16 18 12 16 16

N. America Alberta AB 62 62 62 43 56 37 43 37 31 25 21 21

N. America Aguascalientes AG 68 62 56 43 49 37 43 31 31 25 23 23

N. America Alaska AK 65 55 55 40 45 35 45 35 30 25 17 17

N. America Alabama AL 68 60 55 40 45 35 45 35 30 25 15 15

N. America Arkansas AR 65 55 55 40 45 35 45 35 35 25 15 15

N. America Arizona AZ 68 60 60 40 50 35 45 35 35 25 15 15

N. America British Columbia BC 68 62 62 37 56 37 43 37 31 25 21 21

N. America Bermuda BD 56 49 49 43 43 37 31 31 25 25 21 21

N. America Belize BH 62 56 56 43 49 37 37 31 31 25 21 21

N. America Baja California BJ 68 62 56 43 49 37 43 31 31 25 23 23

N. America Baja California Sur BS 68 62 56 43 49 37 43 31 31 25 23 23

N. America California CA 55 55 55 40 45 30 40 30 30 25 16 16

N. America Chiapas CH 68 62 56 43 49 37 43 31 31 25 23 23

N. America Chihuahua CI 68 62 56 43 49 37 43 31 31 25 23 23

N. America Colima CL 68 62 56 43 49 37 43 31 31 25 23 23

N. America Colorado CO 68 60 60 40 50 35 45 35 35 25 15 15




Divided Highway

Primary Highway



N. America Campeche CP 68 62 56 43 49 37 43 31 31 25 23 23

N. America Costa Rica CS 56 49 49 43 43 37 31 31 25 25 21 21

N. America Connecticut CT 65 55 55 40 45 30 35 30 25 25 13 13

N. America Coahuila de Zaragoza CU 68 62 56 43 49 37 43 31 31 25 23 23

N. America Dist. of Columbia DC 55 50 45 40 40 35 35 30 25 25 13 13

N. America Delaware DE 65 55 55 40 45 30 35 30 25 25 13 13

N. America Distrito Federal DF 62 62 43 43 37 37 31 31 25 25 23 23

N. America Durango DG 68 62 56 43 49 37 43 31 31 25 23 23

N. America Mexico (Estado) EM 68 62 56 43 49 37 43 31 31 25 23 23

N. America El Salvador ES 62 56 56 43 49 37 37 31 31 25 21 21

N. America Florida FL 68 60 55 40 45 35 45 35 30 25 13 13

N. America Georgia GA 68 60 55 40 45 35 40 30 30 25 13 13

N. America Guanajuato GJ 68 62 56 43 49 37 43 31 31 25 23 23

N. America Greenland GL 45 45 45 35 35 35 35 25 25 20 13 13

N. America Guerrero GR 68 62 56 43 49 37 43 31 31 25 23 23

N. America Guatemala GT 62 56 56 43 49 37 37 31 31 25 21 21

N. America Hidalgo HG 68 62 56 43 49 37 43 31 31 25 23 23

N. America Hawaii HI 60 50 45 35 35 35 25 25 25 25 13 13

N. America Honduras HO 62 56 56 43 49 37 37 31 31 25 21 21

N. America Iowa IA 68 55 60 40 45 35 45 35 35 25 15 15

N. America Idaho ID 65 60 60 40 50 35 45 35 35 25 15 15

N. America Illinois IL 65 55 55 40 45 35 45 35 35 25 15 15

N. America Indiana IN 65 55 55 40 45 35 40 30 30 25 15 15

N. America Jalisco JA 68 62 56 43 49 37 43 31 31 25 23 23

N. America Kansas KS 68 60 60 40 50 35 45 35 35 25 15 15

N. America Kentucky KY 65 60 55 40 45 35 40 30 30 25 15 15

N. America Louisiana LA 68 60 55 40 45 35 45 35 35 25 15 15




Divided Highway

Primary Highway



N. America Massachusetts MA 65 60 55 40 45 30 35 30 25 25 13 13

N. America Manitoba MB 68 62 62 43 56 37 43 37 31 25 21 21

N. America Maryland MD 65 60 55 40 45 30 35 30 25 25 13 13

N. America Maine ME 65 60 60 40 45 35 45 35 30 25 13 13

N. America Michoacan de Ocampo MH 68 62 56 43 49 37 43 31 31 25 23 23

N. America Michigan MI 60 55 55 40 45 35 40 30 30 25 18 18

N. America Minnesota MN 68 60 60 40 45 35 45 35 35 25 15 15

N. America Missouri MO 68 60 60 40 45 35 45 35 35 25 15 15

N. America Morelos MR 68 62 56 43 49 37 43 31 31 25 23 23

N. America Mississippi MS 68 60 55 40 45 35 45 35 30 25 15 15

N. America Montana MT 65 60 60 40 50 35 45 35 35 25 15 15

N. America Nayarit NA 68 62 56 43 49 37 43 31 31 25 23 23

N. America New Brunswick NB 62 62 56 43 56 37 43 31 31 25 21 21

N. America North Carolina NC 68 60 55 40 45 35 40 30 30 25 13 13

N. America North Dakota ND 68 60 60 40 50 35 45 35 35 25 15 15

N. America Nebraska NE 68 60 60 40 50 35 45 35 35 25 15 15

N. America New Hampshire NH 65 60 55 40 45 35 45 35 30 25 13 13

N. America Nicaragua NU 59 50 41 27 27 18 23 14 16 9 5 5

N. America New Jersey NJ 65 55 55 40 45 30 35 30 25 25 13 13

N. America Newfoundland and Labrador NL 62 62 62 43 56 37 43 31 31 25 21 21

N. America New Mexico NM 68 60 60 40 50 35 45 35 35 25 15 15

N. America Nova Scotia NS 62 62 62 43 56 37 43 31 31 25 21 21

N. America Northwest Territory NT 56 56 56 43 56 37 43 31 31 25 21 21

N. America Nunavut NU 59 50 41 27 27 18 23 14 16 9 5 5

N. America Nevada NV 68 60 60 40 50 35 45 35 35 25 21 21

N. America Nuevo Leon NX 68 62 56 43 49 37 43 31 31 25 23 23




Divided Highway

Primary Highway



N. America New York NY 65 60 55 40 45 30 35 30 25 25 13 13

N. America Oaxaca OA 68 62 56 43 49 37 43 31 31 25 23 23

N. America Ohio OH 65 60 55 40 45 35 40 30 30 25 15 15

N. America Oklahoma OK 68 60 60 40 50 35 45 35 35 25 15 15

N. America Ontario ON 62 62 62 43 49 37 43 31 31 25 21 21

N. America Oregon OR 55 55 50 40 45 35 40 30 30 25 16 16

N. America Pennsylvania PA 65 55 55 40 45 30 35 30 25 25 13 13

N. America Prince Edward Island PE 62 62 56 43 56 37 49 37 31 25 21 21

N. America Panama PM 62 56 56 43 49 37 37 31 31 25 21 21

N. America Puerto Rico PR 65 55 45 40 45 30 30 30 30 25 15 15

N. America Puebla PU 68 62 56 43 49 37 43 31 31 25 23 23

N. America Queretaro Arteaga QA 68 62 56 43 49 37 43 31 31 25 23 23

N. America Quebec QC 62 62 56 37 56 37 49 37 31 25 21 21

N. America Quintana Roo QR 68 62 56 43 49 37 43 31 31 25 23 23

N. America Rhode Island RI 65 55 55 40 45 30 35 30 25 25 13 13

N. America South Carolina SC 68 60 55 40 45 35 40 30 30 25 13 13

N. America South Dakota SD 68 60 60 40 50 35 45 35 35 25 15 15

N. America Sinaloa SI 68 62 56 43 49 37 43 31 31 25 23 23

N. America Saskatchewan SK 62 62 62 43 56 37 43 37 31 25 21 21

N. America San Luis Potosi SL 68 62 56 43 49 37 43 31 31 25 23 23

N. America Sonora SO 68 62 56 43 49 37 43 31 31 25 23 23

N. America Tabasco TA 68 62 56 43 49 37 43 31 31 25 23 23

N. America Tlaxcala TL 68 62 56 43 49 37 43 31 31 25 23 23

N. America Tamaulipas TM 68 62 56 43 49 37 43 31 31 25 23 23

N. America Tennessee TN 68 60 55 40 45 35 40 30 30 25 15 15

N. America Texas TX 68 60 60 40 50 35 45 35 35 25 15 15

N. America Utah UT 68 60 60 40 50 35 45 35 35 25 15 15




Divided Highway

Primary Highway



N. America Virginia VA 65 60 55 40 45 30 40 30 30 25 13 13

N. America Vermont VT 65 55 55 40 45 35 45 35 30 25 15 15

N. America Veracruz VZ 68 62 56 43 49 37 43 31 31 25 23 23

N. America Washington WA 60 60 55 40 45 30 35 30 30 25 16 16

N. America Wisconsin WI 65 60 60 40 45 35 45 35 35 25 18 18

N. America West Virginia WV 68 55 55 40 45 35 35 30 30 25 15 15

N. America Wyoming WY 68 60 60 40 50 35 45 35 35 25 15 15

N. America Yucatan YC 68 62 56 43 49 37 43 31 31 25 23 23

N. America Yukon Territory YT 56 56 56 43 56 37 49 37 31 25 21 21

N. America Zacatecas ZT 68 62 56 43 49 37 43 31 31 25 23 23

Oceania American Samoa AQ 50 43 43 37 37 31 31 25 25 18 18 18

Oceania Australia AS 68 56 56 43 50 37 37 25 25 18 22 22

Oceania Solomon Islands BP 50 43 43 37 37 31 31 25 25 18 18 18

Oceania Northern Mariana Islands CQ 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Cook Islands CW 50 43 43 37 37 31 31 25 25 18 18 18

Oceania Fiji FJ 50 43 43 37 37 31 31 25 25 18 18 18

Oceania Micronesia, Federated States of FM 50 43 43 37 37 31 31 25 25 18 18 18

Oceania French Polynesia FP 50 43 43 37 37 31 31 25 25 18 20 20

Oceania French Southern and Antarctic Islands FS 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Guam GQ 45 45 45 35 35 35 35 25 25 18 18 18

Oceania Kiribati KR 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Midway Island MQ 50 43 43 37 37 31 31 25 25 18 18 18

Oceania New Caledonia NC 50 43 43 37 37 31 31 25 25 18 22 22

Oceania Niue NE 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Norfolk Island NF 50 43 43 37 37 31 31 25 25 18 18 18




Divided Highway

Primary Highway



Oceania Vanuatu NH 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Nauru NR 50 43 43 37 37 31 31 25 25 18 15 15

Oceania New Zealand NZ 62 56 56 43 43 31 37 25 25 18 23 23

Oceania Pitcairn PC 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Palau PS 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Marshall Islands RM 50 43 43 37 37 31 31 25 25 18 18 18

Oceania Tokelau TL 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Tonga TN 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Tuvalu TV 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Wallis & Futuna Islands WF 50 43 43 37 37 31 31 25 25 18 15 15

Oceania Wake Island WQ 50 43 43 37 37 31 31 25 25 18 18 18

Oceania Western Samoa WS 50 43 43 37 37 31 31 25 25 18 18 18

S. America Aruba AA 56 43 43 37 37 31 31 25 18 18 24 24

S. America Antigua and Barbuda AC 56 43 43 37 37 31 31 25 18 18 16 16

S. America Argentina AR 68 50 50 37 37 31 31 25 18 12 21 21

S. America Anguilla AV 56 43 43 37 37 31 31 25 18 18 20 20

S. America Barbados BB 56 43 43 37 37 31 31 25 18 18 16 16

S. America Bahamas BF 56 43 43 37 37 31 31 25 18 18 26 26

S. America Bolivia BL 62 50 50 37 37 31 31 25 18 12 21 21

S. America Brazil BR 68 43 50 37 37 25 31 18 18 12 21 21

S. America Chile CI 62 50 43 37 31 31 25 25 18 12 21 21

S. America Cayman Islands CJ 56 43 43 37 37 31 31 25 18 18 20 20

S. America Colombia CO 62 50 43 37 31 31 25 25 18 12 21 21

S. America Cuba CU 56 43 43 37 37 31 31 25 18 18 23 23

S. America Dominica DO 56 43 43 37 37 31 31 25 18 18 20 20

S. America Dominican Republic DR 56 43 43 37 37 31 31 25 18 18 16 16

S. America Ecuador EC 62 50 43 37 31 31 25 25 18 12 21 21




Divided Highway

Primary Highway



S. America French Guiana FG 62 50 50 37 37 31 31 25 18 12 21 21

S. America Falkland Islands (Malvinas) FK 56 43 43 37 37 31 31 25 18 18 12 12

S. America Grenada GJ 56 43 43 37 37 31 31 25 18 18 20 20

S. America Guadeloupe GP 56 43 43 37 37 31 31 25 18 18 20 20

S. America Guyana GY 62 50 50 37 37 31 31 25 18 12 21 21

S. America Haiti HA 56 43 43 37 37 31 31 25 18 18 20 20

S. America Jamaica JM 56 43 43 37 37 31 31 25 18 18 23 23

S. America Martinique MB 56 43 43 37 37 31 31 25 18 18 20 20

S. America Montserrat MH 56 43 43 37 37 31 31 25 18 18 16 16

S. America Sint Maarten NN 56 43 43 37 37 31 31 25 18 18 16 16

S. America Suriname NS 62 50 50 37 37 31 31 25 18 12 21 21

S. America Netherlands Antilles NT 56 43 43 37 37 31 31 25 18 18 16 16

S. America Paraguay PA 62 50 50 37 37 31 31 25 18 12 21 21

S. America Peru PE 62 50 43 37 31 31 25 25 18 12 21 21

S. America Saint Martin RN 56 43 43 37 37 31 31 25 18 18 16 16

S. America Saint Kitts and Nevis Islands SC 56 43 43 37 37 31 31 25 18 18 16 16

S. America Saint Lucia ST 56 43 43 37 37 31 31 25 18 18 20 20

S. America Saint Barthelemy TB 56 43 43 37 37 31 31 25 18 18 16 16

S. America Trinidad and Tobago TD 62 50 43 37 31 31 25 25 18 12 25 25

S. America Turks and Caicos Islands TK 56 43 43 37 37 31 31 25 18 18 16 16

S. America Curacao UC 56 43 43 37 37 31 31 25 18 18 16 16

S. America Uruguay UY 62 50 50 37 37 31 31 25 18 12 21 21

S. America Saint Vincent and the Grenadines VC 56 43 43 37 37 31 31 25 18 18 20 20

S. America Venezuela VE 62 50 43 37 31 31 25 25 18 12 21 21




Divided Highway

Primary Highway



S. America British Virgin Islands VI 56 43 43 37 37 31 31 25 18 18 24 24

S. America United States Virgin Islands VQ 56 43 43 37 37 31 31 25 18 18 24 24

| 239


Appendix I: Migrating Applications from ALK|FleetSuite Directions to PC*MILER Web Services

The table below shows, at an API level, how an application currently using ALK|FleetSuite Directions would be modified to now use PC*MILER Web Services. For each Directions API, the corresponding Web Services API is shown along with notes on anything that the user should be aware of. Please refer to the relevant sections in this User’s Guide for specifics around each API call.

Directions API PC*MILER Web Services API Notes

GetDirFromAdrToAdr PMWSGetReport

this is an archaic Directions API

to exactly replicate the functionality the user would request driver report and set the condensation level

GetDirections PMWSGetReport driver report

MapGetRoute PMWSGetMapRoute

GetDirFromLonLatToAddr PMWSGetReport driver report

GetLonLatFromAdr PMWSGeocode

GetETAOoRFromAdrToAdr PMWSGetETAOutOfRoute

GetNearCitiesFromLonLat PMWSGeocode

MapGetImageArea PMWSGetMap

GetDirFromLonLatToLonLat PMWSGetReport driver report

GetDirFromAdrToLonLat PMWSGetReport driver report

MapGetPinLonLat PMWSGetMap

| 240


Appendix J: Sample Code Code samples can be downloaded from http://pcmiler.com/support .

| 241


Appendix K: Toll Plaza Names in Reports (U.S. and Canada) The chart on the following pages identifies the toll authorities that have assigned multiple names to the same toll plaza location. When generating a route using PC*MILER|Tolls, only one name for each toll plaza location is provided in the Detailed Route Report. Because a vehicle can travel through any of the sub-plazas at one of these locations, this chart may help you match up agency names to the names that appear along a route in the Detailed Route Report. Currently, in Version 27, there is only one toll plaza location in the database that has multiple names assigned to it.

Agency Toll Road Toll Plaza Name Plaza

Abbreviation in Data

Other Plaza Abbreviations

Used By Agency

Other Plaza Names Used by Agency at Same Location

VDOT Chesapeake Expressway Chesapeake Expressway 16, 17 18* * 18 is the abbreviation used for Discount Program Members.

| 242


Appendix L: Toll Roads Requiring Electronic Payment (U.S. and Canada) Table 1 below lists roads that only accept toll discount programs. No cash or other payment option is offered, and driving on one of these roads without a transponder and discount program membership will cause an invoice to be sent with a surcharge added to the toll rate. Table 2 lists all electronic toll roads (Open Road Tolling). Like the roads in Table 1, drivers without a transponder on these roads will receive an invoice with a video toll rate amount. What differentiates these two types of roads is the amount of the surcharge on the roads in Table 1: these roads carry a relatively expensive surcharge, and the transportation authorities strongly advise against driving on these roads without a transponder.

TABLE 1. Roads Accepting Only Toll Discount Programs – Additional Surcharge on Violations

State Toll Road/Exits Discount Program Video Toll/Cash Comments

Florida Florida Turnpike SunPass None For the Florida Turnpike, the five exits listed are SunPass Only. Drivers without SunPass are required to exit before or after these exits. If used by mistake then an invoice is sent home with a surcharge.

Becker Road exit 138 SunPass None

Jog Road exit 98 SunPass None

SR 710 exit 107 SunPass None

Consulate Drive exit 255 SunPass None

Kissimmee Park Rd exit 240 SunPass None

Pennsylvania PA Turnpike EZPass None For the two exits listed here a video toll plus a surcharge is sent

Appendix L: Toll Roads Requiring Electronic Payment | 243



in an invoice.

Virginia Drive exit 340 EZPass None

Street Road exit 352 EZPass None

Texas Camino Colombia Toll Road TxTag, TollTag, EZ TAG None Invoice sent with the surcharge added to the toll rate. You must have a TxTag account or other accepted prepaid account to pay tolls on Camino Colombia. Under Texas law, non‐payment of tolls is a misdemeanor offense, and you may be subject to Administrative fees and fines of up to $350 per violation.

Texas Fort Bend Parkway Toll Road EZ Tag, TxTag None A fee is added to the toll rate and an invoice is sent to drivers who don’t use EZ Tag.

Texas Fort Bend Westpark Tollway EZ Tag, TxTag None A fee is added to the toll rate and an invoice it sent to drivers who don’t use EZ Tag.

Texas Westpark Tollway EZ Tag None Driving without an EZ Tag ends in a toll violation event, can result in a Toll Violation Invoice being sent to the registered owner/renter for the past‐due toll amount plus fees of $33.

Texas Sam Houston Tollway EZ Tag, TxTag, TollTag Video Toll There are eleven plazas that require an EZ Tag. For the first two violations drivers can go to store or call and pay the toll for




the third violation an invoice with a surcharge of $33 is generated.

North Gessner EZ Tag, TxTag, TollTag Video Toll

West Road Entrance Ramp EZ Tag, TxTag, TollTag Video Toll

Hammerly Blvd Entrance Ramp

EZ Tag, TxTag, TollTag Video Toll

Bellaire Blvd Entrance Ramp EZ Tag, TxTag, TollTag Video Toll

Tidwell Road EZ Tag, TxTag, TollTag Video Toll

Garrett Road EZ Tag, TxTag, TollTag Video Toll

Winfield Road EZ Tag, TxTag, TollTag Video Toll

Northeast Toll Plaza EZ Tag, TxTag, TollTag Video Toll

W Lake Houston Parkway EZ Tag, TxTag, TollTag Video Toll

John Ralston Road EZ Tag, TxTag, TollTag Video Toll

Wilson Road EZ Tag, TxTag, TollTag Video Toll

Texas Hardy Toll Road EZ Tag, TxTag, TollTag Video Toll There are eleven plazas that require an EZ Tag. For the first two violations drivers can go to a store or call and pay the toll, for the third violation an invoice with a surcharge of $33 is generated.

Rankin Road South EZ Tag, TxTag, TollTag Video Toll



TABLE 2. Electronic Toll Roads (Open Road Tolling)

State Toll Road/Exits Discount Program Video

Toll/Cash Comments

British Columbia

Golden Ears Bridge Quickpass Pay As You Go If the driver is not a registered customer, the license plate information is forwarded electronically to ICBC when the bridge is crossed. TransLink uses the information received from ICBC to send a bill for the toll amount to the registered owner of the vehicle.

Florida Snapper Creek Expressway SunPass Toll‐By‐Plate

Don Shula Expressway SR 874 SunPass Toll‐By‐Plate

Gratigny Parkway SunPass Toll‐By‐Plate

Homestead Extension Of Florida's Turnpike

SunPass Toll‐By‐Plate

Lee Roy Selmon Crosstown Expressway

SunPass We Bill You

Illinois Tri‐State Tollway I‐Pass, EZPass Video Toll Rate For the highlighted exit which is an all electronic tolling ramps, no cash accepted. Cash customers will incur an unpaid toll and are responsible for paying the cash fare indicated on within 7 days of the event.

Balmoral I‐Pass, EZPass Video Toll Rate

Ronald Reagan Tollway I‐Pass, EZPass Video Toll Rate For the highlighted exit which is an all electronic tolling ramps, no cash accepted. Cash customers will incur an unpaid toll and are responsible for paying the cash fare indicated on within 7 days of the event.




Toll/Cash Comments

Eola Road I‐Pass, EZPass Video Toll Rate

Maryland Intercounty Connector MD 200 EZPass Video Toll Rate

North Carolina

Triangle Expressway NC Quick Pass Bill By Mail

Ontario 407 ETR 407 ETR Transponder

Video Toll Charge

Quebec A 25 Bridge A25 Transponder Video Toll Charge

Texas 183A TxTag Pay By Toll

Addison Airport Tunnel TollTag, TxTag ZipCash

Dallas North Tollway TollTag ZipCash

Lewisville Lake Toll Bridge TollTag ZipCash

Loop 49 TxTag, TollTag, EZ TAG

Pay By Mail

President George Bush Turnpike TollTag ZipCash

PGBT Western Extension SH 161 TollTag ZipCash

Mountain Creek Lake Toll Bridge TollTag ZipCash

Sam Rayburn Tollway TollTag ZipCash

SH 550 TxTag, TollTag, EZ Tag

Pay By Mail Rate

Texas State Highway 99 TxTag, EZ Tag, TollTag

Notice By Mail

Virginia Pocahontas Parkway EZPass EZPass, Visa or Mastercard

The two listed exits are no cash exits, The Mainline Plaza is also cashless overnight from 11 p.m to 5 a.m. Payment options are Visa/Mastercard Debit/Credit cards

Laburnum Avenue EZPass EZPass, Visa or




Toll/Cash Comments

Mastercard

Airport Connector EZPass EZPass, Visa or Mastercard

Washington SR 520 Bridge Good To Go Pay By Mail

Documents

PC*MILER Web Services ASMX User’s · PDF file|i pc*miler web services asmx user’s guide table of contents pc*miler product line end-user license agreement..... v

PCMILER Web Services ASMX User’s · PDF file|i pcmiler web services asmx user’s guide table of contents pc*miler product line end-user license agreement..... v