Get Boundary
GET/v4/boundaries/:id
This endpoint returns a single LiveBy Boundary based on a LiveBy Boundary ID. It includes the geometry for the boundary.
Request
Path Parameters
The LiveBy Boundary ID obtained from the /v4/boundaries endpoint.
Responses
- 200
- 401
- 403
- 404
- 429
- 500
- 504
- application/json
- Schema
- Example (from schema)
Schema
- Polygon
- LineString
- Point
Array [
]
Array [
]
Array [
]
- MultiPolygon
- Polygon
Array [
]
Array [
]
Array [
]
data
object
The LiveBy Boundary ID.
address
object
required
This is a geocoded point near the center of the shape. While the query parameters specify area-level-1 as a standard field, this address uses the local name for area names E.G. state, county, province, village.
Possible values: >= 1
and <= 11
labelLocation
object
required
Possible values: >= 2
, <= 2
boundingBox
object
required
coordinates
object
required
oneOf
Possible values: >= 2
, <= 2
number
geometry
object
The geometry for the boundary. This propertye is only included when includeGeometries
is set to true
when calling the /v4/boundaries
endpoint. It is always returned when calling the /v4/boundaries/:id
endpoint.
coordinates
object
required
oneOf
Possible values: >= 2
, <= 2
Possible values: >= 2
, <= 2
associatedBoundaries
object[]
required
Possible values: >= 1
and <= 11
{
"success": true,
"data": {
"id": "string",
"address": {
"postcode": "string",
"city": "string",
"municipality": "string",
"village": "string",
"district": "string",
"subdistrict": "string",
"archipelago": "string",
"territory": "string",
"island": "string",
"province": "string",
"state": "string",
"county": "string",
"township": "string",
"region": "string",
"town": "string",
"locality": "string"
},
"layer": "string",
"private": true,
"status": "string",
"osmLevel": 0,
"name": "string",
"virtualLayers": [
"string"
],
"labelLocation": {
"type": "string",
"coordinates": [
-96.662575133,
40.79944225
]
},
"boundingBox": {
"type": "string",
"coordinates": [
[
[
0
]
]
]
},
"geometry": {
"type": "string",
"coordinates": [
[
[
[
0
]
]
]
]
},
"associatedBoundaries": [
{
"layer": "string",
"osmLevel": 0,
"boundaryId": "string",
"name": "string"
}
],
"censusId": "string",
"createdAt": "2024-07-29T15:51:28.071Z",
"updatedAt": "2024-07-29T15:51:28.071Z"
}
}
Unauthorized
Forbidden
Not Found
Too Many Requests
Internal Server Error
Service Unavailable