Open Geospatial Consortium |
Submission Date: <yyyy-mm-dd> |
Approval Date: <yyyy-mm-dd> |
Publication Date: <yyyy-mm-dd> |
External identifier of this OGC® document: http://www.opengis.net/doc/is/rem/1.0.0-draft.1 |
Internal reference number of this OGC® document: 21-001 |
Version: 1.0.0-draft.1 |
Category: OGC® Implementation Specification |
Editor: Clemens Portele |
OGC Route Exchange Model |
Copyright notice |
Copyright © 2022 Open Geospatial Consortium |
To obtain additional rights of use, visit http://www.opengeospatial.org/legal/ |
Warning |
This document is not an OGC Standard. This document is distributed for review and comment. This document is subject to change without notice and may not be referred to as an OGC Standard.
Recipients of this document are invited to submit, with their comments, notification of any relevant patent rights of which they are aware and to provide supporting documentation.
Document type: OGC® Standard |
Document subtype: if applicable |
Document stage: Draft |
Document language: English |
License Agreement
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.
- 1. Scope
- 2. Conformance
- 3. References
- 4. Terms and Definitions
- 5. Conventions
- 6. Overview of the Route model
- 7. Route Exchange Model
- 8. Media Types
- Annex A: Abstract Test Suite (Normative)
- A.1. Conformance Class "Route Exchange Model"
- A.1.1. Conformance Test 1
- A.1.2. Conformance Test 2
- A.1.3. Conformance Test 3
- A.1.4. Conformance Test 4
- A.1.5. Conformance Test 5
- A.1.6. Conformance Test 6
- A.1.7. Conformance Test 7
- A.1.8. Conformance Test 8
- A.1.9. Conformance Test 9
- A.1.10. Conformance Test 10
- A.1.11. Conformance Test 11
- A.1.12. Conformance Test 12
- A.1.13. Conformance Test 13
- A.1.14. Conformance Test 14
- A.1.15. Conformance Test 15
- A.1.16. Conformance Test 16
- A.1. Conformance Class "Route Exchange Model"
- Annex B: JSON Schema (Normative)
- Annex C: Example (Informative)
- Annex D: Revision History
- Annex E: Bibliography
i. Abstract
The Route Exchange Model represents a route as a JSON document in a standardized way that is independent of the underlying data, routing engine software, and algorithms that are used to compute the route.
For example, the complementary standard OGC API - Routes - Part 1: Core uses the Route Exchange Model to represent and share routes with users on the web.
For providers of routes, the API building blocks and the Route Exchange Model provide a simple model to publish and offer those routes as resources for use by other systems.
For users, applications, and enterprises, the capability to get routes in a common format, regardless of the underlying routing data, engines, or algorithms, represents a significant step forward in geospatial interoperability.
ii. Keywords
The following are keywords to be used by search engines and document catalogues.
OGC, Routing, Routing API, Route Exchange Model
iii. Preface
The work on this Standard started in the OGC Open Routing Pilot. After the pilot, the work on the specification continued in the OGC Routing Standards Working Group.
Attention is drawn to the possibility that some of the elements of this document may be the subject of patent rights. The Open Geospatial Consortium shall not be held responsible for identifying any or all such patent rights.
Recipients of this document are requested to submit, with their comments, notification of any relevant patent claims or other intellectual property rights of which they may be aware that might be infringed by any implementation of the standard set forth in this document, and to provide supporting documentation.
iv. Submitting organizations
The following organizations submitted this Document to the Open Geospatial Consortium (OGC):
-
US Army Geospatial Center (AGC)
-
Ecere Corporation
-
interactive instruments GmbH
-
Skymantics LLC
v. Submitters
All questions regarding this submission should be directed to the editor or the submitters:
Name | Affiliation |
---|---|
Clemens Portele (editor) |
interactive instruments GmbH |
Jeff Harrison |
US Army Geospatial Center (AGC) |
Amy Youmans |
US Army Geospatial Center (AGC) |
Jérôme Jacovella-St-Louis |
Ecere Corporation |
Ignacio Correas |
Skymantics LLC |
1. Scope
This document specifies the Route Exchange Model (REM).
The REM is a GeoJSON representation of a route, independent of the underlying routing data set, routing engine or algorithm.
2. Conformance
This Standard defines one requirements / conformance class:
The standardization target of the conformance class is JSON.
Conformance with this Standard shall be checked using all the relevant tests specified in Annex A (normative) of this document. The framework, concepts, and methodology for testing, and the criteria to be achieved to claim conformance are specified in the OGC Compliance Testing Policies and Procedures and the OGC Compliance Testing web site.
Conformance class | URI |
---|---|
|
3. References
The following normative documents contain provisions that, through reference in this text, constitute provisions of this document. For dated references, subsequent amendments to, or revisions of, any of these publications do not apply. For undated references, the latest edition of the normative document referred to applies.
-
Internet Engineering Task Force (IETF). RFC 3339: Date and Time on the Internet: Timestamps [online]. Edited by G. Klyne, C. Newman. 2002 [viewed 2020-03-16]. Available at http://tools.ietf.org/rfc/rfc3339.txt
-
Internet Engineering Task Force (IETF). RFC 7946: The GeoJSON Format [online]. Edited by H. Butler, M. Daly, A. Doyle, S. Gillies, S. Hagen, T. Schaub. 2016 [viewed 2020-03-16]. Available at http://tools.ietf.org/rfc/rfc7946.txt
4. Terms and Definitions
This document used the terms defined in OGC Policy Directive 49, which is based on the ISO/IEC Directives, Part 2, Rules for the structure and drafting of International Standards. In particular, the word “shall” (not “must”) is the verb form used to indicate a requirement to be strictly followed to conform to this standard and OGC documents do not use the equivalent phrases in the ISO/IEC Directives, Part 2.
This document also uses terms defined in the OGC Standard for Modular specifications (OGC 08-131r3), also known as the 'ModSpec'. The definitions of terms such as standard, specification, requirement, and conformance test are provided in the ModSpec.
For the purposes of this document, the following additional terms and definitions apply.
- feature
-
abstraction of real world phenomena [ISO 19101-1:2014]
- GeoJSON
-
geospatial data interchange format based on JavaScript Object Notation (JSON) [IETF RFC 7946]
- route
-
sequence of connected segments providing directions to travel between specific waypoints
Note
|
This definition doesn’t use the definition from ISO 19134:2007 because of use of terms such as "links" and "network". |
- waypoint
-
location that plays a role in choosing candidate routes potentially satisfying a routing request [ISO 19133:2005]
- Web API
-
API using an architectural style that is founded on the technologies of the Web [OGC API - Features - Part 1: Core]
5. Conventions
This section provides details and examples for any conventions used in the document.
5.1. Identifiers
The normative provisions in this Standard are denoted by the URI
http://www.opengis.net/spec/rem/1.0.0-draft.1
All requirements and conformance tests that appear in this document are denoted by partial URIs which are relative to this base.
Note
|
The URI is temporary during the development of this specification. The final URI in the published standard will be http://www.opengis.net/spec/rem/1.0 .
|
5.2. JSON schema
This document uses JSON Schema to document the syntax of the Route Exchange Model.
The complete schema is available in JSON schema of the Route Exchange Model in GeoJSON.
6. Overview of the Route model
6.1. Scenarios
The Route model is driven by three routing scenarios. These were:
-
Online - fully connected with stability
-
Intermittent - unreliable connection
-
Offline - no connectivity
6.1.1. Online scenario
In the Online scenario, an operator uses a routing client to request a route from a Routing API provider, which in turn retrieves the route from an online routing engine. In this scenario all components have consistent connections between them and out to the wider internet.
This scenario uses OGC API Routes for all request and response handling between the client and the routing infrastructure.
6.1.2. Intermittent scenario
The intermittent scenario is where the components have connectivity, but it is not necessarily consistent, stable, reliable, or high-speed.
Therefore, the network cannot be relied upon to provide connectivity on demand and compensation actions are likely when connectivity is not available. Intermittent connectivity is unpredictable and it maybe that in the real-world, decisions are made to treat intermittent connectivity as no connectivity, as it is the only sensible course of action, especially if the scenario involves threat to life.
For example, only one of the clients had access to a routing engine. Therefore, the connected client had the ability to create routes, but other clients cannot. If the clients are able to communicate with each other via some other means (Bluetooth or some other peer-to-peer communication, for example), the clients could still share pre-defined routes, that is, the routing operation has been completed when a connection to the routing engine was established, but has now been lost.
Another approach to support in particular low-bandwidth situations is to not transmit the complete route definition to the client, but to return route information segment by segment as the vehicle moves along the route. This approach is not supported by this standard and might be added in a future extension or revision.
6.1.3. Offline scenario
The Offline scenario assumes that there is no connectivity outside of a device’s local network, this could be a desktop computer, mobile device or a mesh. In the real-world the scenario is modeling an instance where there is no connectivity and there is not going to be any connectivity for the duration of an operation.
An operator uses the routing functionality provided by the client to create a route. The operator then shares this route with other local clients using the route exchange model. To enable the required functionality, all of the capability has to be tightly coupled in a single location. Practically, this involves installing all of the components on the same machine to remove communication dependencies with the wider network.
6.2. The Route model
6.2.2. Route
-
an
Object
-
association role
describedBy
-
multiplicity: 1
-
value:
RouteDefinition
-
-
attribute
end
-
definition: The end point of the route.
-
multiplicity: 1
-
value:
Destination
-
-
attribute
name
-
definition: Title of the route.
-
multiplicity: 0..1
-
value:
CharacterString
-
-
attribute
overview
-
multiplicity: 1
-
value:
RouteOverview
-
-
attribute
segments
-
multiplicity: 1..*
-
value:
RouteSegment
-
-
attribute
start
-
definition: The start point of the route.
-
multiplicity: 1
-
value:
Start
-
-
constraints:
-
overview.duration=segments→collect(duration)→sum()
-
overview.length=segments→collect(length)→sum()
-
6.2.3. RouteComponent
-
a supertype of
RouteOverview
,RouteSegment
,Waypoint
-
a
Feature
-
is abstract
-
attribute
type
-
multiplicity: 1
-
values:
-
start
-
end
-
overview
-
segment
-
-
6.2.4. RouteDefinition
-
a
Object
-
definition: Information about the definition of the route. At a minimum, a route is defined by two waypoints, the start and end point of the route.
-
attribute
end
-
multiplicity: 1
-
value:
Waypoint
-
-
attribute
intermediate
-
definition: Additional waypoints along the route between start and end to consider when computing the route.
-
multiplicity: 0..*
-
value:
Waypoint
-
-
attribute
maxHeight
-
definition: A height restriction for vehicles in meters to consider when computing the route.
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
maxWeight
-
definition: A weight restriction for vehicles in metric tons (tonnes) to consider when computing the route.
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
obstacles
-
definition: Areas the route should avoid.
-
note: Currently this uses a simple approach. In general, the list of obstacles could also be a feature collection where every obstacle is a feature. Such a representation would be required, if the routing engine is able to handle obstacles with different characteristics/properties (for example, an obstacle is only valid for a certain time interval).
-
multiplicity: 0..1
-
value:
GM_MultiSurface
-
-
attribute
preference
-
definition: The optimization goal for the route calculation (fastest, shortest, etc.).
-
multiplicity: 1
-
default:
fastest
-
values:
-
fastest
-
shortest
-
…
-
-
-
attribute
start
-
multiplicity: 1
-
value:
Waypoint
-
-
attribute
temporal
-
definition: The time of departure or arrival. The default value is an immediate departure.
-
multiplicity: 0..1
-
value:
TemporalConstraint
-
6.2.5. RouteOverview
-
a subtype of
RouteComponent
-
a
Feature
-
attribute
comment
-
definition: Explains any minor issues that were encountered during the processing of the routing request, i.e. any issues that did not result in an error.
-
multiplicity: 0..1
-
value:
CharacterString
-
-
attribute
duration
-
definition: Estimated amount of time required to travel the route in seconds.
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
length
-
definition: Length of the route in meters.
-
multiplicity: 1
-
value:
Measure
-
-
attribute
maxHeight
-
definition: A known height restriction on the route in meters.
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
maxWeight
-
definition: A known weight restriction on the route in metric tons (tonnes).
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
obstacles
-
definition: Describes how obstacles were taken into account in the route calculation.
-
multiplicity: 0..1
-
value:
CharacterString
-
-
attribute
path
-
definition: The path from the start point to the end point of the route.
-
multiplicity: 1
-
value:
GM_Curve
-
-
attribute
processingTime
-
definition: The time when the route was calculated.
-
multiplicity: 0..1
-
value:
DateTime
-
-
constraints:
-
type = 'overview'
-
6.2.6. RouteSegment
-
a subtype of
RouteComponent
-
a
Feature
-
attribute
duration
-
definition: Estimated amount of time required to travel the segment in seconds.
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
instructions
-
definition: An instruction for the maneuver at the end of the segment.
-
multiplicity: 0..1
-
value:
CharacterString
-
-
attribute
length
-
definition: Length of the segment in meters.
-
multiplicity: 1
-
value:
Measure
-
-
attribute
locationAtEnd
-
definition: The last position of the segment and be on the path geometry of the route overview.
-
multiplicity: 1
-
value:
GM_Point
-
-
attribute
maxHeight
-
definition: A known height restriction in meters.
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
maxWeight
-
definition: A known weight restriction in metric tons (tonnes).
-
multiplicity: 0..1
-
value:
Measure
-
-
attribute
roadName
-
definition: The road/street name of the segment.
-
multiplicity: 0..1
-
value:
CharacterString
-
-
attribute
speedLimit
-
definition: A known speed limit on the segment.
-
multiplicity: 0..1
-
value:
Measure
-
-
constraints:
-
type = 'segment'
-
6.2.8. TemporalConstraint
-
a
Data type
-
attribute
timestamp
-
multiplicity: 1
-
value:
DateTime
-
-
attribute
type
-
multiplicity: 1
-
default:
departure
-
values:
-
departure
-
`arrival `
-
-
6.2.9. Waypoint
-
a subtype of
RouteComponent
-
a supertype of
Destination
,Start
-
a
Feature
-
definition: A waypoint of the route.
-
attribute
location
-
definition: The coordinates of the waypoint.
-
multiplicity: 1
-
value:
GM_Point
-
-
attribute
name
-
definition: A name for the waypoint.
-
multiplicity: 0..1
-
value:
CharacterString
-
-
attribute
timestamp
-
multiplicity: 0..1
-
value:
DateTime
-
7. Route Exchange Model
7.1. Overview
This document specifies a single encoding of the Route model described in the previous clause for the creation and transfer of route information between a variety of routing components ("Route Exchange Model"). The encoding uses GeoJSON to represent routes according to the model described above and is defined in the next clause.
A GeoJSON feature collection is used to represent the Route. Each RouteComponent is represented by a GeoJSON feature in the feature collection of the route.
GeoJSON is used for the following reasons:
-
lightweight
-
extensible
-
widely supported in libraries and tools
-
consistent with the emerging OGC API standards
7.2. Requirements class "Route Exchange Model"
This requirement class states requirements that apply to all representations of a route.
See Sample route for an example of a route.
The normative statements use JSON Schema to specify schema components.
Requirements Class |
|
Target type |
JSON object |
Dependency |
|
Dependency |
Requirement 1 |
/req/rem/geojson |
A |
The representation of a route SHALL be a valid GeoJSON feature collection. |
Recommendation 1 |
/rec/rem/fc-name |
A |
The feature collection SHOULD have a member with the name "name" that is a title of the route with the following schema:
|
Typically the name will be provided by the requester of the route.
Requirement 2 |
/req/rem/features |
A |
The feature collection SHALL contain the following features, identified by their property
|
B |
The sequence of the segments SHALL be in their order along the route. |
Recommendation 2 |
/rec/rem/links |
A |
The feature collection SHOULD have a member with the name "links" with the following schema (consistent with RFC 8288):
|
B |
If the route is available via a HTTP(S) URI, there SHOULD be a link with
|
C |
If the route definition is available via a HTTP(S) URI, there SHOULD be a link with
|
D |
There SHOULD be a link with
|
Requirement 3 |
/req/rem/start |
A |
The start location of the route (property |
B |
The point geometry of the feature SHALL be identical to the first point of the route overview. |
C |
If the feature has a property |
Requirement 4 |
/req/rem/end |
A |
The start location of the route (property |
B |
The point geometry of the feature SHALL be identical to the last point of the route overview. |
C |
If the feature has a property |
Requirement 5 |
/req/rem/overview |
A |
The route overview (property |
B |
The line string geometry of the oute overview SHALL be the path from the start point to the end point of the route. |
C |
The route overview SHALL have a property |
D |
The value of a property |
E |
If the route overview has a property |
F |
The route overview SHALL have a property |
G |
The value of a property |
H |
If the route overview has a property |
I |
The route overview SHALL have a property |
J |
The value of a property |
K |
If the route overview has a property |
L |
The route overview SHALL have a property |
M |
The value of a property |
N |
If the route overview has a property |
O |
If the route overview has a property |
P |
If the route overview has a property |
Recommendation 3 |
/rec/rem/overview-properties |
A |
The route overview SHOULD have the property |
B |
The route overview SHOULD have the property |
C |
If the process that creates the route has access to the information, the route overview SHOULD have the properties |
Requirement 6 |
/req/rem/segments |
A |
Each segment of the route (property |
B |
The point geometry of each segment SHALL be on the line string geometry of the route overview. The geometry represents the last position of the segment. |
C |
Each segment SHALL have a property |
D |
If a segment has a property |
E |
Either all segments or no segment SHALL have a property |
F |
If a segment has a property |
G |
If a segment has a property |
H |
If a segment has a property |
I |
If a segment has a property |
J |
If a segment has a property |
K |
If a segment has a property |
Recommendation 4 |
/rec/rem/segment-properties |
A |
Segments SHOULD have the property |
8. Media Types
The Media Type applicable to this specification is application/geo+json
. This specification does not register a new media type. This provides interoperability with consumers that know GeoJSON and its media type.
Annex A: Abstract Test Suite (Normative)
This test suite uses the Given-When-Then notation to specify the tests.
A.1. Conformance Class "Route Exchange Model"
Conformance Class |
|
Target type |
JSON |
Requirements class |
Input to all tests is a REM JSON document.
A.1.1. Conformance Test 1
Test id: |
/conf/rem/validate-geojson |
---|---|
Requirements: |
|
Test purpose: |
Validate the route against the GeoJSON schema |
Test method: |
Given:
When:
Then:
|
Note
|
If the JSON Schema validator used in the test does not support JSON Schema version 07, the GeoJSON schema document needs to be adapted to a version supported by the validator. |
A.1.2. Conformance Test 2
Test id: |
/conf/rem/validate-coordinates |
---|---|
Requirements: |
|
Test purpose: |
Validate the spatial positions in the route |
Test method: |
Given:
When:
Then:
|
A.1.3. Conformance Test 3
Test id: |
/conf/rem/validate-bbox |
---|---|
Requirements: |
|
Test purpose: |
Validate the bounding box of the route, if provided |
Test method: |
Given:
When:
Then:
|
A.1.4. Conformance Test 4
Test id: |
/conf/rem/validate-rem |
---|---|
Requirements: |
/req/rem/features A, /req/rem/start A, /req/rem/end A, /req/rem/overview A/C/E/H/K/N/P, /req/rem/segments A/C/D/F/G/H/I/J/K |
Test purpose: |
Validate the route against the REM schema |
Test method: |
Use a JSON Schema validator and verify that the REM instance is valid against the JSON schema of the Route Exchange Model in GeoJSON. |
Test method: |
Given:
When:
Then:
|
Note
|
If the JSON Schema validator used in the test does not support JSON Schema version 2019-09, the REM schema document needs to be adapted to a version supported by the validator. |
A.1.5. Conformance Test 5
Test id: |
/conf/rem/features |
---|---|
Requirements: |
|
Test purpose: |
Verify the existence of the route components |
Test method: |
Given:
When:
Then:
|
A.1.6. Conformance Test 6
Test id: |
/conf/rem/segment-order |
---|---|
Requirements: |
|
Test purpose: |
Verify the order of the route segments |
Test method: |
Given:
When:
Then:
|
A.1.7. Conformance Test 7
Test id: |
/conf/rem/start-position |
---|---|
Requirements: |
|
Test purpose: |
Verify the start position |
Test method: |
Given:
When:
Then:
|
A.1.8. Conformance Test 8
Test id: |
/conf/rem/end-position |
---|---|
Requirements: |
|
Test purpose: |
Verify the end position |
Test method: |
Given:
When:
Then:
|
A.1.9. Conformance Test 9
Test id: |
/conf/rem/start-end-timestamp |
---|---|
Requirements: |
|
Test purpose: |
Verify the start and end timestamps |
Test method: |
Given:
When:
Then:
|
A.1.10. Conformance Test 10
Test id: |
/conf/rem/overview-length |
---|---|
Requirements: |
|
Test purpose: |
Verify the route length |
Test method: |
Given:
When:
Then:
|
A.1.11. Conformance Test 11
Test id: |
/conf/rem/overview-length-computed |
---|---|
Requirements: |
|
Test purpose: |
Verify the route length against the route path |
Test method: |
Given:
When:
Then:
|
A.1.12. Conformance Test 12
Test id: |
/conf/rem/overview-duration |
---|---|
Requirements: |
|
Test purpose: |
Verify the route duration |
Test method: |
Given:
When:
Then:
|
A.1.13. Conformance Test 13
Test id: |
/conf/rem/overview-height |
---|---|
Requirements: |
|
Test purpose: |
Verify the route height restriction |
Test method: |
Given:
When:
Then:
|
A.1.14. Conformance Test 14
Test id: |
/conf/rem/overview-weight |
---|---|
Requirements: |
|
Test purpose: |
Verify the route weight restriction |
Test method: |
Given:
When:
Then:
|
A.1.15. Conformance Test 15
Test id: |
/conf/rem/processingTime |
---|---|
Requirements: |
|
Test purpose: |
Verify the processing time |
Test method: |
Given:
When:
Then:
|
A.1.16. Conformance Test 16
Test id: |
/conf/rem/speedLimitUnit |
---|---|
Requirements: |
|
Test purpose: |
Verify that a unit is provided for each speed limit |
Test method: |
Given:
When:
Then:
|
Annex B: JSON Schema (Normative)
This annex contains the JSON Schema of the Route Exchange Model in GeoJSON.
{
"$schema": "https://json-schema.org/draft/2019-09/schema",
"$id": "http://schemas.opengis.net/rem/1.0/route.json",
"title": "A route",
"type": "object",
"required": ["type", "features"],
"properties": {
"type": {
"type": "string",
"enum": ["FeatureCollection"]
},
"name": {
"type": "string"
},
"features": {
"type": "array",
"items": {
"oneOf": [
{ "$ref": "#/$defs/Overview" },
{ "$ref": "#/$defs/Waypoint" },
{ "$ref": "#/$defs/Segment" }
]
}
},
"bbox": {
"type": "array",
"minItems": 4,
"items": {
"type": "number"
}
},
"links": {
"type": "array",
"items": {
"$ref": "#/$defs/Link"
}
}
},
"$defs": {
"Overview": {
"title": "A route overview",
"type": "object",
"required": ["type", "geometry", "properties"],
"properties": {
"type": {
"type": "string",
"enum": ["Feature"]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"geometry": {
"title": "The geometry of the route",
"type": "object",
"required": ["type", "coordinates"],
"properties": {
"type": {
"type": "string",
"enum": ["LineString"]
},
"coordinates": {
"type": "array",
"minItems": 2,
"items": {
"type": "array",
"minItems": 2,
"maxItems": 3,
"items": {
"type": "number"
}
}
}
}
},
"properties": {
"type": "object",
"required": ["featureType", "length_m"],
"properties": {
"featureType": {
"type": "string",
"enum": ["overview"]
},
"name": {
"type": "string"
},
"length_m": {
"type": "number"
},
"duration_s": {
"type": "number"
},
"maxHeight_m": {
"type": "number"
},
"maxWeight_t": {
"type": "number"
},
"obstacles": {
"type": "string"
},
"processingTime": {
"type": "string",
"format": "date-time"
},
"comment": {
"type": "string"
}
}
}
}
},
"Waypoint": {
"title": "A waypoint of a route",
"type": "object",
"required": ["type", "geometry", "properties"],
"properties": {
"type": {
"type": "string",
"enum": ["Feature"]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"geometry": {
"title": "A start/end point of a route",
"type": "object",
"required": ["type", "coordinates"],
"properties": {
"type": {
"type": "string",
"enum": ["Point"]
},
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 3,
"items": {
"type": "number"
}
}
}
},
"properties": {
"type": "object",
"required": ["featureType"],
"properties": {
"featureType": {
"type": "string",
"enum": ["start", "end"]
}
}
}
}
},
"Segment": {
"title": "A segment of a route",
"type": "object",
"required": ["type", "geometry", "properties"],
"properties": {
"type": {
"type": "string",
"enum": ["Feature"]
},
"id": {
"oneOf": [
{
"type": "number"
},
{
"type": "string"
}
]
},
"geometry": {
"title": "The end point of the route segment",
"type": "object",
"required": ["type", "coordinates"],
"properties": {
"type": {
"type": "string",
"enum": ["Point"]
},
"coordinates": {
"type": "array",
"minItems": 2,
"maxItems": 3,
"items": {
"type": "number"
}
}
}
},
"properties": {
"type": "object",
"required": ["featureType", "length_m"],
"properties": {
"featureType": {
"type": "string",
"enum": ["segment"]
},
"length_m": {
"type": "number"
},
"duration_s": {
"type": "number"
},
"maxHeight_m": {
"type": "number"
},
"maxWeight_t": {
"type": "number"
},
"speedLimit": {
"type": "number"
},
"speedLimitUnit": {
"type": "string",
"enum": ["kmph", "mph"]
},
"roadName": {
"type": "string"
},
"instructions": {
"type": "string",
"enum": ["continue", "left", "right"]
}
}
}
}
},
"Link": {
"type": "object",
"required": ["href", "rel"],
"properties": {
"href": {
"type": "string",
"format": "uri-reference"
},
"rel": {
"type": "string"
},
"anchor": {
"type": "string"
},
"type": {
"type": "string"
},
"hreflang": {
"type": "string"
},
"title": {
"type": "string"
},
"length": {
"type": "string"
}
}
}
}
}
Annex C: Example (Informative)
{
"type": "FeatureCollection",
"id": "https://api.example.com/v1/routes/4711",
"name": "National Cathedral to Washington Monument",
"features": [
{
"id": 1,
"type": "Feature",
"properties": {
"featureType": "overview",
"length_m": 8290,
"duration_s": 1053
},
"geometry": {
"type": "LineString",
"coordinates": [
[-77.0721011, 38.9308998],
[-77.0721066, 38.9309335],
[-77.072171, 38.9309657],
[-77.0724392, 38.9309442],
[-77.0726538, 38.9308369],
[-77.0728254, 38.9308584],
[-77.0729434, 38.9300859],
[-77.0729756, 38.929764],
[-77.0731151, 38.9290237],
[-77.0731902, 38.9280903],
[-77.0731902, 38.9275324],
[-77.0716774, 38.9275324],
[-77.0685983, 38.9252687],
[-77.0677829, 38.9246893],
[-77.0675147, 38.9245391],
[-77.066946, 38.9243674],
[-77.0667315, 38.9243352],
[-77.0663667, 38.9243245],
[-77.0655835, 38.9241421],
[-77.0652187, 38.9240134],
[-77.0649827, 38.9239061],
[-77.0646071, 38.9236701],
[-77.064178, 38.9233375],
[-77.0638454, 38.9230049],
[-77.0637274, 38.9228547],
[-77.0635772, 38.9225972],
[-77.0634162, 38.9222646],
[-77.0632231, 38.9216208],
[-77.0631373, 38.9214063],
[-77.0630729, 38.9213097],
[-77.0629442, 38.9211702],
[-77.062633, 38.9209127],
[-77.0617425, 38.9202476],
[-77.0608735, 38.9196146],
[-77.0606267, 38.9194536],
[-77.0594788, 38.9185953],
[-77.0589745, 38.9182627],
[-77.0582235, 38.9177048],
[-77.0580733, 38.9175761],
[-77.057333, 38.9170396],
[-77.0576763, 38.9166534],
[-77.0577836, 38.9164817],
[-77.0578158, 38.9162135],
[-77.0577836, 38.9160526],
[-77.0577192, 38.9159131],
[-77.0576227, 38.9158165],
[-77.0572042, 38.9154947],
[-77.0563245, 38.9148617],
[-77.0559275, 38.9146042],
[-77.0556164, 38.9143467],
[-77.055155, 38.9141214],
[-77.055037, 38.9140248],
[-77.0549941, 38.9138961],
[-77.0550048, 38.9136386],
[-77.055037, 38.9134669],
[-77.0550156, 38.9133811],
[-77.0549726, 38.913306],
[-77.0548868, 38.9132416],
[-77.0545113, 38.9130485],
[-77.0538998, 38.9126837],
[-77.0533419, 38.9124799],
[-77.0522904, 38.91204],
[-77.0518398, 38.9116859],
[-77.051636, 38.9115036],
[-77.0514321, 38.911289],
[-77.0510566, 38.9108491],
[-77.050885, 38.9106774],
[-77.0507777, 38.9106023],
[-77.0505524, 38.910377],
[-77.0504451, 38.9102054],
[-77.0503914, 38.9099801],
[-77.0503807, 38.9098299],
[-77.0504129, 38.9096367],
[-77.0504665, 38.9095294],
[-77.0505846, 38.90939],
[-77.0507133, 38.909272],
[-77.0508206, 38.9091861],
[-77.0509601, 38.9091218],
[-77.0511854, 38.9090359],
[-77.0513785, 38.9090145],
[-77.0515716, 38.9090037],
[-77.0525372, 38.9090359],
[-77.0527518, 38.9090252],
[-77.0530951, 38.9089501],
[-77.0534492, 38.9088106],
[-77.053889, 38.9085102],
[-77.0542002, 38.9081776],
[-77.0545113, 38.9077592],
[-77.0552087, 38.9062035],
[-77.0554876, 38.9056563],
[-77.0557237, 38.9052486],
[-77.0561743, 38.9046478],
[-77.056421, 38.9042401],
[-77.0565283, 38.9040148],
[-77.056582, 38.9038646],
[-77.0567, 38.9031136],
[-77.0568824, 38.902663],
[-77.0569575, 38.9023948],
[-77.0571184, 38.9019978],
[-77.0571828, 38.9017725],
[-77.0572257, 38.9014292],
[-77.057215, 38.9011288],
[-77.0571721, 38.9009464],
[-77.0570219, 38.9005709],
[-77.0567107, 38.8996053],
[-77.0564425, 38.8988543],
[-77.0563781, 38.898586],
[-77.0563459, 38.8983715],
[-77.0563459, 38.8981247],
[-77.0564103, 38.8976634],
[-77.0564532, 38.8971269],
[-77.0564747, 38.8951528],
[-77.056464, 38.8949382],
[-77.0564318, 38.8947129],
[-77.0563567, 38.8944447],
[-77.0562708, 38.8942623],
[-77.0558417, 38.8935435],
[-77.0555627, 38.8931251],
[-77.0554554, 38.8929105],
[-77.055198, 38.8925242],
[-77.0551014, 38.8923419],
[-77.0549834, 38.8922453],
[-77.0548654, 38.8922024],
[-77.0547581, 38.8921702],
[-77.0542109, 38.8920736],
[-77.0540285, 38.8920093],
[-77.0533526, 38.8916016],
[-77.0530736, 38.8914621],
[-77.052387, 38.8912153],
[-77.0522261, 38.8911188],
[-77.0521402, 38.8910329],
[-77.0520759, 38.8909471],
[-77.0520544, 38.890754],
[-77.0520651, 38.8906467],
[-77.0523334, 38.8901317],
[-77.0525694, 38.8895845],
[-77.052623, 38.8891768],
[-77.0525908, 38.8889086],
[-77.0525479, 38.8887584],
[-77.0524728, 38.8885975],
[-77.0522475, 38.8882434],
[-77.0521188, 38.8880825],
[-77.0519578, 38.8879108],
[-77.0516467, 38.8876212],
[-77.0513678, 38.8873851],
[-77.0508742, 38.8872027],
[-77.0505953, 38.8871276],
[-77.0501983, 38.887074],
[-77.0499408, 38.8870096],
[-77.0491147, 38.886956],
[-77.0480955, 38.8869345],
[-77.0449626, 38.8868058],
[-77.0429778, 38.8867736],
[-77.0423341, 38.8868272],
[-77.0417118, 38.8869131],
[-77.0381391, 38.8869452],
[-77.0367014, 38.8869452],
[-77.0362508, 38.886956],
[-77.0358753, 38.8869989],
[-77.0352101, 38.8870847],
[-77.0348454, 38.8871706],
[-77.0346093, 38.8872564],
[-77.0342767, 38.8874495],
[-77.0338154, 38.8876748],
[-77.0336866, 38.8877714],
[-77.0336437, 38.8880289],
[-77.0335472, 38.8881791],
[-77.033118, 38.8886511],
[-77.033, 38.888855],
[-77.0329249, 38.8890588],
[-77.0328605, 38.8895094],
[-77.0329356, 38.8899279],
[-77.0330107, 38.890121]
]
},
"bbox": [-77.0731902, 38.8867736, -77.0328605, 38.9309657]
},
{
"id": 2,
"type": "Feature",
"properties": {
"featureType": "start"
},
"geometry": {
"type": "Point",
"coordinates": [-77.0721, 38.9309]
}
},
{
"id": 3,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 70,
"duration_s": 46,
"instructions": "continue",
"text": "Head north on North Rd. Go for 70 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0721011, 38.9308998]
}
},
{
"id": 4,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 372,
"duration_s": 75,
"roadName": "North Rd",
"instructions": "left",
"text": "Turn left onto Wisconsin Ave NW. Go for 372 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0728254, 38.9308584]
}
},
{
"id": 5,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 131,
"duration_s": 28,
"roadName": "Wisconsin Ave NW",
"instructions": "left",
"text": "Turn left onto Garfield St NW. Go for 131 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0731902, 38.9275324]
}
},
{
"id": 6,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 1752,
"duration_s": 215,
"roadName": "Garfield St NW",
"instructions": "right",
"text": "Turn right onto Massachusetts Ave NW. Go for 1.8 km."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0716774, 38.9275324]
}
},
{
"id": 7,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 351,
"duration_s": 49,
"roadName": "Massachusetts Ave NW",
"instructions": "right",
"text": "Turn right onto Waterside Dr NW. Go for 351 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.057333, 38.9170396]
}
},
{
"id": 8,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 3021,
"duration_s": 275,
"roadName": "Waterside Dr NW",
"instructions": "continue",
"text": "Take ramp onto Rock Creek and Potomac Pkwy NW. Go for 3.0 km."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0559275, 38.9146042]
}
},
{
"id": 9,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 748,
"duration_s": 90,
"roadName": "Rock Creek and Potomac Pkwy NW",
"text": "Keep left onto Ohio Dr SW. Go for 748 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0551014, 38.8923419]
}
},
{
"id": 10,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 1155,
"duration_s": 107,
"roadName": "Ohio Dr SW",
"text": "Keep left onto Independence Ave SW. Go for 1.2 km."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0513678, 38.8873851]
}
},
{
"id": 11,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 125,
"duration_s": 22,
"roadName": "Independence Ave SW",
"text": "Keep right onto Independence Ave SW. Go for 125 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0381391, 38.8869452]
}
},
{
"id": 12,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 283,
"duration_s": 73,
"roadName": "Independence Ave SW",
"text": "Keep left onto Independence Ave SW. Go for 283 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0367014, 38.8869452]
}
},
{
"id": 13,
"type": "Feature",
"properties": {
"featureType": "segment",
"levelOfDetail": "visualization",
"length_m": 282,
"duration_s": 73,
"roadName": "Independence Ave SW",
"text": "Turn slightly left onto 15th St SW. Go for 282 m."
},
"geometry": {
"type": "Point",
"coordinates": [-77.0336866, 38.8877714]
}
},
{
"id": 14,
"type": "Feature",
"properties": {
"featureType": "end"
},
"geometry": {
"type": "Point",
"coordinates": [-77.0352, 38.8897]
}
}
]
}
Annex D: Revision History
Date | Release | Editor | Primary clauses modified | Description |
---|---|---|---|---|
2021-01-12 |
1.0.0-SNAPSHOT |
C. Portele |
all |
initial version, based on Open Routing Pilot results |
2021-12-23 |
1.0.0-SNAPSHOT |
C. Portele |
all |
updates, based on SWG decisions on open issues; test suite added |
2022-03-24 |
1.0.0-draft.1 |
C. Portele |
front page |
version for public comments |
Annex E: Bibliography
-
Open Geospatial Consortium (OGC). OGC® Routing Pilot ER [online, viewed 2021-12-22]. Available at https://docs.ogc.org/per/19-041r3.html
-
Open Geospatial Consortium (OGC). WPS Routing API ER [online, viewed 2021-12-22]. Available at https://docs.ogc.org/per/19-040.html