@lap v0.3
# Machine-readable API spec. Each @endpoint block is one API call.
@api City of Surrey Open511 API
@base http://data.surrey.ca/open511
@version 0.1
@endpoints 4
@toc events(1), jurisdiction(1), jurisdictiongeography(1), areas(1)

@group events
@endpoint GET /events
@desc Provides real time traffic obstruction events.  The event resource provides information about road events (constructions, special events, etc.).
@optional {format: any # The format of the response, status: any # Limits the response to events having a given status., severity: any # Limits the response to events tagged with one of the listed severity values. The possible values are: [MINOR, MODERATE,MAJOR]. Multiple values may be listed, and should be separated by a comma. The default is to return events of any severity., jurisdiction: any # Limits the response to events reported by a given jurisdiction. The value given must be specified as the ID of a jurisdiction returned by the /jurisdiction resource. The default is to return events from all jurisdictions., event_type: any # Limits the response to events tagged with one of the listed event types. The possible values include: [CONSTRUCTION, INCIDENT, SPECIAL_EVENT, WEATHER_CONDITION]. Multiple values may be listed, and should be separated by a comma. The default is to return events of all types., created: any # Limits the response to events based on the date and time that the event was created (first recorded). The date/time must be specified in ISO 8601 format, and may be prefixed by one of the following operators [<, <=, >, >=] to indicate 'before', 'before or equal to', 'after' or 'after or equal to' respectively. For example, >2013-12-01T12:00:00Z requests all events create after Dec. 1, 2015 at 12pm (noon) Coordinated Universal Time. The default is to return events with any creation time., updated: any # Limits the response to events based on the date and time that the event was last updated. The date/time must be specified in ISO 8601 format, and may be prefixed by one of the following operators [<, <=, >, >=] to indicate 'before', 'before or equal to', 'after' or 'after or equal to' respectively. For example, >2013-12-01T12:00:00Z requests all events updated after Dec. 1, 2015 at 12pm (noon) Coordinated Universal Time. The default is to return events with any update time, road_name: any # Limits the response to events on a given road as specified by the road name. An example of a valid road name is 'Highway 1'. The default is to return events on all roads., area_id: any # Limits the response to events within one of the specified areas. An area must be specified as the ID of an item returned by the /areas resource. For example: an area_id of 'drivebc.ca/1' limits events to those within the Lower Mainland District. The default is to return events in all areas., bbox: any # Limits the response to events that fall within the specified geographical bounding box. The bbox format must be '[min longitude],[min latitude],[max longitude],[max latitude]' with WGS84 coordinates. For example: -123.45,48.99,-122.45,49.49. The default is to return events in all geographical locations.}
@returns(200) List of packages

@endgroup

@group jurisdiction
@endpoint GET /jurisdiction
@desc Lists the jurisdictions publishing data through this Open511 API implementation.
@optional {format: any # The format of the response}
@returns(200) List of packages

@endgroup

@group jurisdictiongeography
@endpoint GET /jurisdictiongeography
@desc Provides the geographical boundaries for all the jurisdictions.
@optional {format: any # The format of the response}
@returns(200) List of packages

@endgroup

@group areas
@endpoint GET /areas
@desc Provides the geographical boundaries for all the jurisdictions.
@optional {format: any # The format of the response}
@returns(200) List of packages

@endgroup

@end