@datafire/surrey_ca_open511

Client library for City of Surrey Open511 API

Installation and Usage

npm install --save @datafire/surrey_ca_open511

let surrey_ca_open511 = require('@datafire/surrey_ca_open511').create();

.then(data => {
  console.log(data);
});

Description

This API provides real time traffic obstruction events occuring within the City of Surrey.

Actions

areas.get

Provides the geographical boundaries for all the jurisdictions.

surrey_ca_open511.areas.get({}, context)

Input

• input object
  • format string: The format of the response

Output

Output schema unknown

events.get

Provides real time traffic obstruction events. The event resource provides information about road events (constructions, special events, etc.).

surrey_ca_open511.events.get({}, context)

Input

• input object
  • format string: The format of the response
  • status string: Limits the response to events having a given status.
  • severity string: 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 string: 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 string: 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 string: 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 string: 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 string: 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 string: 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 string: 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.

Output

Output schema unknown

jurisdiction.get

Lists the jurisdictions publishing data through this Open511 API implementation.

surrey_ca_open511.jurisdiction.get({}, context)

Input

• input object
  • format string: The format of the response

Output

Output schema unknown

jurisdictiongeography.get

Provides the geographical boundaries for all the jurisdictions.

surrey_ca_open511.jurisdictiongeography.get({}, context)

Input

• input object
  • format string: The format of the response

Output

Output schema unknown

Definitions

This integration has no definitions