Response data types

This section provides a reference for the data structures used in responses to requests against the Safety Cameras Feed API resources.

Element	Data Type	Use	Description
`safetyCameras`	Array of `SafetyCamera`.	Required	Safety cameras.

SafetyCamera

SafetyCamera defines the following attributes:

Element	Data Type	Use	Description
`id`	String	Required	Id of a camera
`country`	String	Required	The country code in ISO 3166-1 alpha 3 format.
`positions`	Array of the `Position`.	Required	Position/s of a camera. There can be both single position cameras and cameras represented by a sequence of positions. In the case of `Average` speed cameras, the first position in the array represents a section start camera and the section end camera.
`cameraType`	String	Required	The type of a camera, can be one of `Average`, `BusLane`, `DangerousZone`, `Mobile`, `RedLight`, `RedLightAndSpeed`, `RegularMobileZone`, `Speed`.• An Average camera measures a users average speed between 2 or more fixed positions. • A BusLane camera watches for unauthorized vehicles using a lane that is designated as buses-only. • A DangerousZone camera represents a stretch of road (between 2 positions) where a camera exists or has been reported. The actual camera may be anywhere within the zone, and it could be any of the other types. This type is used only in France, and it is the only type reported in France, in compliance with local regulations. • A Mobile camera checks the speed of passing vehicles at a single position and can be moved to different locations. • A RedLight camera checks if a vehicle passes through a red traffic light (breaking traffic rules) at a single, fixed position. The rule for red light cameras in Eu region is that those are placed close to the “stop line” before the traffic lights, this is where they are enforcing, once you cross the stop line on a red light, you receive the fine. This rule is applied for RedLightAndSpeed camera type. • A RedLightAndSpeed checks both whether a vehicle passes through a red traffic light and the speed of this vehicle, at a single, fixed position. • A RegularMobileZone camera represents a stretch of road (between 2 or more positions) where mobile cameras have been frequently reported in the last few months. • A Speed camera checks the speed of vehicles at a single, fixed position. Occasionally, new Camera Types are added. HERE recommends that you refrain from utilizing the new types if you are unsure of what they define.
`speedLimit`	SpeedLimit	Optional	The speed limit of the road the camera is covering.
`directionType`	String	Optional	Directions being enforced, can be one of `Both`, `Same`.
`length`	Length	Optional	The length of the zone if applicable.
`openLR`	Array of strings	Optional	Base64 encoded binary OpenLR representation of the location. This is based on the ISO/TS 21219-22 (TPEG2-OLR) specification. In the case of a single camera alert, this will be a point location snapped to the nearest roadway, and in the case of a zone alert (Average, RegularMobileZone, or DangerousZone) it will be linear location describing a roadway segment covered by the zone. There is one array element if the directionType is “Same,” and two if the directionType is “Both,” describing the two directions of travel on the road.
`timestamp`	ISO-8601 Date/Time (String)	Optional	The last updated timestamp for the camera, according to the ISO-8601.
`active`	Boolean	Optional	Indicates if camera is active (enabled)

Position

Position defines the following attributes:

Element	Data Type	Use	Description
`latitude`	Double	Required	Latitude of the location.
`longitude`	Double	Required	Longitude of the location.
`drivingDirection`	Integer	Optional	Driving direction that the safety camera is enforcing, [0..359].

SpeedLimit

SpeedLimit defines the following attributes:

Element	Data Type	Use	Description
`value`	Integer	Required	The speed limit value. If limit is variable and date and time range limit is defined, speed limit is updated to value valid at the local time for camera position based on date and time range.
`unit`	String	Required	Speed unit, as in `KPH` or `MPH`.
`isVariable`	Boolean	Optional	This camera is in a variable speed zone. The speed limit value provided may not be the current speed limit, because it can change. (missing values always default to `false`)
`isUnlimited`	Boolean	Optional	Speeds for this camera are normally unlimited. A speed limit value isn't provided. (missing value will always default to `false`)
`dateTimeRangeLimits`	Array of Date Time Limit	Optional	Additional speed limits for date and time ranges.
`specialRoadConditionLimits`	Array of Special Road Condition Limit	Optional	Additional speed limits for different road conditions.
`speedLimitOutsideRange`	Integer	Optional	Speeds limit valid outside Date and time range or special road conditions in the same `unit`. Present only when the speed limit is variable and Date time range or special road conditions limits are defined.

DateTimeLimit

DateTimeLimit defines the following attributes:

Element	Data Type	Use	Description
`value`	Integer	Required	Speed limit value.
`timeRange`	TimeRange	Optional	Defines the time interval for the speed limit value.
`daysOfWeek`	Array of DayOfWeek	Optional	Defines days when the speed limit value applies. Omitted if the limit applies to every day of the week.
`dateRange`	DateRange	Optional	Defines the date interval when the speed limit value applies.
`monthRange`	MonthRange	Optional	Defines the months when the speed limit value applies.

SpecialRoadConditionLimit

SpecialRoadConditionLimit defines the following attributes:

Element	Data Type	Use	Description
`specialRoadCondition`	String	Required	Can be either `RAIN`, `FOG`, `SNOW`, or `SCHOOL`.
`value`	Integer	Required	Speed limit value.

DateRange

DateRange defines the following attributes:

Element	Data Type	Use	Description
`start`	LocalDate	Required	Start of the date interval.
`end`	LocalDate	Required	End of the date interval.

TimeRange

TimeRange defines the following attributes:

Element	Data Type	Use	Description
`start`	LocalTime	Required	Start of the time interval.
`end`	LocalTime	Required	End of the time interval.

MonthRange

MonthRange defines the following attributes:

Element	Data Type	Use	Description
`start`	Month	Required	Start of the month interval.
`end`	Month	Required	End of the month interval.

Length

Length defines the following attributes:

Element	Data Type	Use	Description
`value`	Integer	Required	The length value.
`unit`	String	Required	Length unit, such as `Meter`.