1 of 1

8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

This section provides a reference for the APIs implemented by the GIS Building Block. The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. Additional APIs may be implemented by the Building Block, but the listed APIs define a minimal set of functionality that should be provided by any implementation of this Building Block.

The GIS BB APIs conform with the OGC web API principles and guidelines and should be deployed as a set of microservices to provide clients consistent access to the key digital functionalities and geographic data in different representations. Microservices are defined to receive requests with relevant inputs and return processed results from key digital functionalities of this Building Block. Microservices are small, independent, and loosely coupled services that perform specific functions within the larger GIS BB key digital functionalities. Each microservice is kept simple and intuitive by focusing on one particular task, and together they form a cohesive and scalable GIS architecture. Each microservice can be developed, deployed, and maintained independently, making it easier to manage and scale the system as needed.

This section provides a reference for APIs that this Building Block should implement. The APIs defined here establish a blueprint for how the Building Block will interact with other Building Blocks. The Building Block may implement additional APIs, but the listed APIs define a minimal set of functionality that any implementation of this Building Block should provide.

The GovStack non-functional requirements document provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here.

8.1 Map Display

8.2 GIS Query

8.3 GIS Data Management

8.4 Geocoding and Reverse Geocoding

8.5 Spatial Awareness and Analysis

8.6 Reporting

8.7 Geofencing

8.8 Routing

8 Service APIs

This section provides a reference for APIs that should be implemented by this Building Block.

The GovStack non-functional requirements document provides additional information on how 'adaptors' may be used to translate an existing API to the patterns described here.

8.1 Map Display

8.2 GIS Query

8.3 GIS Data Management

8.4 Geocoding and Reverse Geocoding

8.5 Spatial Awareness and Analysis

8.6 Reporting

8.7 Geofencing

8.8 Routing

Get Templates

Retrieve templates and resources for creating map layouts and cartographic reports.

get

/templates

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/reporting/templates'

200

400

No body

Successful response with templates

Add Dynamic GIS Layer

Add a dynamic GIS layer to a map layout or report.

post

/dynamicLayers

Body

titlestring

abstractstring

authorstring

keywordsstring

lastUpdatedstring date-time

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/reporting/dynamicLayers' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response after adding dynamic GIS layer

Remove Dynamic GIS Layer

Remove a dynamic GIS layer from a map layout or report.

delete

/dynamicLayers/{layerId}

Path parameters

layerIdstringrequired

ID of the dynamic GIS layer to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/reporting/dynamicLayers/{layerId}'

200

404

No body

Successful response after removing dynamic GIS layer

Add Label

Add a label to a map layout or report.

post

/labels

Body

labelTextstring

positionXnumber float

positionYnumber float

fontstring

sizeinteger

colorstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/reporting/labels' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response after adding label

Remove Label

Remove a label from a map layout or report.

delete

/labels/{labelId}

Path parameters

labelIdstringrequired

ID of the label to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/reporting/labels/{labelId}'

200

404

No body

Successful response after removing label

Add Chart

Add a chart to a map layout or report.

post

/charts

Body

titlestring

typestring

datastring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/reporting/charts' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response after adding chart

Remove Chart

Remove a chart from a map layout or report.

delete

/charts/{chartId}

Path parameters

chartIdstringrequired

ID of the chart to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/reporting/charts/{chartId}'

200

404

No body

Successful response after removing chart

Add Legend

Add a legend to a map layout or report.

post

/legends

Body

labelTextstring

positionXnumber float

positionYnumber float

fontstring

sizeinteger

colorstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/reporting/legends' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response after adding legend

Remove Legend

Remove a legend from a map layout or report.

delete

/legends/{legendId}

Path parameters

legendIdstringrequired

ID of the legend to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/reporting/legends/{legendId}'

200

404

No body

Successful response after removing legend

Add Scale Bar

Add a scale bar to a map layout or report.

post

/scaleBars

Body

titlestring

stylestring

lengthnumber float

unitsstring

positionXnumber float

positionYnumber float

fontstring

sizeinteger

colorstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/reporting/scaleBars' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response after adding scale bar

Remove Scale Bar

Remove a scale bar from a map layout or report.

delete

/scaleBars/{scaleBarId}

Path parameters

scaleBarIdstringrequired

ID of the scale bar to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/reporting/scaleBars/{scaleBarId}'

200

404

No body

Successful response after removing scale bar

Add North Arrow

Add a north arrow to a map layout or report.

post

/northArrows

Body

titlestring

stylestring

lengthnumber float

unitsstring

positionXnumber float

positionYnumber float

