Facility
Facility object
{
"id": "bf9a037b-dacd-485f-90f1-7962e6aabd3a",
"name": "Intenseye",
"address": "Maslak, intenseye, ARl 3 Binası, İTÜ Ayazağa Kampüsü, Sarıyer/İstanbul, Turkey",
"geographicCoordinates": {
"lat": 41.10792010000001,
"lng": 29.0324974
},
"workspaceId": "be74e929-50f3-4d0c-b56d-bac612e78553",
"timeZoneId": "Europe/Istanbul",
"cameraCount": 1
}
Endpoints
Get a facilities under workspace
GET/facilities
Arguments
No arguments needed
Returns
Returns a list of facility object
{
"status": "ok",
"data": [
{
"id": "156bd472-07a6-4680-8e17-11816681e14a",
"name": "Intenseye",
"address": "Maslak, intenseye, ARl 3 Binası, İTÜ Ayazağa Kampüsü, Sarıyer/İstanbul, Turkey",
"geographicCoordinates": {
"lat": 41.10792010000001,
"lng": 29.0324974
},
"workspaceId": "f213e5dd-4b92-46f0-95df-0b9dfff4e588",
"timeZoneId": "Europe/Istanbul",
"cameraCount": 100
}
]
}
Get the facility
GET/facilities/:facilityId
Roles:
facilities:read
Arguments
PATH PARAMETERS
- :facilityId
UUID
required Id of the facility
Returns
Returns the facility object
{
"status": "ok",
"data": {
"id": "bf9a037b-dacd-485f-90f1-7962e6aabd3a",
"name": "Intenseye",
"address": "Maslak, intenseye, ARl 3 Binası, İTÜ Ayazağa Kampüsü, Sarıyer/İstanbul, Turkey",
"geographicCoordinates": {
"lat": 41.10792010000001,
"lng": 29.0324974
},
"workspaceId": "be74e929-50f3-4d0c-b56d-bac612e78553",
"timeZoneId": "Europe/Istanbul",
"cameraCount": 1
}
}
Update name of the facility
PATCH/facilities/:facilityId
Roles:
facilities:read
Arguments
PATH PARAMETERS
- :facilityId
UUID
required Id of the facility
BODY
- name
String
required Name of the facility
Returns
Returns a success message
{
"status": "ok",
"message": "Facility updated"
}
Get a single facility
GET/workspaces/facilities/:facilityId
Arguments
PATH PARAMETERS
- :facilityId
UUID
required Id of the facility to retrieve
Returns
Returns a facility object containing the id of inserted item.
{
"status": "ok",
"data": {
"id": "156bd472-07a6-4680-8e17-11816681e14a",
"name": "Intenseye",
"address": "Maslak, intenseye, ARl 3 Binası, İTÜ Ayazağa Kampüsü, Sarıyer/İstanbul, Turkey",
"geographicCoordinates": {
"lat": 41.10792010000001,
"lng": 29.0324974
},
"workspaceId": "f213e5dd-4b92-46f0-95df-0b9dfff4e588",
"timeZoneId": "Europe/Istanbul"
}
}
Get all the facilities in the workspace
GET/workspaces/facilities
Arguments
No arguments needed
Returns
Returns the facility objects for the account that was authenticated in the request.
{
"status": "ok",
"data": [
{
"id": "156bd472-07a6-4680-8e17-11816681e14a",
"name": "Intenseye",
"address": "Maslak, intenseye, ARl 3 Binası, İTÜ Ayazağa Kampüsü, Sarıyer/İstanbul, Turkey",
"geographicCoordinates": {
"lat": 41.10792010000001,
"lng": 29.0324974
},
"workspaceId": "f213e5dd-4b92-46f0-95df-0b9dfff4e588",
"timeZoneId": "Europe/Istanbul",
"cameraCount": 1
}
]
}
Send facility heartbeat
POST/facilities/:facilityId/heartbeat
Arguments
HEADERS
- Authorization
- Basic authentication
PATH PARAMETERS
- :facilityId
UUID
required Id of the facility
Returns
Returns a success message
{
"status": "ok",
"message": "Saved heartbeat"
}