REST API

The REST API is provided by the honeybee service.

iris/
├── api/
├── gif/
├── img/
├── lut/
└── tfon/

Public Resources: iris/

These are JSON arrays, fetched using http GET requests:

• camera_pub Camera locations and configuration
• detector_pub Vehicle detectors
• dms_message DMS messages and status
• dms_pub DMS locations and configuration
• incident Active incidents
• rwis Public weather sensor data
• sign_message Active DMS sign messages
• station_sample Vehicle detector station data
• system_attribute_pub Public system attributes
• TPIMS_archive Truck parking archive data
• TPIMS_dynamic Truck parking dynamic data
• TPIMS_static Truck parking static data

Restricted Resources: iris/api/

• login Authentication endpoint — POST iris/api/login with a JSON object containing username and password values. A session cookie is created for subsequent restricted requests. GET iris/api/login returns a JSON string containing the authenticated user's name.
• access Access permissions — GET iris/api/access returns a JSON array of permission records associated with the authenticated user's role.
• notify Notification endpoint — POST iris/api/notify with a JSON array containing channels of interest. To get notifications for a single object, append $name to the channel name. Using SSE, a client can receive notifications by sending a GET iris/api/notify request, with EventSource.

These resources can be accessed using standard http methods. Access is restricted by session authentication and permission authorization.

• GET iris/api/{type}: Get a JSON array of all objects of {type}, with only primary attributes — those needed for searching and displaying compact cards. The response also contains an ETag header, derived from the file's modified metadata, encoded in hexadecimal.
• GET iris/api/{type}/{name}: Get a single object as JSON, with primary and secondary attributes
• POST iris/api/{type}: Create a new object of the {type}. Body contains required attributes as JSON
• PATCH iris/api/{type}/{name}: Update attributes of one object, with JSON
• DELETE iris/api/{type}/{name}: Delete one object

A Content-Type: application/json header is included where appropriate.

Resource Types

Most devices also have an associated geo loc resource.

Graphics: iris/gif/

These are static graphics which can be used in sign messages.

Sign Images: iris/img/

These are public GIF images of active sign messages from iris/sign_message. They are rendered to appear as the entire face of a sign, with multi-page messages as animated GIFs.

Lookup Tables: iris/lut/

These are static resources which may only change on IRIS updates:

• beacon_state Beacon states
• comm_protocol Communication protocols
• condition Controller conditions
• direction Travel directions
• encoding Video encodings
• gate_arm_interlock Gate arm interlocks
• gate_arm_state Gate arm states
• inc_impact Incident impacts
• inc_range Incident range
• lane_code Lane codes
• lcs_indication LCS indications
• meter_algorithm Ramp metering algorithms
• meter_queue_state Ramp meter queue states
• meter_type Ramp meter types
• r_node_transition R_Node transitions
• r_node_type R_Node types
• resource_type Resource types available in iris/api/
• road_class Road classes
• road_modifier Road modifiers

Fonts: iris/tfon/

These are static fonts which can be used in sign messages.