fontstring

sizeinteger

colorstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/reporting/northArrows' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response after adding north arrow

Remove North Arrow

Remove a north arrow from a map layout or report.

delete

/northArrows/{northArrowId}

Path parameters

northArrowIdstringrequired

ID of the north arrow to be removed

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/reporting/northArrows/{northArrowId}'

200

404

No body

Successful response after removing north arrow

List Geofences

get

/geofences

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/geofencing/geofences'

200

No body

Successful response with a list of geofences

Create Geofence

post

/geofences

Body

namestring

shapestring

sizenumber double

statusboolean

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geofencing/geofences' \
  --header 'Content-Type: application/json'

201

No body

Successful response after creating geofence

Get Geofence by ID

get

/geofences/{geofenceId}

Path parameters

geofenceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}'

200

404

No body

Successful response with geofence details

Update Geofence

put

/geofences/{geofenceId}

Path parameters

geofenceIdstringrequired

Body

namestring

shapestring

sizenumber double

statusboolean

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}' \
  --header 'Content-Type: application/json'

204

404

No body

Successful response after updating geofence

Delete Geofence

delete

/geofences/{geofenceId}

Path parameters

geofenceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}'

204

404

No body

Successful response after deleting geofence

Get Geofence Status

get

/geofences/{geofenceId}/status

Path parameters

geofenceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/status'

200

404

No body

Successful response with geofence status

Activate Geofence

post

/geofences/{geofenceId}/activate

Path parameters

geofenceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/activate'

200

404

No body

Successful response after activating geofence

Deactivate Geofence

post

/geofences/{geofenceId}/deactivate

Path parameters

geofenceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/deactivate'

200

404

No body

Successful response after deactivating geofence

List Geofence Elements

get

/geofences/{geofenceId}/elements

Path parameters

geofenceIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements'

200

404

No body

Successful response with a list of geofence elements

Add Geofence Element

post

/geofences/{geofenceId}/elements

Path parameters

geofenceIdstringrequired

Body

elementTypestring

trackingMethodstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements' \
  --header 'Content-Type: application/json'

201

404

No body

Successful response after adding geofence element

Remove Geofence Element

delete

/geofences/{geofenceId}/elements/{elementId}

Path parameters

geofenceIdstringrequired

elementIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements/{elementId}'

204

404

No body

Successful response after removing geofence element

Create Action Rule for Geofence

post

/geofences/{geofenceId}/rules

Path parameters

geofenceIdstringrequired

Body

actionTypestring

actionstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/rules' \
  --header 'Content-Type: application/json'

201

404

No body

Successful response after creating action rule

Create Element Action Rule for Geofence

post

/geofences/{geofenceId}/elements/{elementId}/actions

Path parameters

geofenceIdstringrequired

elementIdstringrequired

Body

notificationTypestring

recipientstring

recipientTypestring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements/{elementId}/actions' \
  --header 'Content-Type: application/json'

201

404

No body

Successful response after creating element action rule

Get Metadata

Retrieve metadata that describes the purpose and functionality of geospatial analysis tasks or processes.

get

/metadata

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/spatialAwarenessAnalysis/metadata'

200

400

No body

Successful response with metadata

Get Available Processes

Retrieve detailed information that describes the processes that can be run on the service.

get

/processes

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/spatialAwarenessAnalysis/processes'

200

400

No body

Successful response with available processes

Execute Geoprocessing Task

Execute a geoprocessing task to perform basic spatial analysis operations.

post

/executeTask

Body

processingNamestring

descriptionstring

parametersobject[]

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/spatialAwarenessAnalysis/executeTask' \
  --header 'Content-Type: application/json' \
  --data '{"parameters":[{}]}'

200

400

No body

Successful response with geoprocessing result

Get Task Status

Get the status of an asynchronously executed geoprocessing task.

get

/taskStatus/{taskId}

Path parameters

taskIdstringrequired

ID of the geoprocessing task

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/spatialAwarenessAnalysis/taskStatus/{taskId}'

200

404

No body

Successful response with task status

Get Task Result

Get the result of a finished geoprocessing task.

get

/taskResult/{taskId}

Path parameters

taskIdstringrequired

ID of the geoprocessing task

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/spatialAwarenessAnalysis/taskResult/{taskId}'

200

404

No body

Successful response with task result

Terminate Task

Terminate an asynchronously executed geoprocessing task.

post

/terminateTask/{taskId}

Path parameters

taskIdstringrequired

ID of the geoprocessing task

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/spatialAwarenessAnalysis/terminateTask/{taskId}'

200

404

No body

