Overview
Vizzion's Camera API provides a variety of endpoints to request data and images from fixed roadside and hotspot camera locations, or from arbitrary locations as Drive Streams.
Requesting Images from Roadside Cameras and Hotspot Cameras
Before an application can request camera images, the application must first request camera data using a method such as GetCamerasInBox, or GetCamerasOnRoute. These methods return a set of cameras based on a number of input parameters. For example, GetCamerasInBox returns all cameras for a given latitude/longitude bounding box. Each camera returned by one of these methods will include a unique camera identifier in the CameraID field. This camera identifier can then be used by the GetCameraImage method to request a camera image.
Crowdsourcing the reason for an incident (left), and exploring alternative routes (right)
Methods
| Name | Description |
|---|---|
| GetCamerasInBox | Returns all cameras for a given latitude/longitude bounding box. |
| GetCamerasOnRoute | Returns all cameras within 100 meters of the route specified by the given latitude/longitude values, in the order in which they appear along the route. |
| GetCamerasOnRouteByTMCs | Returns a set of cameras that may have a view along a route defined by a set of TMC codes. |
| GetCamerasForIncident | Returns a set of cameras that may have a view of an incident, sorted by likelihood. |
| GetCamerasInPolygon | Returns all cameras within a polygon specified by the given latitude/longitude values. |
| GetCamerasInRadius | Returns all cameras within the specified radius of a specified latitude/longitude. |
| GetCamerasInList | Returns all cameras for the given list of Camera IDs. |
| GetCamera | Returns the camera with the given ID. |
| GetRegions | Returns all continents, countries, markets, regions, and states. |
| GetCamerasInRegion | Returns all cameras for a given region. |
| GetCameraImage | Returns an image, current viewpoint (if available), and collection time for a given camera. |
| GetCameraStream | Returns a video stream for a given camera. |
| GetCameraStatus | Returns camera status for all cameras in a given region. |
| GetHistoricalCamerasInBox | Returns all cameras for a given latitude/longitude bounding box that have an image available at or near the given date/time. |
| GetHistoricalCameraImage | Returns an image, current viewpoint (if available), and collection time for a given camera, at or near the given date/time. |
| SubmitImage | Submits an image from an on-vehicle camera to the Camera API. |
Requesting Drive Streams
Before an application can request Drive streams, the application must first request Drive data using the GET /drives endpoint. This returns a set of Drives based on a number of input parameters (geographic area, time period, etc.).
Each Drive returned will include a unique vehicle identifier in the “VehicleId” field. This vehicle identifier, along with the time of the Drive, can then be passed to the GET /vehicles/{vehicleId}/streams endpoint to request the Drive images.
Methods
| Name | Description |
|---|---|
| GET /drives | Returns a collection of Drives matching a specified query, ordered by ascending date and time. |
| GET /vehicles/{vehicleId}/streams | Return a collection of consecutive images from a specified vehicle at specified time. |
Note: If the application unexpectedly makes an excessive number of requests at a rate that exceeds agreed application requirements, further calls to the Camera API will be subject to temporary throttling. Contact support@vizzion.com for further information.