Reference data
Reference data for organisations, locations, recordings, and camera servers — over the Metrics WebSocket.
Returns reference data for the requested entity type. The Metrics API analogue of the Core REST endpoints — useful when you want to keep a single WebSocket connection for both metrics and lookups.
Returned via detail/list with returnEntityType set to one of organisation, location, recording, or camera_server. No filter fields required.
Body parameters
Standard detail request envelope. Set returnEntityType to one of:
| Value | Returns |
|---|---|
organisation | Organisation reference data |
location | Location reference data |
recording | Recording (camera feed) reference data |
camera_server | Camera server reference data (sparse in current implementation) |
Example request
{
"action": "detail",
"data": {
"id": "req-er-001",
"route": "detail/list",
"body": {
"returnEntityType": "location",
"entities": ["64a1b2c3d4e5f6a7b8c9d0e2"],
"entityType": "organisation"
}
}
}Example response
req-er-001|0|0|[
{
"id": "64a1b2c3d4e5f6a7b8c9d0e3",
"organisation_id": "64a1b2c3d4e5f6a7b8c9d0e2",
"name": "Oxford Street Store",
"status": "operational",
"coordinates": "[51.5074,-0.1278]",
"timezone": "Europe/London",
"currency": "GBP"
},
{
"id": "64a1b2c3d4e5f6a7b8c9d0e6",
"organisation_id": "64a1b2c3d4e5f6a7b8c9d0e2",
"name": "Regent Street Store",
"status": "operational",
"coordinates": "[51.5119,-0.1422]",
"timezone": "Europe/London",
"currency": "GBP"
}
]The exact field set varies by returnEntityType:
organisation—id,name,status,timezone,currencylocation—id,organisation_id,name,status,coordinates,timezone,currencyrecording—id,organisation_id,location_id,camera_server_id,name,statuscamera_server— sparse; current implementation returns[]