Task termination request received

Geocode an Address

Geocode an address to obtain geographic coordinates.

post

/geocode

Body

addressstring

longitudenumber double

latitudenumber double

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geocodingReverseGeocoding/geocode' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response

Reverse Geocode Coordinates

Reverse geocode geographic coordinates to obtain an address.

post

/reverseGeocode

Body

longitudenumber double

latitudenumber double

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geocodingReverseGeocoding/reverseGeocode' \
  --header 'Content-Type: application/json'

200

400

No body

Successful response

Batch Geocode

Perform batch geocoding or reverse geocoding using a table file with multiple addresses or coordinates.

post

/batchGeocode

Body

batchTypestring

batchNamestring

statusstring

timeStampstring date-time

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/geocodingReverseGeocoding/batchGeocode' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Retrieve Geocode Result by ID

Retrieve the geocoding result for a specific ID.

get

/geocodeResult/{resultId}

Path parameters

resultIdstringrequired

ID of the geocoding result to retrieve

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/geocodingReverseGeocoding/geocodeResult/{resultId}'

200

404

No body

Successful response

Retrieve Reverse Geocode Result by ID

Retrieve the reverse geocoding result for a specific ID.

get

/reverseGeocodeResult/{resultId}

Path parameters

resultIdstringrequired

ID of the reverse geocoding result to retrieve

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/geocodingReverseGeocoding/reverseGeocodeResult/{resultId}'

200

404

No body

Successful response

Create a GIS Data Store

Create a new GIS data store.

post

/dataStore

Body

namestring

descriptionstring

providerstring

connectionStringstring

accessRestrictionsboolean

updateFrequencystring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/dataStore' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Retrieve Data Store by ID

Retrieve details of a specific GIS data store.

get

/dataStore/{dataStoreId}

Path parameters

dataStoreIdstringrequired

ID of the GIS data store to retrieve

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/dataManagement/dataStore/{dataStoreId}'

200

400

404

No body

Successful response

Update Data Store by ID

Update details of a specific GIS data store.

patch

/dataStore/{dataStoreId}

Path parameters

dataStoreIdstringrequired

ID of the GIS data store to update

Body

namestring

descriptionstring

providerstring

connectionStringstring

accessRestrictionsboolean

updateFrequencystring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://host/v1/gisBB/dataManagement/dataStore/{dataStoreId}' \
  --header 'Content-Type: application/json'

200

400

404

No body

Updated

Publish Data Store Metadata

Publish metadata descriptions of a GIS database schema and its contents.

post

/dataStoreMetadata

Body

namestring

sourcestring

descriptionstring

keywordsstring

lastUpdatedstring date-time

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/dataStoreMetadata' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Create User Control

Create user control for authentication and access permissions.

post

/userControl

Body

usernamestring

passwordstring

editorPermissionsstring

editorTrackingboolean

ownerControlboolean

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/userControl' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Record Editor Tracking

Record editor tracking information for feature editing.

post

/editorTracking

Body

editTypestring

timeStampstring date-time

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/editorTracking' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Replicate GIS Data Store

Replicate a remote GIS database schema.

post

/replicate

Body

sourceDataStorestring

targetDataStorestring

replicaTypestring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/replicate' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Extract and Transfer GIS Data

Extract and transfer GIS data layers or features from a remote GIS database.

post

/extractTransfer

Body

sourceDataStorestring

targetDataStorestring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/extractTransfer' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Edit Geographic Features

Create, edit, modify, or delete geographic features on the extracted GIS data layers.

post

/editFeature

Body

layerTypestring

featureIDstring

operationstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/dataManagement/editFeature' \
  --header 'Content-Type: application/json'

201

400

No body

Created

Retrieve GIS layer metadata

Retrieve GIS layer metadata and feature type definitions.

get

/layerMetadata

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/query/layerMetadata'

200

400

401

[
  {
    "name": "Sample Layer",
    "abstract": "A sample GIS layer",
    "author": "John Doe",
    "geometry": "point",
    "keywords": "sample, layer",
    "snippet": "This is a sample layer.",
    "lastUpdated": "2023-08-08T12:00:00Z",
    "spatialExtent": [
      [
        0,
        0
      ],
      [
        1,
        1
      ]
    ]
  }
]

Successful response

Retrieve non-spatial table metadata

Retrieve non-spatial table metadata.

get

/nonSpatialTableMetadata

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/query/nonSpatialTableMetadata'

200

400

401

[
  {
    "name": "Sample Table",
    "abstract": "A sample non-spatial table",
    "author": "Jane Smith",
    "keywords": "sample, table",
    "lastUpdated": "2023-08-08T12:00:00Z"
  }
]

