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.

GEThttps://api.gospace.com/spatial/v1/locations

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/locations', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "locations": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/layers

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/layers', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "layers": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/spaces

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/spaces', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "spaces": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/rooms

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/rooms', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "rooms": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/areas

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/areas', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "areas": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/zones

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/zones', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "zones": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/clusters

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/clusters', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "clusters": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}

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

GEThttps://api.gospace.com/spatial/v1/circulation

Query parameters

Response

200400

OK

Body

application/json

successboolean

dataobject

identifierstring

Request

JavaScriptCurlPython

const response = await fetch('https://api.gospace.com/spatial/v1/circulation', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "success": false,
  "data": {
    "circulation": [
      {
        "_id": "text"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 0,
        "to": 0
      },
      "total_results": 0
    }
  },
  "identifier": "text"
}