get /camera

Contains up to three collections of cameras: Active, Missing and Unknown.

• Active cameras are those that are configured and online.
• Missing cameras are those that are configured but not online.
• Unknown cameras are those that are not configured but are online.

get /camera/{macAddress}

get /cameras

Returns a JSON object where each property is the mac address of a camera associated with the GRIDSMART Processor. Each JSON value is a bitmask representation of four possible camera states.

get /counts/bydate/{date}

Available dates can be queried using the /counts API.

This API requires one of the following modules:

• Performance
• Performance+
• VDM
• VDM+

get /counts

This API requires one of the following modules:

• Performance
• Performance+
• VDM
• VDM+

get /datetime

get /outputstates

get /phases

Phases are represented by the following enumeration

Unknown = 0
Red = 1
Yellow = 2
NotGreen = 3
Green = 5
FlashingYellow = 6

get /

get /sitename

get /zonestates/vehicle/{cameraMac}

The order of the zones in the returned value corresponds to the order of the zones in the current site configuration where the zones are sorted by ID. The integer value for the zone state is a bitmask defined by the following enumeration:

{
    OFF = 0, 
    ON = 1, 
    LEARNING = 2,
    DETECTION = 4, 
    TIME = 8, 
    LATCHING = 16, 
    LOSS_OF_VISIBILITY = 32, 
    USER_SET = 256, 
    USER = 512
}

USER_SET implies the zone state was affected by a user and then the state of the USER bit defines whether or not the user activated or deactivated the zone.

The response array will always contain 64 elements. If N is the number of configured vehicle zones and N < 64, array elements for index i where N <= i < 64 will be 1 by default.

get /realtimedata/approachvolume

Total volume counts, grouped by approach. The data is returned in a 5 element dictionary, one for each approach plus unassigned. Each approach entry has a list of ninety-six 15 minute intervals that are in order from 00:00 to 24:00. The first entry is for 00:00-00:15, the second is for 00:15-00:30, and so on and so forth until 23:45-24:00.

get /realtimedata/phase

This API requires one of the following modules:

• Performance
• Performance+

Historical data can be downloaded using the /counts/bydate/{date} API.

Realtime data for each of the 16 possible phases for each minute of the last hour. Data includes minute-by-minute arrays of arrivals, arrivals on green, green occupancy time (seconds), green time (seconds), greens received (usually 0 or 1), occupancy time (seconds), percent arrivals on green, red occupancy time (second), red time (seconds), and turning movement counts by turn type. The arrays are ordered from 0 to 59 minutes past the hour. Also, included is a current snapshot of the zone that includes current green time (seconds) and estimated occupancy count (number of vehicles in zone).

get /realtimedata/volume

The data is returned in a list of ninety-six 15 minute intervals that are in order from 00:00 to 24:00. The first entry is for 00:00-00:15, the second is for 00:15-00:30, and so on and so forth until 23:45-24:00.

get /realtimedata/volumedata

This API requires one of the following modules:

• Performance
• Performance+

Total volume counts as well as volume counts for each approach. This is a combination of the realtime total volume and the realtime approach volume API calls.

get /realtimedata/zone

The zone is described with approach (ZoneApproach), zone name (ZoneName), assigned phases (ProtectedPhases, PermittedPhases), assigned outputs (Outputs), and assigned turn types (ZoneTurnType).

Data includes minute-by-minute arrays of Exits, GreenOccupancyTime (seconds), GreensReceived (usually 0 or 1), GreenTime (seconds), MedianSpeedKph (-1 indicates no data), MedianSpeedMph (-1 indicates no data), OccupancyTime (seconds), PercentArrivalsOnGreen, PercentArrivalsOnRed, RedOccupancyTime (seconds), RedTime (seconds), and turning movement counts by turn type (TurnsLeft, TurnsRight, TurnsThrough, TurnsUturn). The arrays are ordered from 0 to 59 minutes past the hour according to the processor local time, which is provided as the Timestamp field for each zone.

Also, included is a current Snapshot of the zone that includes CurrentGreenTime (seconds), current MedianSpeedKph (-1 indicates no data), current MedianSpeedMph (-1 indicates no data), and estimated OccupancyCount (number of vehicles in zone).

Other fields that may appear represent unused and/or unsupported data that may be from legacy applications or preserved for future use.

get /realtimedata/zonevolume

Total volume counts, grouped by zone. The data is returned as a dictionary with each entry representing a zone. Each zone entry has a list of ninety-six 15 minute intervals that are in order from 00:00 to 24:00. The first entry is for 00:00-00:15, the second is for 00:15-00:30, so on and so forth until 23:45-24:00.

get /site

get /site/id

get /site/name

get /site/revisions/current

get /site/revisions/{version}

get /system/hardwareid

get /system/hardwareinfo

get /system/siteid