REST
Event Footage

Event Footage

🚫
NOTE: This part of the API does not exist yet.

Event footage is stored according to the file retention settings. The footage can be retrieved using the following endpoint.

GET

Endpoint

GET /care-homes/<locationId>/footage/<eventType>/<eventId>/<expirationTime>

  • eventType: The type of event, e.g. fall, helpCall, noise, outOfBed, outOfRoom, outOfSeat, wandering, or roomStateChange.
  • eventId: The unique identifier of the event.
  • expirationTime: The expiration time of the file url in seconds, maximum is one day.

Expected responses

200 OK 

{
  "fileUrl": "<file_url>"
}
  • fileUrl: A signed s3 URL that can be used to download the footage. It is valid for the specified expiration time.

404 Not Found 

{
  "error": "Footage not found."
}
  • error: Error message indicating that the footage was not found. This can happen if the event does not exist or if the footage has been deleted due to retention settings.
Location ManagementRoom Management