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

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.

GEThttps://host/v1/gisBb/mapDisplay/type

Query parameters

Response

200404

Successful retrieval of the data viewer type

Body

application/json

dataViewerType (enum)

desktopmobilewebunknown

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/type', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

desktop

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.

GEThttps://host/v1/gisBb/mapDisplay/details

Response

200404

Successful retrieval of GIS map display details

Body

application/json

titlestring

Example: "Map Display Title"

descriptionstring

Example: "A summary description of the map display purpose and contents."

attributionstring

Example: "GIS Data Viewer Attribution"

accessControlboolean

Example: true

endPointstring

Example: "/r1/eGovStack/COM/11222456/SchedulerBB/creg/event/new"

crsstring

Example: "EPSG:4326"

centerXnumber (double)

Example: 12.3456

centerYnumber (double)

Example: 34.5678

boundsMinXnumber (double)

Example: 12.3456

boundsMinYnumber (double)

Example: 34.5678

boundsMaxXnumber (double)

Example: 12.789

boundsMaxYnumber (double)

Example: 34.9012

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/details', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "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
}

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.

POSThttps://host/v1/gisBb/mapDisplay/bookmarks

Body

application/json

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

Response

200400

Successful bookmark creation or update

Body

application/json

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

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/bookmarks', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

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

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.

PUThttps://host/v1/gisBb/mapDisplay/scale

Query parameters

Response

204400

Successful setting of layer scale limits

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/scale?layerTitle=text', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

Enable basic navigation capabilities on the GIS data viewer

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.

PUThttps://host/v1/gisBb/mapDisplay/navigation

Query parameters

Response

204400

Successful enabling of basic navigation capabilities

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/navigation?zoom=false&pan=false', {
    method: 'PUT',
    headers: {},
});
const data = await response.json();

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.

POSThttps://host/v1/gisBb/mapDisplay/notes

Body

application/json

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

Response

200400

Successful note creation or update

Body

application/json

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

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/notes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "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
}

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.

POSThttps://host/v1/gisBb/mapDisplay/measuring

Body

application/json

distanceboolean

Example: true

areaboolean

Example: true

Response

204400

Successful measuring action

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/measuring', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

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.

GEThttps://host/v1/gisBb/mapDisplay/style

Response

200

Successful retrieval of data viewer style

Body

application/json

namestring

Example: "DefaultStyle"

descriptionstring

Example: "Default style for GIS layers"

typestring

Example: "CodedStyle"

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBb/mapDisplay/style', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

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

8.2 GIS Query

Retrieve GIS layer metadata

Retrieve GIS layer metadata and feature type definitions.

GEThttps://host/v1/gisBB/query/layerMetadata

Response

200400401

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/layerMetadata', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve non-spatial table metadata

Retrieve non-spatial table metadata.

GEThttps://host/v1/gisBB/query/nonSpatialTableMetadata

Response

200400401

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/nonSpatialTableMetadata', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Execute a GIS Query

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

POSThttps://host/v1/gisBB/query/gisQuery

Body

application/json

typestring

queryFormatstring

queryStringstring

timeStampstring (date-time)

Response

200400401500

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/gisQuery', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Execute a Locational Query

Execute a spatial query based on location.

POSThttps://host/v1/gisBB/query/locationalQuery

Body

application/json

layerTypestring

spatialRelationstring

longitudenumber

latitudenumber

distancenumber

Response

200400401500

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/locationalQuery', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Execute an Attribute Query

Execute an attribute-based query.

POSThttps://host/v1/gisBB/query/attributeQuery

Body

application/json

attributeNamestring

operatorstring

valuestring

Response

200400401500

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/attributeQuery', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Execute a Discovery Query

Execute a metadata discovery query.

POSThttps://host/v1/gisBB/query/discoveryQuery

Body

application/json

attributeNamestring

Response

200400401500

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/discoveryQuery', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Retrieve Query Results

Retrieve the results of a previously executed query.

GEThttps://host/v1/gisBB/query/queryResult

Response

200400401500

Successful response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/query/queryResult', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

8.3 GIS Data Management

Create a GIS Data Store

Create a new GIS data store.

POSThttps://host/v1/gisBB/dataManagement/dataStore

Body

application/json

namestring

descriptionstring

providerstring

connectionStringstring

accessRestrictionsboolean

