OGC API

Please see the OGC API offical documentation for further information.

The OGC API can be thought of having 4 levels:

  1. The Collection: This is the API entry point.

    • ../ogcapi/..

  2. Collections: This is a list of all Collections within the Collection. A Collection is synonymous with a ‘Layer’.

    • ../ogcapi/collections/..

    • synonymous with WFS GetCapabilities

  3. Collection Items: These are all the records (features) held in a Collection

    • ../ogcapi/collections/<CollectionName>/..

    • ../ogcapi/collections/TINSurveyEdges/.. for example

    • synonymous with WFS GetFeature

  4. Collection Item: These are individual features held in a Collection. These are accessed by ID

    • ../ogcapi/collections/<CollectionName>/items/<ID>..

    • ../ogcapi/collections/TINSurveyEdges/items/72.. for example

    • synonymous with WFS DescribeFeatureType

Connection URLs

Landing Page/ API Entry Point (The Collection)

An API url constructed like so:

will present the API landing page. If accessed in a web browser, users will see the following:

../../../_images/LandingPage.PNG

The pertinent links are:

  • Information about feature collections available from this server (JSON)

    This is the json endpoint

  • Information about feature collections available from this server

    This is the HTML endpoint and should be used to broswe the PMS data Collection in a web browser.

The Collections List Endpoint

Much like a GetCapabilities request in WFS, the Collections endpoint presents users with a list of available layers.

The HTML URL is constructed like so:

https://galwaycity.maproadpms.ie/ogcapi/collections?f=html&token=YOUR-TOKEN-GOES-HERE

Replace the f=html with f=json to get a JSON response.

../../../_images/Collections.PNG

Individual Collection Endpoints (Collection-items)

From here users can access individual Collections listing the Items in the Collection. This Endpoint is probaly going to be the most useful for most users wanting to display and/or analyse data in PowerBI or ARCGIS PRO.

https://galwaycity.maproadpms.ie/ogcapi/collections/TINSurveyEdges/items?f=html&token=YOUR-TOKEN-GOES-HERE

Again, replace the f=html with f=json to get a JSON response. Replace /TINSurveyEdges/ with the name of another Collection to access that.

At this Endpoint users are presented with a list of Items in the requested Collection.

../../../_images/Items.PNG

Note

The HTML presented in the browser uses paging. If a user wnat to see more items in the list then add a Limit=X parameter to the URL.

…f=html&Limit=1000&token=…
This default limit issued by the HTML paging will not automatically be applied at the JSON endpoint i.e. all items will appear when requested unless the Limit=X parameter is added.

Individual Item Endpoints (Collection-item)

This is the Endpoint for accessing individual Items in a Collection. This is achieved by passing the Item’s ID to the request.

https://pmstipperarydev.compass.ie/ogcapi/collections/RoadSchedule/items/131975?f=html&token=YOUR-TOKEN-GOES-HERE

../../../_images/Item.PNG