Publication Date: 2020-01-21
Approval Date: 2019-11-22
Submission Date: 2019-09-06
Reference number of this document: OGC 19-040
Reference URL for this document: http://www.opengis.net/doc/PER/WPSroutingAPI
Category: OGC Public Engineering Report
Editor: Christian Autermann
Title: WPS Routing API ER
Copyright © 2020 Open Geospatial Consortium. To obtain additional rights of use, visit http://www.opengeospatial.org/
This document is not an OGC Standard. This document is an OGC Public Engineering Report created as a deliverable in an OGC Interoperability Initiative and is not an official position of the OGC membership. It is distributed for review and comment. It is subject to change without notice and may not be referred to as an OGC Standard. Further, any OGC Public Engineering Report should not be referenced as required or mandatory technology in procurements. However, the discussions in this document could very well lead to the definition of an OGC Standard.
Permission is hereby granted by the Open Geospatial Consortium, ("Licensor"), free of charge and subject to the terms set forth below, to any person obtaining a copy of this Intellectual Property and any associated documentation, to deal in the Intellectual Property without restriction (except as set forth below), including without limitation the rights to implement, use, copy, modify, merge, publish, distribute, and/or sublicense copies of the Intellectual Property, and to permit persons to whom the Intellectual Property is furnished to do so, provided that all copyright notices on the intellectual property are retained intact and that each person to whom the Intellectual Property is furnished agrees to the terms of this Agreement.
If you modify the Intellectual Property, all copies of the modified Intellectual Property must include, in addition to the above copyright notice, a notice that the Intellectual Property includes modifications that have not been approved or adopted by LICENSOR.
THIS LICENSE IS A COPYRIGHT LICENSE ONLY, AND DOES NOT CONVEY ANY RIGHTS UNDER ANY PATENTS THAT MAY BE IN FORCE ANYWHERE IN THE WORLD. THE INTELLECTUAL PROPERTY IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT OF THIRD PARTY RIGHTS. THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE DO NOT WARRANT THAT THE FUNCTIONS CONTAINED IN THE INTELLECTUAL PROPERTY WILL MEET YOUR REQUIREMENTS OR THAT THE OPERATION OF THE INTELLECTUAL PROPERTY WILL BE UNINTERRUPTED OR ERROR FREE. ANY USE OF THE INTELLECTUAL PROPERTY SHALL BE MADE ENTIRELY AT THE USER’S OWN RISK. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR ANY CONTRIBUTOR OF INTELLECTUAL PROPERTY RIGHTS TO THE INTELLECTUAL PROPERTY BE LIABLE FOR ANY CLAIM, OR ANY DIRECT, SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING FROM ANY ALLEGED INFRINGEMENT OR ANY LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR UNDER ANY OTHER LEGAL THEORY, ARISING OUT OF OR IN CONNECTION WITH THE IMPLEMENTATION, USE, COMMERCIALIZATION OR PERFORMANCE OF THIS INTELLECTUAL PROPERTY.
This license is effective until terminated. You may terminate it at any time by destroying the Intellectual Property together with all copies in any form. The license will also terminate if you fail to comply with any term or condition of this Agreement. Except as provided in the following sentence, no such termination of this license shall require the termination of any third party end-user sublicense to the Intellectual Property which is in force as of the date of notice of such termination. In addition, should the Intellectual Property, or the operation of the Intellectual Property, infringe, or in LICENSOR’s sole opinion be likely to infringe, any patent, copyright, trademark or other right of a third party, you agree that LICENSOR, in its sole discretion, may terminate this license without any compensation or liability to you, your licensees or any other party. You agree upon termination of any kind to destroy or cause to be destroyed the Intellectual Property together with all copies in any form, whether held by you or by any third party.
Except as contained in this notice, the name of LICENSOR or of any other holder of a copyright in all or part of the Intellectual Property shall not be used in advertising or otherwise to promote the sale, use or other dealings in this Intellectual Property without prior written authorization of LICENSOR or such copyright holder. LICENSOR is and shall at all times be the sole entity that may authorize you or any third party to use certification marks, trademarks or other special designations to indicate compliance with any LICENSOR standards or specifications.
This Agreement is governed by the laws of the Commonwealth of Massachusetts. The application to this Agreement of the United Nations Convention on Contracts for the International Sale of Goods is hereby expressly excluded. In the event any provision of this Agreement shall be deemed unenforceable, void or invalid, such provision shall be modified so as to make it valid and enforceable, and as so modified the entire Agreement shall remain in full force and effect. No decision, action or inaction by LICENSOR shall be construed to be a waiver of any rights or remedies available to it.
None of the Intellectual Property or underlying information or technology may be downloaded or otherwise exported or reexported in violation of U.S. export laws and regulations. In addition, you are responsible for complying with any local laws in your jurisdiction which may impact your right to import, export or use the Intellectual Property, and you represent that you have complied with any regulations or registration procedures required by applicable law to make this license enforceable.
- 1. Subject
- 2. Executive Summary
- 3. References
- 4. Terms and definitions
- 5. Overview
- 6. Pilot Requirements for Web-based Routing
- 7. OGC API - Processes
- 8. Routing API
- 8.1. Overview
- 8.2. Requirements Class "Core"
- 8.3. Requirements Class "Delete route"
- 8.4. Requirements Class "Callback"
- 8.5. Requirements Class "Result set"
- 8.6. Requirements Class "Synchronous execution"
- 8.7. Requirements Class "Intermediate waypoints"
- 8.8. Requirements Class "Height restriction"
- 8.9. Requirements Class "Load restriction"
- 8.10. Requirements Class "Obstacles"
- 8.11. Requirements Class "Temporal constraints"
- 8.12. Requirements Class "Routing engine"
- 8.13. Requirements Class "Routing algorithm"
- 8.14. Requirements Class "Source dataset"
- 8.15. WPS Profile of the Routing API
- 8.16. Discussion of the two options
- 8.17. Security considerations
- Appendix A: Process Description
- Appendix B: Example Requests
- B.1. GET Landing Page
- B.2. GET Conformance Classes
- B.3. GET Processes
- B.4. GET Process Description
- B.5. POST Job
- B.6. GET Job Description
- B.7. GET Job Result
- B.8. GET Routes
- B.9. POST Route Definition
- B.10. GET Route
- Appendix C: Revision History
- Appendix D: Bibliography
The goal of this OGC WPS Routing API Engineering Report (ER) is to document the specification of an Application Programming Interface (API) which supports geographic routing. The specification includes two alternative approaches to such an API, one based on the current draft of the OGC API - Processes draft specification and another based on the OGC API principles (and the OGC API - Common draft specification). Both approaches facilitate a common Route Exchange Model.
This OGC WPS Routing API Engineering Report (ER) documents the requirements for interoperable web-based route computation and contains the specification of two alternative approaches to fulfill these requirements. One is based on the current draft of the OGC API - Processes draft specification while the other is based on the OGC API principles (and the OGC API - Common draft specification) and comprises a specialized API. Note that the OGC API - Processes draft specification is based on the existing Web Processing Service (WPS) standard. Both approaches facilitate a common Route Exchange Model that is based on GeoJSON and is specified in the Routing Pilot ER . A visualization of this Route Exchange Model can be seen in Figure 1.