gospace AIDocsAdmin Console

Spatial API

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
get
GET /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "locations": [
      {
        "location_id": "loc_123",
        "name": "Location 1",
        "description": "First location"
      },
      {
        "location_id": "loc_124",
        "name": "Location 2",
        "description": "Second location"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_locations_successful"
}
post

Create multiple locations.

Authorizations
Bodyobject[]
namestringRequired

Name of the location.

descriptionstringOptional

Description of the location.

Responses
201
Created
application/json
post
POST /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

[
  {
    "name": "text",
    "description": "text"
  }
]
{
  "success": true,
  "data": {
    "locations": [
      {
        "location_id": "loc_123"
      },
      {
        "location_id": "loc_124"
      }
    ]
  },
  "identifier": "create_locations_successful"
}
put

Update multiple locations.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to update.

namestringOptional

Name of the location.

descriptionstringOptional

Description of the location.

Responses
200
OK
application/json
put
PUT /spatial/v1/locations HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 59

[
  {
    "location_id": "text",
    "name": "text",
    "description": "text"
  }
]
{
  "success": true,
  "data": {
    "locations": [
      {
        "location_id": "loc_123"
      },
      {
        "location_id": "loc_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "layers": [
      {
        "layer_id": "layer_123",
        "location_id": "loc_123",
        "name": "Layer 1"
      },
      {
        "layer_id": "layer_124",
        "location_id": "loc_123",
        "name": "Layer 2"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_layers_successful"
}
post

Create multiple layers.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the layer with.

namestringRequired

Name of the layer.

Responses
201
Created
application/json
post
POST /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 38

[
  {
    "location_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "layers": [
      {
        "layer_id": "layer_123"
      },
      {
        "layer_id": "layer_124"
      }
    ]
  },
  "identifier": "create_layers_successful"
}
put

Update multiple layers.

Authorizations
Bodyobject[]
layer_idstringRequired

ID of the layer to update.

namestringOptional

Name of the layer.

Responses
200
OK
application/json
put
PUT /spatial/v1/layers HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 35

[
  {
    "layer_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "layers": [
      {
        "layer_id": "layer_123"
      },
      {
        "layer_id": "layer_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "spaces": [
      {
        "space_id": "space_123",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Space 1",
        "geometry": {}
      },
      {
        "space_id": "space_124",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Space 2",
        "geometry": {}
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_spaces_successful"
}
post

Create multiple spaces.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the space with.

layer_idstringRequired

ID of the layer to associate the space with.

namestringRequired

Name of the space.

geometryobjectOptional

GeoJSON geometry for the space.

Responses
201
Created
application/json
post
POST /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

[
  {
    "location_id": "text",
    "layer_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "spaces": [
      {
        "space_id": "space_123"
      },
      {
        "space_id": "space_124"
      }
    ]
  },
  "identifier": "create_spaces_successful"
}
put

Update multiple spaces.

Authorizations
Bodyobject[]
space_idstringRequired

ID of the space to update.

namestringOptional

Name of the space.

geometryobjectOptional

GeoJSON geometry for the space.

Responses
200
OK
application/json
put
PUT /spatial/v1/spaces HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 49

[
  {
    "space_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "spaces": [
      {
        "space_id": "space_123"
      },
      {
        "space_id": "space_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "rooms": [
      {
        "room_id": "room_123",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Room 1",
        "geometry": {}
      },
      {
        "room_id": "room_124",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Room 2",
        "geometry": {}
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_rooms_successful"
}
post

Create multiple rooms.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the room with.

layer_idstringRequired

ID of the layer to associate the room with.

namestringRequired

Name of the room.

geometryobjectOptional

GeoJSON geometry for the room.

Responses
201
Created
application/json
post
POST /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

[
  {
    "location_id": "text",
    "layer_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "rooms": [
      {
        "room_id": "room_123"
      },
      {
        "room_id": "room_124"
      }
    ]
  },
  "identifier": "create_rooms_successful"
}
put

Update multiple rooms.

Authorizations
Bodyobject[]
room_idstringRequired

ID of the room to update.

namestringOptional

Name of the room.

geometryobjectOptional

GeoJSON geometry for the room.

Responses
200
OK
application/json
put
PUT /spatial/v1/rooms HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

[
  {
    "room_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "rooms": [
      {
        "room_id": "room_123"
      },
      {
        "room_id": "room_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "areas": [
      {
        "area_id": "area_123",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Area 1",
        "geometry": {}
      },
      {
        "area_id": "area_124",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Area 2",
        "geometry": {}
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_areas_successful"
}
post

Create multiple areas.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the area with.

layer_idstringRequired

ID of the layer to associate the area with.

namestringRequired

Name of the area.

geometryobjectOptional

GeoJSON geometry for the area.

Responses
201
Created
application/json
post
POST /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

[
  {
    "location_id": "text",
    "layer_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "areas": [
      {
        "area_id": "area_123"
      },
      {
        "area_id": "area_124"
      }
    ]
  },
  "identifier": "create_areas_successful"
}
put

Update multiple areas.

Authorizations
Bodyobject[]
area_idstringRequired

ID of the area to update.

namestringOptional

Name of the area.

geometryobjectOptional

GeoJSON geometry for the area.

Responses
200
OK
application/json
put
PUT /spatial/v1/areas HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 48

[
  {
    "area_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "areas": [
      {
        "area_id": "area_123"
      },
      {
        "area_id": "area_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "zones": [
      {
        "zone_id": "zone_123",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Zone 1"
      },
      {
        "zone_id": "zone_124",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Zone 2"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_zones_successful"
}
post

Create multiple zones.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the zone with.

layer_idstringRequired

ID of the layer to associate the zone with.

namestringRequired

Name of the zone.

Responses
201
Created
application/json
post
POST /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

[
  {
    "location_id": "text",
    "layer_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "zones": [
      {
        "zone_id": "zone_123"
      },
      {
        "zone_id": "zone_124"
      }
    ]
  },
  "identifier": "create_zones_successful"
}
put

Update multiple zones.

Authorizations
Bodyobject[]
zone_idstringRequired

ID of the zone to update.

namestringOptional

Name of the zone.

Responses
200
OK
application/json
put
PUT /spatial/v1/zones HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 34

[
  {
    "zone_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "zones": [
      {
        "zone_id": "zone_123"
      },
      {
        "zone_id": "zone_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "clusters": [
      {
        "cluster_id": "cluster_123",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Cluster 1"
      },
      {
        "cluster_id": "cluster_124",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Cluster 2"
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_clusters_successful"
}
post

Create multiple clusters.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the cluster with.

layer_idstringRequired

ID of the layer to associate the cluster with.

namestringRequired

Name of the cluster.

Responses
201
Created
application/json
post
POST /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 56

[
  {
    "location_id": "text",
    "layer_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "clusters": [
      {
        "cluster_id": "cluster_123"
      },
      {
        "cluster_id": "cluster_124"
      }
    ]
  },
  "identifier": "create_clusters_successful"
}
put

Update multiple clusters.

Authorizations
Bodyobject[]
cluster_idstringRequired

ID of the cluster to update.

namestringOptional

Name of the cluster.

Responses
200
OK
application/json
put
PUT /spatial/v1/clusters HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 37

[
  {
    "cluster_id": "text",
    "name": "text"
  }
]
{
  "success": true,
  "data": {
    "clusters": [
      {
        "cluster_id": "cluster_123"
      },
      {
        "cluster_id": "cluster_124"
      }
    ]
  },
  "identifier": "update_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
get
GET /spatial/v1/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "data": {
    "circulation": [
      {
        "circulation_id": "circulation_123",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Circulation 1",
        "geometry": {}
      },
      {
        "circulation_id": "circulation_124",
        "location_id": "loc_123",
        "layer_id": "layer_123",
        "name": "Circulation 2",
        "geometry": {}
      }
    ],
    "pagination": {
      "current_results": {
        "from": 1,
        "to": 25
      },
      "total_results": 100
    }
  },
  "identifier": "get_circulation_successful"
}
post

Create multiple circulation entries.

Authorizations
Bodyobject[]
location_idstringRequired

ID of the location to associate the circulation with.

layer_idstringRequired

ID of the layer to associate the circulation with.

namestringRequired

Name of the circulation.

geometryobjectOptional

GeoJSON geometry for the circulation.

Responses
201
Created
application/json
post
POST /spatial/v1/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 70

[
  {
    "location_id": "text",
    "layer_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "circulation": [
      {
        "circulation_id": "circulation_123"
      },
      {
        "circulation_id": "circulation_124"
      }
    ]
  },
  "identifier": "create_circulation_successful"
}
put

Update multiple circulation entries.

Authorizations
Bodyobject[]
circulation_idstringRequired

ID of the circulation to update.

namestringOptional

Name of the circulation.

geometryobjectOptional

GeoJSON geometry for the circulation.

Responses
200
OK
application/json
put
PUT /spatial/v1/circulation HTTP/1.1
Host: api.gospace.app
x-api-key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 55

[
  {
    "circulation_id": "text",
    "name": "text",
    "geometry": {}
  }
]
{
  "success": true,
  "data": {
    "circulation": [
      {
        "circulation_id": "circulation_123"
      },
      {
        "circulation_id": "circulation_124"
      }
    ]
  },
  "identifier": "update_circulation_successful"
}
PreviousInstallationNextDirectory API

Last updated

Was this helpful?