Skip to main content

EP. Get List of Venue Services

Fetch list of processing services configured for company location (venue).

info

Each venue will usually have at least one processing service configured for each video stream, e.g.:

- Gate 1 Entry/Exit Count
- Area 1 Occupancy Count
- Venue Dwell Time Estimation
- etc

URI

/api/v1/locations/{LOCATION_ID}/services

Request Query Parameters

Request ParameterDescription
LOCATION_IDUUID assigned to a specific location

Response

The schema of the `data` section of JSON response
{
"type": "array",
"items": {
"type": "object",
"properties": {
"uuid": {
"type": "string"
},
"name": {
"type": "string"
},
"service_type": {
"type": "string"
},
"service_code": {
"type": "string"
},
"cfg": {
"type": "object"
},
"folder_id": {
"type": "number"
}
}
}
}
Response ParameterDescription
uuidA unique identifier of a service.
nameService name.
service_typeDescribes the nature of a service.
service_codeYou can ignore this value.
cfgService-specific configuration parameters in JSON format.
folder_idIdentifier of a venue sector that this service belongs to.
Sample Response
{
"data": [
{
"uuid": "e4163a14-9ec6-4322-981f-07c762f6fc30",
"name": "Enquiries Entries",
"service_type": "LineCrossingCounterService",
"service_code": "EntryExit",
"cfg": {},
"folder_id": 11
},
{
"uuid": "119bafbc-9769-42ea-b0e5-48c83ef17f0e",
"name": "Exit Gate #1",
"service_type": "LineCrossingCounterService",
"service_code": "EntryExit",
"cfg": {},
"folder_id": 12
},
{
"uuid": "bb1a4aa4-338d-4ff3-ba37-31999c4196e6",
"name": "Exit Gate #2",
"service_type": "LineCrossingCounterService",
"service_code": "EntryExit",
"cfg": {},
"folder_id": 13
},
{
"uuid": "0e70a034-1976-4b5b-b3d1-74f25c812cd8",
"name": "Stay Time",
"service_type": "StayTimeEstimationService",
"service_code": "StayTimeEstimation",
"cfg": {
"gate_services": [
{
"uuid": "e4163a14-9ec6-4322-981f-07c762f6fc30",
"name": "Enquiries Entries"
},
{
"uuid": "119bafbc-9769-42ea-b0e5-48c83ef17f0e",
"name": "Exit Gate #1"
}
]
},
"folder_id": 0
}
],
"success": true
}