OGC API - Routes

This document specifies the behavior of a Web API that allows applications to request routes in a manner independent of the underlying routing data set, routing engine or algorithm.

This standard defines modular API building blocks to:

• compute new routes,
• specify additional, commonly used routing parameters in addition to the start and end point of the route,
• communicate routes synchronously or asynchronously to clients,
• support callbacks,
• delete routes stored on the server,
• request different profiles of the route (complete, overview, by segment).

Routes are represented as a GeoJSON feature collection according to the OGC Route Exchange Model.

In addition, the API supports building blocks that enable clients to interrogate the API and retrieve the API definition, and a list of conformance classes supported by the API.

Overview of OGC API - Routes - Part 1: Core

GET /

Retrieves the landing page. The purpose of the landing page is to provide clients with a starting point for using the API. Any resource exposed through an API can be accessed by following paths or links starting from the landing page.

GET /conformance

Provides a list declaring the modules that are implemented by the API. These modules are referred to as Conformance Classes. The list of Conformance Classes is key to understanding and using an OGC Web API.

POST /routes

Compute a new route.

GET /routes

Fetch routes.

GET /routes/{routeId}

Fetch a route.

DELETE /routes/{routeId}

Delete a route.

GET /routes/{routeId}/definition

Fetch the definition of a route.