Successful response

Execute a GIS Query

Execute GIS feature or attribute query operations interactively or through predefined expressions.

post

/gisQuery

Body

typestring

queryFormatstring

queryStringstring

timeStampstring date-time

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/query/gisQuery' \
  --header 'Content-Type: application/json'

200

400

401

500

[
  {
    "queryType": "Attribute Query",
    "queryStatus": "Success",
    "timeStamp": "2023-08-08T12:00:00Z"
  }
]

Successful response

Execute a Locational Query

Execute a spatial query based on location.

post

/locationalQuery

Body

layerTypestring

spatialRelationstring

longitudenumber

latitudenumber

distancenumber

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/query/locationalQuery' \
  --header 'Content-Type: application/json'

200

400

401

500

[
  {
    "queryType": "Locational Query",
    "queryStatus": "Success",
    "timeStamp": "2023-08-08T12:00:00Z"
  }
]

Successful response

Execute an Attribute Query

Execute an attribute-based query.

post

/attributeQuery

Body

attributeNamestring

operatorstring

valuestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/query/attributeQuery' \
  --header 'Content-Type: application/json'

200

400

401

500

[
  {
    "queryType": "Attribute Query",
    "queryStatus": "Success",
    "timeStamp": "2023-08-08T12:00:00Z"
  }
]

Successful response

Execute a Discovery Query

Execute a metadata discovery query.

post

/discoveryQuery

Body

attributeNamestring

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/query/discoveryQuery' \
  --header 'Content-Type: application/json'

200

400

401

500

[
  {
    "queryType": "Metadata Discovery Query",
    "queryStatus": "Success",
    "timeStamp": "2023-08-08T12:00:00Z"
  }
]

Successful response

Retrieve Query Results

Retrieve the results of a previously executed query.

get

/queryResult

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/query/queryResult'

200

400

401

500

[
  {
    "queryType": "Attribute Query",
    "queryStatus": "Success",
    "timeStamp": "2023-08-08T12:00:00Z"
  }
]

Successful response

Retrieve the data viewer type

Retrieve the type of the data viewer. This endpoint provides information about whether the client data viewer is desktop, mobile, web browser, or unknown.

get

/type

Query parameters

supportedBrowserenum

Specifies the type of supported browser for the data viewer.

Options: desktop, mobile, web, unknown

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBb/mapDisplay/type'

200

404

desktop

Successful retrieval of the data viewer type

Retrieve GIS map display details

Retrieve GIS map display details. This endpoint provides access to GIS data through a data viewer, allowing users to view and query geographic or spatial information presented as graphic representations (points, polygons, lines, or raster grids) through thematic GIS layers or attribute tables. The response will include the symbology (pre-defined styles) for each map layer, displayed as a legend alongside a table of contents listing all layers provided by the service.

get

/details

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBb/mapDisplay/details'

200

404

{
  "title": "Map Display Title",
  "description": "A summary description of the map display purpose and contents.",
  "attribution": "GIS Data Viewer Attribution",
  "accessControl": true,
  "endPoint": "/r1/eGovStack/COM/11222456/SchedulerBB/creg/event/new",
  "crs": "EPSG:4326",
  "centerX": 12.3456,
  "centerY": 34.5678,
  "boundsMinX": 12.3456,
  "boundsMinY": 34.5678,
  "boundsMaxX": 12.789,
  "boundsMaxY": 34.9012
}

Successful retrieval of GIS map display details

Add or update spatial bookmarks

Add or update spatial bookmarks. This endpoint allows users to capture the spatial extent of a given location as a spatial bookmark in a GIS data viewer. Users can name the bookmark and zoom to the exact extent whenever needed by selecting the bookmark's name. Users can also add, rename, and remove spatial bookmarks as necessary.

post

/bookmarks

Body

namestring

Example: Bookmark A

createinteger

Example: 1

removeboolean

Example: true

renameboolean

Example: true

zoomToboolean

Example: true

minXnumber double

Example: 12.3456

minYnumber double

Example: 34.5678

maxXnumber double

Example: 12.789

maxYnumber double

Example: 34.9012

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBb/mapDisplay/bookmarks' \
  --header 'Content-Type: application/json' \
  --data '{"name":"Bookmark A","create":1,"remove":true,"rename":true,"zoomTo":true,"minX":12.3456,"minY":34.5678,"maxX":12.789,"maxY":34.9012}'

200

400

