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.

get

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

Authorizations

Query parameters

location_idstringOptional

Optional ID of the location to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve layers from.

layer_idstringOptional

Optional ID of the layer to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve spaces from.

layer_idstringOptional

ID of the layer to retrieve spaces from.

space_idstringOptional

Optional ID of the space to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

geojsonbooleanOptional

Return geometries in GeoJson format.

Default: false

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve rooms from.

layer_idstringOptional

ID of the layer to retrieve rooms from.

room_idstringOptional

Optional ID of the room to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

geojsonbooleanOptional

Return geometries in GeoJson format.

Default: false

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve areas from.

layer_idstringOptional

ID of the layer to retrieve areas from.

area_idstringOptional

Optional ID of the area to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

geojsonbooleanOptional

Return geometries in GeoJson format.

Default: false

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve zones from.

layer_idstringOptional

ID of the layer to retrieve zones from.

zone_idstringOptional

Optional ID of the zone to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve clusters from.

layer_idstringOptional

ID of the layer to retrieve clusters from.

cluster_idstringOptional

Optional ID of the cluster to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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

get

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

Authorizations

Query parameters

location_idstringOptional

ID of the location to retrieve circulation from.

layer_idstringOptional

ID of the layer to retrieve circulation from.

circulation_idstringOptional

Optional ID of the circulation to retrieve.

skipintegerOptional

Number of items to skip.

Default: 0

limitintegerOptional

Maximum number of items to return.

Default: 25

sortstringOptional

Field by which to sort.

orderstring · enumOptional

Sort order, 'asc' or 'desc'.

Possible values:

geojsonbooleanOptional

Return geometries in GeoJson format.

Default: false

Responses

200

OK

application/json

400

Bad Request

application/json

get

HTTPcURLJavaScriptPython

GET /spatial/v1/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

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