Spatial API

The Spatial API is designed to manage hierarchical spatial data within a division. It includes entities such as layers, spaces, rooms, clusters, areas, and layer circulation. The API provides endpoints to create, retrieve, update, and delete these location-related entities, allowing for comprehensive management and organisation of spatial information.

Retrieve a list of locations or a specific location by ID.

get

/locations

Authorizations

Query parameters

location_idstring

Optional ID of the location to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/locations' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "locations": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_locations_successful"
}

OK

Retrieve layers within a location, optionally filtered by layer ID.

get

/layers

Authorizations

Query parameters

location_idstring

ID of the location to retrieve layers from.

layer_idstring

Optional ID of the layer to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/layers' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "layers": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_layers_successful"
}

OK

Retrieve spaces within a location and layer, optionally filtered by space ID.

get

/spaces

Authorizations

Query parameters

location_idstring

ID of the location to retrieve spaces from.

layer_idstring

ID of the layer to retrieve spaces from.

space_idstring

Optional ID of the space to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

geojsonboolean · default: false

Return geometries in GeoJson format.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/spaces' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "spaces": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_spaces_successful"
}

OK

Retrieve rooms within a location and layer, optionally filtered by room ID.

get

/rooms

Authorizations

Query parameters

location_idstring

ID of the location to retrieve rooms from.

layer_idstring

ID of the layer to retrieve rooms from.

room_idstring

Optional ID of the room to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

geojsonboolean · default: false

Return geometries in GeoJson format.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/rooms' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "rooms": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_rooms_successful"
}

OK

Retrieve areas within a location and layer, optionally filtered by area ID.

get

/areas

Authorizations

Query parameters

location_idstring

ID of the location to retrieve areas from.

layer_idstring

ID of the layer to retrieve areas from.

area_idstring

Optional ID of the area to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

geojsonboolean · default: false

Return geometries in GeoJson format.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/areas' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "areas": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_areas_successful"
}

OK

Retrieve zones within a location and layer, optionally filtered by zone ID.

get

/zones

Authorizations

Query parameters

location_idstring

ID of the location to retrieve zones from.

layer_idstring

ID of the layer to retrieve zones from.

zone_idstring

Optional ID of the zone to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/zones' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "zones": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_zones_successful"
}

OK

Retrieve clusters within a location and layer, optionally filtered by cluster ID.

get

/clusters

Authorizations

Query parameters

location_idstring

ID of the location to retrieve clusters from.

layer_idstring

ID of the layer to retrieve clusters from.

cluster_idstring

Optional ID of the cluster to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/clusters' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "clusters": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_clusters_successful"
}

OK

Retrieve circulation within a location and layer, optionally filtered by circulation ID.

get

/circulation

Authorizations

Query parameters

location_idstring

ID of the location to retrieve circulation from.

layer_idstring

ID of the layer to retrieve circulation from.

circulation_idstring

Optional ID of the circulation to retrieve.

skipinteger · default: 0

Number of items to skip.

limitinteger · default: 25

Maximum number of items to return.

sortstring

Field by which to sort.

orderstring · enum

Sort order, 'asc' or 'desc'.

Options: asc, desc

geojsonboolean · default: false

Return geometries in GeoJson format.

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.gospace.app/spatial/v1/circulation' \
  --header 'x-api-key: YOUR_API_KEY'

200

400

200

{
  "success": true,
  "data": {
    "circulation": [
      {},
      {}
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_circulation_successful"
}

OK