{
  "name": "Bookmark A",
  "create": 1,
  "remove": true,
  "rename": true,
  "zoomTo": true,
  "minX": 12.3456,
  "minY": 34.5678,
  "maxX": 12.789,
  "maxY": 34.9012
}

Successful bookmark creation or update

Set minimum and maximum scale limits for each layer

Set minimum and maximum scale limits for each layer. This endpoint allows users to specify whether a layer is identifiable and/or selectable on the data viewer. These settings are saved as a cache by the data viewer app and are reserved for future data viewer displays. The settings are reset to default when the cache is cleared.

put

/scale

Query parameters

layerTitlestringrequired

The name of the GIS layer

minScaleinteger

The minimum scale to show the layer's feature on the map display

maxScaleinteger

The maximum scale to show the layer's feature on the map display

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://host/v1/gisBb/mapDisplay/scale?layerTitle=text'

204

400

No body

Successful setting of layer scale limits

Enable basic navigation capabilities on the GIS data viewer. This endpoint allows users to perform basic navigation actions such as zooming in and out of a map, and panning to explore the displayed GIS data.

put

/navigation

Query parameters

zoombooleanrequired

Specifies if zooming is supported

zoomLevelintegerrequired

The available zoom levels for the map

panbooleanrequired

Specifies if panning is supported

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url 'https://host/v1/gisBb/mapDisplay/navigation?zoom=true&zoomLevel=1&pan=true'

204

400

No body

Successful enabling of basic navigation capabilities

Add, view, delete, and mark map notes on the GIS data viewer

Add, view, delete, and mark map notes on the GIS data viewer. This endpoint allows GIS users to add and share brief notes on the GIS data viewer. Other users can view and comment on these notes. Notes can only be deleted by the creator of the note. Notes are saved and served as a web feature service.

post

/notes

Body

creatorstring

Example: John Doe

contentstring

Example: This is a map note.

timeStampstring

Example: 2023-08-01T12:34:56Z

addboolean

Example: true

deleteboolean

Example: true

viewboolean

Example: true

visibleboolean

Example: true

xnumber double

Example: 12.3456

ynumber double

Example: 34.5678

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBb/mapDisplay/notes' \
  --header 'Content-Type: application/json' \
  --data '{"creator":"John Doe","content":"This is a map note.","timeStamp":"2023-08-01T12:34:56Z","add":true,"delete":true,"view":true,"visible":true,"x":12.3456,"y":34.5678}'

200

400

{
  "creator": "John Doe",
  "content": "This is a map note.",
  "timeStamp": "2023-08-01T12:34:56Z",
  "add": true,
  "delete": true,
  "view": true,
  "visible": true,
  "x": 12.3456,
  "y": 34.5678
}

Successful note creation or update

Perform measuring actions on the GIS data viewer

Perform measuring actions on the GIS data viewer. This endpoint allows users to measure distances and areas on the displayed map.

post

/measuring

Body

distanceboolean

Example: true

areaboolean

Example: true

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBb/mapDisplay/measuring' \
  --header 'Content-Type: application/json' \
  --data '{"distance":true,"area":true}'

204

400

No body

Successful measuring action

Retrieve the style applied to the data viewer

Retrieve the style applied to the data viewer. This endpoint provides information about the style used to portray the geographic features of each layer on the data viewer.

get

/style

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBb/mapDisplay/style'

200

{
  "name": "DefaultStyle",
  "description": "Default style for GIS layers",
  "type": "CodedStyle"
}

Successful retrieval of data viewer style

Create Route

post

/routes

Body

startNodeobject

endNodeobject

passThroughboolean

restrictionsstring

additionalParametersstring

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://host/v1/gisBB/routing/routes' \
  --header 'Content-Type: application/json' \
  --data '{"startNode":{},"endNode":{}}'

201

No body

Successful response after creating a route

Get Route by ID

get

/routes/{routeId}

Path parameters

routeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/routing/routes/{routeId}'

200

404

No body

Successful response with route details

Delete Route

delete

/routes/{routeId}

Path parameters

routeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://host/v1/gisBB/routing/routes/{routeId}'

204

404

No body

Successful response after deleting route

Generate Direction Report for Route

get

/routes/{routeId}/directions

Path parameters

routeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/routing/routes/{routeId}/directions'

200

404

No body

Successful response with direction report

List Route Segments

get

/routes/{routeId}/segments

Path parameters

routeIdstringrequired

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/routing/routes/{routeId}/segments'

200

404

No body

Successful response with a list of route segments

List Service Areas

get

/service-areas

Responses

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://host/v1/gisBB/routing/service-areas'

200

No body

Successful response with a list of service areas