{"openapi":"3.1.0","info":{"title":"Apizie","version":"2.0.0","description":"One API key, one envelope, many public data sources."},"servers":[{"url":"https://www.apizie.tech"}],"security":[{"ApiKeyAuth":[]}],"paths":{"/v1/open-data:gov-bc-ca-open511/get-areas":{"get":{"operationId":"open_data_gov_bc_ca_open511_get_areas","summary":"Lists the geographical areas (e.g. districts) that can be used to filter events.","description":"GET /areas","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format of the response","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:gov-bc-ca-open511/get-events":{"get":{"operationId":"open_data_gov_bc_ca_open511_get_events","summary":"Lists road events","description":"GET /events","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format of the response","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the response"}},{"name":"status","in":"query","required":false,"description":"Limits the response to events having a given status.","schema":{"type":"string","enum":["ALL","ACTIVE","ARCHIVED"],"default":"ALL","description":"Limits the response to events having a given status."}},{"name":"severity","in":"query","required":false,"description":"Limits the response to events tagged with one of the listed severity values. The possible values are: [MINOR, MODERATE, MAJOR]. Multiple…","schema":{"type":"string","default":"MAJOR","description":"Limits the response to events tagged with one of the listed severity values. The possible values are: [MINOR, MODERATE, MAJOR]. Multiple…"}},{"name":"jurisdiction","in":"query","required":false,"description":"Limits the response to events reported by a given jurisdiction. The value given must be specified as the ID of a jurisdiction returned by…","schema":{"type":"string","default":"drivebc.ca","description":"Limits the response to events reported by a given jurisdiction. The value given must be specified as the ID of a jurisdiction returned by…"}},{"name":"event_type","in":"query","required":false,"description":"Limits the response to events tagged with one of the listed event types. The possible values include: [CONSTRUCTION, INCIDENT,…","schema":{"type":"string","enum":["CONSTRUCTION","SPECIAL_EVENT","INCIDENT","WEATHER_CONDITION","ROAD_CONDITION"],"default":"INCIDENT","description":"Limits the response to events tagged with one of the listed event types. The possible values include: [CONSTRUCTION, INCIDENT,…"}},{"name":"created","in":"query","required":false,"description":"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…","schema":{"type":"string","default":">2015-09-01T12:00:00Z","description":"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…"}},{"name":"updated","in":"query","required":false,"description":"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…","schema":{"type":"string","default":">2015-09-01T12:00:00Z","description":"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…"}},{"name":"road_name","in":"query","required":false,"description":"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…","schema":{"type":"string","default":"Highway 99","description":"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…"}},{"name":"area_id","in":"query","required":false,"description":"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…","schema":{"type":"string","default":"drivebc.ca/1","description":"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…"}},{"name":"bbox","in":"query","required":false,"description":"Limits the response to events that fall within the specified geographical bounding box. The bbox format must be '[min longitude],[min…","schema":{"type":"string","default":"-130,48,-116,60","description":"Limits the response to events that fall within the specified geographical bounding box. The bbox format must be '[min longitude],[min…"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:gov-bc-ca-open511/get-jurisdiction":{"get":{"operationId":"open_data_gov_bc_ca_open511_get_jurisdiction","summary":"Lists the jurisdictions publishing data through this Open511 API implementation","description":"GET /jurisdiction","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format of the response","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}},"/v1/open-data:gov-bc-ca-open511/get-jurisdictiongeography":{"get":{"operationId":"open_data_gov_bc_ca_open511_get_jurisdictiongeography","summary":"Provides the geographical boundaries for all the jurisdictions.","description":"GET /jurisdictiongeography","tags":["open-data"],"parameters":[{"name":"format","in":"query","required":false,"description":"The format of the response","schema":{"type":"string","enum":["json","xml"],"default":"json","description":"The format of the response"}}],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RunEnvelope"}}}},"4XX":{"$ref":"#/components/responses/Error"},"5XX":{"$ref":"#/components/responses/Error"}},"x-apizie-cache-ttl":60,"x-apizie-min-plan":null,"x-apizie-bulk":true,"x-apizie-status":"live"}}},"components":{"securitySchemes":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key"}},"schemas":{"RunEnvelope":{"type":"object","required":["project","data","timestamp"],"properties":{"project":{"type":"string","example":"dev-tools:hash"},"data":{},"timestamp":{"type":"string","format":"date-time"}}},"ErrorEnvelope":{"type":"object","properties":{"content":{},"message":{"type":"string"},"errors":{"type":"array","items":{}},"error":{"type":"object","properties":{"code":{"type":"string"},"message":{"type":"string"}}}}}},"responses":{"Error":{"description":"Invalid key, plan gate, rate limit or upstream failure","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorEnvelope"}}}}}}}