incidents

Retrieve incident detail

Retrieve incident detail

get/rts/incidents/{incident_id}/

Request

  • Base URL
    https://api.angelcam.com/v1
  • Auth
    • OAuth 2
      Authorization codehttps://my.angelcam.com/oauth/authorize/, token URL https://my.angelcam.com/oauth/token/
      PasswordToken URL https://api.angelcam.com/oauth/token/
      Scopesincidents_access
    • or API key in header Authorization
  • TypeScript
    A function with typed inputs. Its response is checked against the schema.

Path parameters

incident_idinteger required

Incident ID

Response

OK

idnumber required

Incident ID

created_atstring required

Time when incident was created, format %Y-%m-%dT%H:%M:%SZ

verified_atstring nullable required

Time when incident was verified, format %Y-%m-%dT%H:%M:%SZ

closed_atstring nullable required

Time when incident was closed, format %Y-%m-%dT%H:%M:%SZ

first_event_occurred_atstring nullable required

Time when first event (triggering one) occured, format %Y-%m-%dT%H:%M:%SZ

last_event_occurred_atstring nullable required

Time when last event durign of incident occured, format %Y-%m-%dT%H:%M:%SZ

event_countnumber required

Number of events during incident

incident_sharing_urlstring nullable required

URL that can be used for incident verification by third parties. The URL leads to a web page where all cameras from the affected location can be viewed (live streams + the last two hours of recording). The URL is valid for one hour after the corresponding incident is created. This field will be null if the URL is no longer valid.

Example response

{
  "id": 1,
  "created_at": "2019-08-09T13:23:23.000Z",
  "verified_at": "2019-08-09T13:23:58.000Z",
  "closed_at": null,
  "first_event_occurred_at": "2019-08-09T13:23:20.000Z",
  "last_event_occurred_at": "2019-08-09T13:25:16.000Z",
  "event_count": 5,
  "incident_sharing_url": "www.example.com",
  "snapshot": {
    "url": "https://dsw4ncxjbie85.cloudfront.net/snapshot/81/y8jol6kbn0ol1gh2.jpg",
    "created_at": "2019-08-09T13:23:24.000Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.