EndpointsAreas
Get Areas
Gets a page of areas, their associated schemes, current stages, and organisations, and pagination metadata.
Gets a page of areas, their associated schemes, current stages, and organisations, and pagination metadata.
Query Parameters
pageNumber?|
Default
1Match
^-?(?:0|[1-9]\d*)$Format
int32pageSize?|
Default
10Match
^-?(?:0|[1-9]\d*)$Format
int32Response Body
application/json
application/problem+json
application/problem+json
curl -X GET "https://example.com/v1/areas"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"scheme": null,
"currentStageAssignment": null,
"organisations": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"websiteUrl": null
}
],
"timeZoneId": "string",
"bbox": {
"west": 0,
"south": 0,
"east": 0,
"north": 0
},
"trackingStatus": "tracked"
}
],
"pageNumber": 0,
"pageSize": 0,
"totalCount": 0,
"totalPages": 0,
"hasPreviousPage": true,
"hasNextPage": true
}{
"type": null,
"title": null,
"status": null,
"detail": null,
"instance": null
}{
"type": null,
"title": null,
"status": null,
"detail": null,
"instance": null
}