updateFrequencystring

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/dataStore', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Retrieve Data Store by ID

Retrieve details of a specific GIS data store.

GEThttps://host/v1/gisBB/dataManagement/dataStore/{dataStoreId}

Path parameters

dataStoreId*string

ID of the GIS data store to retrieve

Response

200400404

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/dataStore/{dataStoreId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Update Data Store by ID

Update details of a specific GIS data store.

PATCHhttps://host/v1/gisBB/dataManagement/dataStore/{dataStoreId}

Path parameters

dataStoreId*string

ID of the GIS data store to update

Body

application/json

namestring

descriptionstring

providerstring

connectionStringstring

accessRestrictionsboolean

updateFrequencystring

Response

200400404

Updated

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/dataStore/{dataStoreId}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Publish Data Store Metadata

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

POSThttps://host/v1/gisBB/dataManagement/dataStoreMetadata

Body

application/json

namestring

sourcestring

descriptionstring

keywordsstring

lastUpdatedstring (date-time)

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/dataStoreMetadata', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Create User Control

Create user control for authentication and access permissions.

POSThttps://host/v1/gisBB/dataManagement/userControl

Body

application/json

usernamestring

passwordstring

editorPermissionsstring

editorTrackingboolean

ownerControlboolean

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/userControl', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Record Editor Tracking

Record editor tracking information for feature editing.

POSThttps://host/v1/gisBB/dataManagement/editorTracking

Body

application/json

editTypestring

timeStampstring (date-time)

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/editorTracking', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Replicate GIS Data Store

Replicate a remote GIS database schema.

POSThttps://host/v1/gisBB/dataManagement/replicate

Body

application/json

sourceDataStorestring

targetDataStorestring

replicaTypestring

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/replicate', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Extract and Transfer GIS Data

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

POSThttps://host/v1/gisBB/dataManagement/extractTransfer

Body

application/json

sourceDataStorestring

targetDataStorestring

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/extractTransfer', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Edit Geographic Features

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

POSThttps://host/v1/gisBB/dataManagement/editFeature

Body

application/json

layerTypestring

featureIDstring

operationstring

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/dataManagement/editFeature', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

8.4 Geocoding and Reverse Geocoding

Geocode an Address

Geocode an address to obtain geographic coordinates.

POSThttps://host/v1/gisBB/geocodingReverseGeocoding/geocode

Body

application/json

addressstring

longitudenumber (double)

latitudenumber (double)

Response

200400

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geocodingReverseGeocoding/geocode', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Reverse Geocode Coordinates

Reverse geocode geographic coordinates to obtain an address.

POSThttps://host/v1/gisBB/geocodingReverseGeocoding/reverseGeocode

Body

application/json

longitudenumber (double)

latitudenumber (double)

Response

200400

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geocodingReverseGeocoding/reverseGeocode', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Batch Geocode

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

POSThttps://host/v1/gisBB/geocodingReverseGeocoding/batchGeocode

Body

application/json

batchTypestring

batchNamestring

statusstring

timeStampstring (date-time)

Response

201400

Created

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geocodingReverseGeocoding/batchGeocode', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Retrieve Geocode Result by ID

Retrieve the geocoding result for a specific ID.

GEThttps://host/v1/gisBB/geocodingReverseGeocoding/geocodeResult/{resultId}

Path parameters

resultId*string

ID of the geocoding result to retrieve

Response

200404

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geocodingReverseGeocoding/geocodeResult/{resultId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Retrieve Reverse Geocode Result by ID

Retrieve the reverse geocoding result for a specific ID.

GEThttps://host/v1/gisBB/geocodingReverseGeocoding/reverseGeocodeResult/{resultId}

Path parameters

resultId*string

ID of the reverse geocoding result to retrieve

Response

200404

Successful response

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geocodingReverseGeocoding/reverseGeocodeResult/{resultId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

8.5 Spatial Awareness and Analysis

Get Metadata

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

GEThttps://host/v1/gisBB/spatialAwarenessAnalysis/metadata

Response

200400

Successful response with metadata

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/spatialAwarenessAnalysis/metadata', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Available Processes

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

GEThttps://host/v1/gisBB/spatialAwarenessAnalysis/processes

Response

200400

Successful response with available processes

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/spatialAwarenessAnalysis/processes', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Execute Geoprocessing Task

Execute a geoprocessing task to perform basic spatial analysis operations.

POSThttps://host/v1/gisBB/spatialAwarenessAnalysis/executeTask

Body

application/json

processingNamestring

descriptionstring

parametersarray of object

Response

200400

Successful response with geoprocessing result

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/spatialAwarenessAnalysis/executeTask', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get Task Status

Get the status of an asynchronously executed geoprocessing task.

GEThttps://host/v1/gisBB/spatialAwarenessAnalysis/taskStatus/{taskId}

Path parameters

taskId*string

ID of the geoprocessing task

Response

200404

Successful response with task status

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/spatialAwarenessAnalysis/taskStatus/{taskId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Get Task Result

Get the result of a finished geoprocessing task.

GEThttps://host/v1/gisBB/spatialAwarenessAnalysis/taskResult/{taskId}

Path parameters

taskId*string

ID of the geoprocessing task

Response

200404

Successful response with task result

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/spatialAwarenessAnalysis/taskResult/{taskId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Terminate Task

Terminate an asynchronously executed geoprocessing task.

POSThttps://host/v1/gisBB/spatialAwarenessAnalysis/terminateTask/{taskId}

Path parameters

taskId*string

ID of the geoprocessing task

Response

200404

Task termination request received

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/spatialAwarenessAnalysis/terminateTask/{taskId}', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

8.6 Reporting

Get Templates

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

GEThttps://host/v1/gisBB/reporting/templates

Response

200400

Successful response with templates

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/templates', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Add Dynamic GIS Layer

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

POSThttps://host/v1/gisBB/reporting/dynamicLayers

Body

application/json

titlestring

abstractstring

authorstring

keywordsstring

lastUpdatedstring (date-time)

Response

200400

Successful response after adding dynamic GIS layer

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/dynamicLayers', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove Dynamic GIS Layer

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

DELETEhttps://host/v1/gisBB/reporting/dynamicLayers/{layerId}

Path parameters

layerId*string

ID of the dynamic GIS layer to be removed

Response

200404

Successful response after removing dynamic GIS layer

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/dynamicLayers/{layerId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add Label

Add a label to a map layout or report.

POSThttps://host/v1/gisBB/reporting/labels

Body

application/json

labelTextstring

positionXnumber (float)

positionYnumber (float)

fontstring

sizeinteger

colorstring

Response

200400

Successful response after adding label

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/labels', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove Label

Remove a label from a map layout or report.

DELETEhttps://host/v1/gisBB/reporting/labels/{labelId}

Path parameters

labelId*string

ID of the label to be removed

Response

200404

Successful response after removing label

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/labels/{labelId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add Chart

Add a chart to a map layout or report.

POSThttps://host/v1/gisBB/reporting/charts

Body

application/json

titlestring

typestring

datastring

Response

200400

Successful response after adding chart

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/charts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove Chart

Remove a chart from a map layout or report.

DELETEhttps://host/v1/gisBB/reporting/charts/{chartId}

Path parameters

chartId*string

ID of the chart to be removed

Response

200404

Successful response after removing chart

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/charts/{chartId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add Legend

Add a legend to a map layout or report.

POSThttps://host/v1/gisBB/reporting/legends

Body

application/json

labelTextstring

positionXnumber (float)

positionYnumber (float)

fontstring

sizeinteger

colorstring

Response

200400

Successful response after adding legend

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/legends', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove Legend

Remove a legend from a map layout or report.

DELETEhttps://host/v1/gisBB/reporting/legends/{legendId}

Path parameters

legendId*string

ID of the legend to be removed

Response

200404

Successful response after removing legend

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/legends/{legendId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add Scale Bar

Add a scale bar to a map layout or report.

POSThttps://host/v1/gisBB/reporting/scaleBars

Body

application/json

titlestring

stylestring

lengthnumber (float)

unitsstring

positionXnumber (float)

positionYnumber (float)

fontstring

sizeinteger

colorstring

Response

200400

Successful response after adding scale bar

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/scaleBars', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove Scale Bar

Remove a scale bar from a map layout or report.

DELETEhttps://host/v1/gisBB/reporting/scaleBars/{scaleBarId}

Path parameters

scaleBarId*string

ID of the scale bar to be removed

Response

200404

Successful response after removing scale bar

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/scaleBars/{scaleBarId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Add North Arrow

Add a north arrow to a map layout or report.

POSThttps://host/v1/gisBB/reporting/northArrows

Body

application/json

titlestring

stylestring

lengthnumber (float)

unitsstring

positionXnumber (float)

positionYnumber (float)

fontstring

sizeinteger

colorstring

Response

200400

Successful response after adding north arrow

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/northArrows', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove North Arrow

Remove a north arrow from a map layout or report.

DELETEhttps://host/v1/gisBB/reporting/northArrows/{northArrowId}

Path parameters

northArrowId*string

ID of the north arrow to be removed

Response

200404

Successful response after removing north arrow

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/reporting/northArrows/{northArrowId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

8.7 Geofencing

List Geofences

GEThttps://host/v1/gisBB/geofencing/geofences

Response

200

Successful response with a list of geofences

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Create Geofence

POSThttps://host/v1/gisBB/geofencing/geofences

Body

application/json

namestring

shapestring

sizenumber (double)

statusboolean

Response

201

Successful response after creating geofence

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get Geofence by ID

GEThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}

Path parameters

geofenceId*string

Response

200404

Successful response with geofence details

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Update Geofence

PUThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}

Path parameters

geofenceId*string

Body

application/json

namestring

shapestring

sizenumber (double)

statusboolean

Response

204404

Successful response after updating geofence

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Delete Geofence

DELETEhttps://host/v1/gisBB/geofencing/geofences/{geofenceId}

Path parameters

geofenceId*string

Response

204404

Successful response after deleting geofence

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Get Geofence Status

GEThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/status

Path parameters

geofenceId*string

Response

200404

Successful response with geofence status

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/status', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Activate Geofence

POSThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/activate

Path parameters

geofenceId*string

Response

200404

Successful response after activating geofence

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/activate', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Deactivate Geofence

POSThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/deactivate

Path parameters

geofenceId*string

Response

200404

Successful response after deactivating geofence

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/deactivate', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

List Geofence Elements

GEThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements

Path parameters

geofenceId*string

Response

200404

Successful response with a list of geofence elements

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Add Geofence Element

POSThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements

Path parameters

geofenceId*string

Body

application/json

elementTypestring

trackingMethodstring

Response

201404

Successful response after adding geofence element

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Remove Geofence Element

DELETEhttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements/{elementId}

Path parameters

geofenceId*string

elementId*string

Response

204404

Successful response after removing geofence element

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements/{elementId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Create Action Rule for Geofence

POSThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/rules

Path parameters

geofenceId*string

Body

application/json

actionTypestring

actionstring

Response

201404

Successful response after creating action rule

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/rules', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Create Element Action Rule for Geofence

POSThttps://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements/{elementId}/actions

Path parameters

geofenceId*string

elementId*string

Body

application/json

notificationTypestring

recipientstring

recipientTypestring

Response

201404

Successful response after creating element action rule

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/geofencing/geofences/{geofenceId}/elements/{elementId}/actions', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

8.8 Routing

Create Route

POSThttps://host/v1/gisBB/routing/routes

Body

application/json

startNodeobject

endNodeobject

passThroughboolean

restrictionsstring

additionalParametersstring

Response

201

Successful response after creating a route

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/routing/routes', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Get Route by ID

GEThttps://host/v1/gisBB/routing/routes/{routeId}

Path parameters

routeId*string

Response

200404

Successful response with route details

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/routing/routes/{routeId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Delete Route

DELETEhttps://host/v1/gisBB/routing/routes/{routeId}

Path parameters

routeId*string

Response

204404

Successful response after deleting route

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/routing/routes/{routeId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Generate Direction Report for Route

GEThttps://host/v1/gisBB/routing/routes/{routeId}/directions

Path parameters

routeId*string

Response

200404

Successful response with direction report

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/routing/routes/{routeId}/directions', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List Route Segments

GEThttps://host/v1/gisBB/routing/routes/{routeId}/segments

Path parameters

routeId*string

Response

200404

Successful response with a list of route segments

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/routing/routes/{routeId}/segments', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

List Service Areas

GEThttps://host/v1/gisBB/routing/service-areas

Response

200

Successful response with a list of service areas

Request

JavaScriptCurlPython

const response = await fetch('https://host/v1/gisBB/routing/service-areas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();