HTTP request parameters

Answered

Garry Carr

January 06, 2022 13:15

Are there more parameters available when doing an analytics HTTP Request, other than Source, eventName, CameraId, CameraName and EventType.

For Example can you get an id for the event to then be used by the api to get video/Images from the event.

 Or the date & time when the event occurred that can then be used to find bookmarks on the NVR

0

• 

  Ichiro

  • Network Optix team

  January 10, 2022 08:34 Edited

  Hi Garry Carr,

  As you may know, WAVE nows supports additional action parameter placeholders for the "Do HTTP request" action. The placeholders can be added to the HTTP POST request body to be automatically replaced by the corresponding values from Analytics Event and Generic Events.

  • {event.cameraId} – replaced by the camera ID (e.g., {{{ad1d1b6c-7013-0049-6fd4-ff15450e4716}}}
  • {event.cameraName} – replaced by the camera name (e.g., PND-9080R)
  • {event.eventType} – replaced by the event type (e.g., nx.stub.objectInTheArea or nx.stub.lineCrossing)
  • {event.eventName} – replaced by the event name (e.g., Object in the area or Line crossing)
  • {event.caption} – replaced by the caption (e.g., “Line crossing - impulse event (caption)”)
  • {event.description} – replaced by the description (e.g., "Line crossing - impulse event (description)"). -

  This means that you can have the cameraId from the placeholder and the event time could be the same that you receive the notification or request, so you also know the timestamp of the event.

  So, according to you reqeustions: 

  For Example can you get an id for the event to then be used by the api to get video/Images from the event. Or the date & time when the event occurred that can then be used to find bookmarks on the NVR

  Since you already have the cameraId and the timestamp of the event,
  1) you can use "/ec2/cameraThumbnail" to get the image of the camera at the timestamp you specified.
  2) you can use "/media/<cameraId>.<format>" to download the video of the camera at the duration you specified.
  3) you can use "/ec2/bookmarks" to get the bookmark list of the camera at the duration you specified.
  
  Based on the above, you can almost get everything you need by using the cameraId to send the API request to mediaserver with the event timestamp.
  WAVE does not use the "EventId" as the identifiers for those actions or events, and it is not necessary to have the specific event ID to get the information your need. If you would like to have the image or video or bookmark, what you need to use would be the "cameraId" and "timestamp".

  You can refer to the API documentation ( Nx Server HTTP REST API – Network Optix ) for more detail. Thanks.

  0

Please sign in to leave a comment.