Last active
February 3, 2017 22:10
-
-
Save ll911/31f80430d525a9c09e30 to your computer and use it in GitHub Desktop.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| { | |
| "swagger": "2.0", | |
| "info": { | |
| "title": "Geocoder REST API", | |
| "description": "This API computes the physical locations (i.e., latitude and longitude) and correct, standardized forms of civic and non-civic addresses in British Columbia. Please see our <a href=https://github.com/bcgov/api-specs/blob/master/COLLECTION_NOTICE.md#collection-notice target=\"_blank\">data collection notice</a>", | |
| "version": "2.0.0", | |
| "license": { | |
| "name": "Open Government License - British Columbia", | |
| "url": "http://www2.gov.bc.ca/gov/content/governments/about-the-bc-government/databc/open-data/open-government-license-bc" | |
| }, | |
| "termsOfService": "http://www2.gov.bc.ca/gov/content/governments/about-the-bc-government/databc/open-data/api-terms-of-use-for-ogl-information", | |
| "contact": { | |
| "name": "DataBC", | |
| "url": "https://forms.gov.bc.ca/databc-contact-us/", | |
| "email": "DataBCBA@gov.bc.ca" | |
| } | |
| }, | |
| "externalDocs": { | |
| "description": "Physical Address Geocoder Web Site", | |
| "url": "http://www2.gov.bc.ca/gov/content/governments/about-the-bc-government/databc/geographic-data-and-services/geocoder" | |
| }, | |
| "tags": [ | |
| { | |
| "name": "sites" | |
| }, | |
| { | |
| "name": "intersections" | |
| }, | |
| { | |
| "name": "occupants" | |
| } | |
| ], | |
| "host": "apps.gov.bc.ca", | |
| "basePath": "/pub/geocoder", | |
| "schemes": [ | |
| "http", | |
| "https" | |
| ], | |
| "produces": [ | |
| "application/json", | |
| "application/vnd.geo+json", | |
| "application/vnd.google-earth.kml+xml", | |
| "application/xhtml+xml", | |
| "application/gml+xml", | |
| "text/csv", | |
| "application/zip" | |
| ], | |
| "paths": { | |
| "/addresses.{outputFormat}": { | |
| "get": { | |
| "summary": "Geocoding an Address", | |
| "description": "Represents the set of geocoded and standardized sites and intersections whose address best matches a given query address.", | |
| "tags": [ | |
| "sites", | |
| "intersections" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "addressString", | |
| "in": "query", | |
| "description": "Examples: 525 Superior Street, Victoria, BC<br>301-780 Blanshard St, Victoria, BC<br>Johnson St and Government St, Victoria, BC.<br> Civic or intersection address as a single string. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#addressString target=\"_blank\">addressString</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "interpolation", | |
| "in": "query", | |
| "description": "accessPoint interpolation method. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#interpolation target=\"_blank\">interpolation</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "adaptive", | |
| "enum": [ | |
| "adaptive", | |
| "linear", | |
| "none" | |
| ] | |
| }, | |
| { | |
| "name": "echo", | |
| "in": "query", | |
| "description": "If true, include unmatched address details such as site name in results.", | |
| "type": "boolean", | |
| "required": false, | |
| "default": true | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "minScore", | |
| "in": "query", | |
| "description": "The minimum score required for a match to be returned. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#minScore target=\"_blank\">minScore</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "matchPrecision", | |
| "in": "query", | |
| "description": "Example: street,locality. A comma separated list of individual match precision levels to include in results. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#matchPrecision target=\"_blank\">matchPrecision</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "matchPrecisionNot", | |
| "in": "query", | |
| "description": "Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#matchPrecisionNot target=\"_blank\">matchPrecisionNot</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "siteName", | |
| "in": "query", | |
| "description": "A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#siteName target=\"_blank\">siteName</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "unitDesignator", | |
| "in": "query", | |
| "description": "The type of unit within a house or building. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#unitDesignator target=\"_blank\">unitDesignator</a>", | |
| "type": "string", | |
| "required": false, | |
| "enum": [ | |
| "APT", | |
| "BLDG", | |
| "BSMT", | |
| "FLR", | |
| "LOBBY", | |
| "LWR", | |
| "PAD", | |
| "PH", | |
| "REAR", | |
| "RM", | |
| "SIDE", | |
| "SITE", | |
| "SUITE", | |
| "TH", | |
| "UNIT", | |
| "UPPR" | |
| ] | |
| }, | |
| { | |
| "name": "unitNumber", | |
| "in": "query", | |
| "description": "The number of the unit, suite, or apartment within a house or building.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "unitNumberSuffix", | |
| "in": "query", | |
| "description": "A letter that follows the unit number as in Unit 1A or Suite 302B.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "civicNumber", | |
| "in": "query", | |
| "description": "The official number assigned to a site by an address authority. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#civicNumber target=\"_blank\">civicNumber</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "civicNumberSuffix", | |
| "in": "query", | |
| "description": "A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#civicNumberSuffix target=\"_blank\">civicNumberSuffix</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "streetName", | |
| "in": "query", | |
| "description": "The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetName target=\"_blank\">streetName</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "streetType", | |
| "in": "query", | |
| "description": "The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetType target=\"_blank\">streetType</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "streetDirection", | |
| "in": "query", | |
| "description": "The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetDirection target=\"_blank\">streetDirection</a>", | |
| "type": "string", | |
| "required": false, | |
| "enum": [ | |
| "N", | |
| "S", | |
| "E", | |
| "W", | |
| "O", | |
| "NE", | |
| "NO", | |
| "NW", | |
| "SE", | |
| "SO", | |
| "SW" | |
| ] | |
| }, | |
| { | |
| "name": "streetQualifier", | |
| "in": "query", | |
| "description": "Example: the Bridge in Johnson St Bridge. The qualifier of a street name. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetQualifier target=\"_blank\">streetQualifier</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "localityName", | |
| "in": "query", | |
| "description": "The name of the locality assigned to a given site by an address authority. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#localityName target=\"_blank\">localityName</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "provinceCode", | |
| "in": "query", | |
| "description": "The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.", | |
| "type": "string", | |
| "required": false, | |
| "default": "BC" | |
| }, | |
| { | |
| "name": "localities", | |
| "in": "query", | |
| "description": "A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "notLocalities", | |
| "in": "query", | |
| "description": "A comma-separated list of localities to exclude from the search.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "bbox", | |
| "in": "query", | |
| "description": "Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#bbox target=\"_blank\">bbox</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "centre", | |
| "in": "query", | |
| "description": "Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#centre target='_blank'>centre</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "number", | |
| "required": false | |
| }, | |
| { | |
| "name": "extrapolate", | |
| "in": "query", | |
| "description": "If true, uses supplied parcelPoint to derive an appropriate accessPoint. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#extrapolate target=\"_blank\">extrapolate</a>", | |
| "type": "boolean", | |
| "required": false | |
| }, | |
| { | |
| "name": "parcelPoint", | |
| "in": "query", | |
| "description": "The coordinates of a point (x,y) known to be inside the parcel containing a given address. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#parcelPoint target=\"_blank\">parcelPoint</a>", | |
| "type": "string", | |
| "required": false | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of matching sites or intersections and their physical locations. See <a href='https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#resource-representations-in-http-responses' target=\"_blank\">addresses response</a>", | |
| "schema": { | |
| "type": "object", | |
| "properties": { | |
| "queryAddress": { | |
| "type": "string" | |
| }, | |
| "searchTimestamp": { | |
| "type": "string" | |
| }, | |
| "executionTime": { | |
| "type": "number" | |
| }, | |
| "version": { | |
| "type": "string" | |
| }, | |
| "srsCode": { | |
| "type": "integer" | |
| }, | |
| "echo": { | |
| "type": "string" | |
| }, | |
| "interpolation": { | |
| "type": "string" | |
| }, | |
| "locationDescriptor": { | |
| "type": "string" | |
| }, | |
| "setBack": { | |
| "type": "integer" | |
| }, | |
| "minScore": { | |
| "type": "integer" | |
| }, | |
| "maxResults": { | |
| "type": "integer" | |
| }, | |
| "disclaimer": { | |
| "type": "string" | |
| }, | |
| "privacyStatement": { | |
| "type": "string" | |
| }, | |
| "copyrightNotice": { | |
| "type": "string" | |
| }, | |
| "copyrightLicense": { | |
| "type": "string" | |
| }, | |
| "type": { | |
| "type": "string" | |
| }, | |
| "crs": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "object", | |
| "properties": { | |
| "code": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "features": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "geometry": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "crs": { | |
| "type": "object", | |
| "properties": { | |
| "type": { | |
| "type": "string" | |
| }, | |
| "properties": { | |
| "type": "object", | |
| "properties": { | |
| "code": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "coordinates": { | |
| "type": "array", | |
| "items": { | |
| "type": "number" | |
| } | |
| } | |
| } | |
| }, | |
| "properties": { | |
| "type": "object", | |
| "properties": { | |
| "fullAddress": { | |
| "type": "string" | |
| }, | |
| "score": { | |
| "type": "integer" | |
| }, | |
| "matchPrecision": { | |
| "type": "string" | |
| }, | |
| "precisionPoints": { | |
| "type": "integer" | |
| }, | |
| "faults": { | |
| "type": "array", | |
| "items": { | |
| "type": "object", | |
| "properties": { | |
| "element": { | |
| "type": "string" | |
| }, | |
| "fault": { | |
| "type": "string" | |
| }, | |
| "penalty": { | |
| "type": "integer" | |
| } | |
| } | |
| } | |
| }, | |
| "siteName": { | |
| "type": "string" | |
| }, | |
| "unitDesignator": { | |
| "type": "string" | |
| }, | |
| "unitNumber": { | |
| "type": "string" | |
| }, | |
| "unitNumberSuffix": { | |
| "type": "string" | |
| }, | |
| "civicNumber": { | |
| "type": "integer" | |
| }, | |
| "civicNumberSuffix": { | |
| "type": "string" | |
| }, | |
| "streetName": { | |
| "type": "string" | |
| }, | |
| "streetType": { | |
| "type": "string" | |
| }, | |
| "isStreetTypePrefix": { | |
| "type": "string" | |
| }, | |
| "streetDirection": { | |
| "type": "string" | |
| }, | |
| "isStreetDirectionPrefix": { | |
| "type": "string" | |
| }, | |
| "streetQualifier": { | |
| "type": "string" | |
| }, | |
| "localityName": { | |
| "type": "string" | |
| }, | |
| "localityType": { | |
| "type": "string" | |
| }, | |
| "provinceCode": { | |
| "type": "string" | |
| }, | |
| "locationPositionalAccuracy": { | |
| "type": "string" | |
| }, | |
| "locationDescriptor": { | |
| "type": "string" | |
| }, | |
| "siteID": { | |
| "type": "string" | |
| }, | |
| "blockID": { | |
| "type": "integer" | |
| }, | |
| "fullSiteDescriptor": { | |
| "type": "string" | |
| }, | |
| "narrativeLocation": { | |
| "type": "string" | |
| }, | |
| "accessNotes": { | |
| "type": "string" | |
| }, | |
| "siteStatus": { | |
| "type": "string" | |
| }, | |
| "siteRetireDate": { | |
| "type": "string" | |
| }, | |
| "changeDate": { | |
| "type": "string" | |
| }, | |
| "isPrimary": { | |
| "type": "boolean" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } | |
| }, | |
| "examples": { | |
| "application/json": { | |
| "queryAddress": "553 superior st, victoria, BC, Canada", | |
| "searchTimestamp": "2016-05-04 14:20:37.792", | |
| "executionTime": 1.992, | |
| "version": "2.0.1", | |
| "srsCode": 4326, | |
| "echo": "true", | |
| "interpolation": "adaptive", | |
| "locationDescriptor": "any", | |
| "setBack": 0, | |
| "minScore": 0, | |
| "maxResults": 1, | |
| "disclaimer": "http://www2.gov.bc.ca/gov/admin/disclaimer.page", | |
| "privacyStatement": "http://www2.gov.bc.ca/gov/admin/privacy.page", | |
| "copyrightNotice": "Copyright 2015 Province of British Columbia - Open Government License", | |
| "copyrightLicense": "http://www.data.gov.bc.ca/local/dbc/docs/license/OGL-vbc2.0.pdf", | |
| "type": "FeatureCollection", | |
| "crs": { | |
| "type": "EPSG", | |
| "properties": { | |
| "code": 4326 | |
| } | |
| }, | |
| "features": [ | |
| { | |
| "type": "Feature", | |
| "geometry": { | |
| "type": "Point", | |
| "crs": { | |
| "type": "EPSG", | |
| "properties": { | |
| "code": 4326 | |
| } | |
| }, | |
| "coordinates": [ | |
| -123.3708884, | |
| 48.4180898 | |
| ] | |
| }, | |
| "properties": { | |
| "fullAddress": "553 Superior St, Victoria, BC", | |
| "score": 66, | |
| "matchPrecision": "BLOCK", | |
| "precisionPoints": 99, | |
| "faults": [ | |
| { | |
| "element": "UNRECOGNIZED", | |
| "fault": "notAllowed", | |
| "penalty": 33 | |
| } | |
| ], | |
| "siteName": "", | |
| "unitDesignator": "", | |
| "unitNumber": "", | |
| "unitNumberSuffix": "", | |
| "civicNumber": 553, | |
| "civicNumberSuffix": "", | |
| "streetName": "Superior", | |
| "streetType": "St", | |
| "isStreetTypePrefix": "false", | |
| "streetDirection": "", | |
| "isStreetDirectionPrefix": "", | |
| "streetQualifier": "", | |
| "localityName": "Victoria", | |
| "localityType": "City", | |
| "provinceCode": "BC", | |
| "locationPositionalAccuracy": "low", | |
| "locationDescriptor": "accessPoint", | |
| "siteID": "", | |
| "blockID": 296337, | |
| "fullSiteDescriptor": "", | |
| "narrativeLocation": "", | |
| "accessNotes": "", | |
| "siteStatus": "", | |
| "siteRetireDate": "", | |
| "changeDate": "", | |
| "isPrimary": true | |
| } | |
| } | |
| ] | |
| } | |
| } | |
| }, | |
| "400": { | |
| "description": "Bad request" | |
| } | |
| } | |
| } | |
| }, | |
| "/occupants/addresses.{outputFormat}": { | |
| "get": { | |
| "description": "Represents the set of occupants whose addresses best match a given query address. Every occupant has an associated site which has a standardized address and a coordinate location on the Earth.", | |
| "tags": [ | |
| "occupants" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "addressString", | |
| "in": "query", | |
| "description": "Examples: Redfish Elementary --<br>Redfish Elementary -- Balfour<br>Redfish Elementary School -- 265 Bryan Rd, Balfour, BC<br>Occupant name followed by a frontGate delimiter ('--') followed by an optional address", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "description": "Example: schools;courts;employment<br>A list of tags separated by semicolons.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "interpolation", | |
| "in": "query", | |
| "description": "accessPoint interpolation method. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#interpolation target=\"_blank\">interpolation</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "adaptive", | |
| "enum": [ | |
| "adaptive", | |
| "linear", | |
| "none" | |
| ] | |
| }, | |
| { | |
| "name": "echo", | |
| "in": "query", | |
| "description": "If true, include unmatched address details such as site name in results.", | |
| "type": "boolean", | |
| "default": false | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "minScore", | |
| "in": "query", | |
| "description": "The minimum score required for a match to be returned. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#minScore target=\"_blank\">minScore</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "matchPrecision", | |
| "in": "query", | |
| "description": "Example: street,locality. A comma separated list of individual match precision levels to include in results. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#matchPrecision target=\"_blank\">matchPrecision</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "OCCUPANT" | |
| }, | |
| { | |
| "name": "matchPrecisionNot", | |
| "in": "query", | |
| "description": "Example: street,locality. A comma separated list of individual match precision levels to exclude from results. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#matchPrecisionNot target=\"_blank\">matchPrecisionNot</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "siteName", | |
| "in": "query", | |
| "description": "A string containing the name of the building, facility, or institution (e.g., Duck Building, Casa Del Mar, Crystal Garden, Bluebird House).See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#siteName target=\"_blank\">siteName</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "unitDesignator", | |
| "in": "query", | |
| "description": "The type of unit within a house or building. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#unitDesignator target=\"_blank\">unitDesignator</a>", | |
| "type": "string", | |
| "required": false, | |
| "enum": [ | |
| "APT", | |
| "BLDG", | |
| "BSMT", | |
| "FLR", | |
| "LOBBY", | |
| "LWR", | |
| "PAD", | |
| "PH", | |
| "REAR", | |
| "RM", | |
| "SIDE", | |
| "SITE", | |
| "SUITE", | |
| "TH", | |
| "UNIT", | |
| "UPPR" | |
| ] | |
| }, | |
| { | |
| "name": "unitNumber", | |
| "in": "query", | |
| "description": "The number of the unit, suite, or apartment within a house or building.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "unitNumberSuffix", | |
| "in": "query", | |
| "description": "A letter that follows the unit number as in Unit 1A or Suite 302B.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "civicNumber", | |
| "in": "query", | |
| "description": "The official number assigned to a site by an address authority. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#civicNumber target=\"_blank\">civicNumber</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "civicNumberSuffix", | |
| "in": "query", | |
| "description": "A letter or fraction that follows the civic number (e.g., the A in 1039A Bledsoe St). See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#civicNumberSuffix target=\"_blank\">civicNumberSuffix</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "streetName", | |
| "in": "query", | |
| "description": "The official name of the street as assigned by an address authority (e.g., the Douglas in 1175 Douglas Street). See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetName target=\"_blank\">streetName</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "streetType", | |
| "in": "query", | |
| "description": "The type of street as assigned by a municipality (e.g., the ST in 1175 DOUGLAS St). See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetType target=\"_blank\">streetType</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "streetDirection", | |
| "in": "query", | |
| "description": "The abbreviated compass direction as defined by Canada Post and B.C. civic addressing authorities. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetDirection target=\"_blank\">streetDirection</a>", | |
| "type": "string", | |
| "required": false, | |
| "enum": [ | |
| "N", | |
| "S", | |
| "E", | |
| "W", | |
| "O", | |
| "NE", | |
| "NO", | |
| "NW", | |
| "SE", | |
| "SO", | |
| "SW" | |
| ] | |
| }, | |
| { | |
| "name": "streetQualifier", | |
| "in": "query", | |
| "description": "The qualifier of a street name (e.g., the Bridge in Johnson St Bridge)", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "localityName", | |
| "in": "query", | |
| "description": "The name of the locality assigned to a given site by an address authority. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#streetDirection target=\"_blank\">streetDirection</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "provinceCode", | |
| "in": "query", | |
| "description": "The ISO 3166-2 Sub-Country Code. The code for British Columbia is BC.", | |
| "type": "string", | |
| "required": false, | |
| "default": "BC" | |
| }, | |
| { | |
| "name": "localities", | |
| "in": "query", | |
| "description": "A comma separated list of locality names that matched addresses must belong to. For example, setting localities to Nanaimo only returns addresses in Nanaimo", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "notLocalities", | |
| "in": "query", | |
| "description": "A comma-separated list of localities to exclude from the search.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "bbox", | |
| "in": "query", | |
| "description": "Example: -126.07929,49.7628,-126.0163,49.7907. A bounding box (xmin,ymin,xmax,ymax) that limits the search area. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#bbox target=\"_blank\">bbox</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "centre", | |
| "in": "query", | |
| "description": "Example: -124.0165926,49.2296251 . The coordinates of a centre point (x,y) used to define a bounding circle that will limit the search area. This parameter must be specified together with 'maxDistance'. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#centre target='_blank'>centre</a>", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "number", | |
| "required": false | |
| }, | |
| { | |
| "name": "extrapolate", | |
| "in": "query", | |
| "description": "If true, uses supplied parcelPoint to derive an appropriate accessPoint. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#extrapolate target=\"_blank\">extrapolate</a>", | |
| "type": "boolean", | |
| "required": false | |
| }, | |
| { | |
| "name": "parcelPoint", | |
| "in": "query", | |
| "description": "The coordinates of a point (x,y) known to be inside the parcel containing a given address. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#parcelPoint target=\"_blank\">parcelPoint</a>", | |
| "type": "string", | |
| "required": false | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of matching occupants, sites, and their physical locations. Response document will contain one <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#about-query-representation\" target=\"_blank\">About Query Representation</a> and one <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a> plus <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#occupant-representation\" target=\"_blank\">Occupant Representation</a> for each matching occupant." | |
| } | |
| } | |
| } | |
| }, | |
| "/sites/nearest.{outputFormat}": { | |
| "get": { | |
| "description": "Represents the site nearest a given point", | |
| "tags": [ | |
| "sites" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "point", | |
| "in": "query", | |
| "description": "Example: -122.377,50.121 Centre point of search. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#point target=\"_blank\">point</a>", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "integer", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| }, | |
| { | |
| "name": "excludeUnits", | |
| "in": "query", | |
| "description": "If true, excludes sites that are units of a parent site", | |
| "type": "boolean", | |
| "required": false | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The nearest site in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/occupants/nearest.{outputFormat}": { | |
| "get": { | |
| "description": "Represents the closest occupant to a given point", | |
| "tags": [ | |
| "occupants" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "point", | |
| "in": "query", | |
| "description": "Example: -122.377,50.121 The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "integer", | |
| "required": false | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "description": "Example: schools;courts;employment<br>A list of tags separated by semicolons.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The nearest occupant in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a> plus <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#occupant-representation\" target=\"_blank\">Occupant Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/intersections/nearest.{outputFormat}": { | |
| "get": { | |
| "description": "Represents the closest intersection to a given point", | |
| "tags": [ | |
| "intersections" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "point", | |
| "in": "query", | |
| "description": "Example: -122.377,50.121 The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "integer", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "minDegree", | |
| "in": "query", | |
| "description": "The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 2 | |
| }, | |
| { | |
| "name": "maxDegree", | |
| "in": "query", | |
| "description": "The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 100 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The nearest intersection in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#intersection-address-representation\" target=\"_blank\">Intersection Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/sites/near.{outputFormat}": { | |
| "get": { | |
| "description": "Represents sites near a given point in the order of closest to farthest", | |
| "tags": [ | |
| "sites" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "point", | |
| "in": "query", | |
| "description": "Example: -122.377,50.121 The point (x,y) from which the nearby sites will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "integer", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| }, | |
| { | |
| "name": "excludeUnits", | |
| "in": "query", | |
| "description": "If true, excludes sites that are units of a parent site", | |
| "type": "boolean", | |
| "required": false | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of selected sites that are near a given point in order of closest to farther. Each site in the response document is structured as a <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/occupants/near.{outputFormat}": { | |
| "get": { | |
| "description": "Represents occupants near a given point in order of closest to farthest", | |
| "tags": [ | |
| "occupants" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "point", | |
| "in": "query", | |
| "description": "Example: -122.377,50.121 The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "description": "Example: schools;courts;employment<br>A list of tags separated by semicolons.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "integer", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of selected occupants that are near a given point in order of closest to farther. Each occupant is returned as a <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a> plus a <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#occupant-representation\" target=\"_blank\">Occupant Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/intersections/near.{outputFormat}": { | |
| "get": { | |
| "description": "Represents intersections near a given point", | |
| "tags": [ | |
| "intersections" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "point", | |
| "in": "query", | |
| "description": "Example: -122.377,50.121 The point (x,y) from which the nearest site will be identified. The coordinates must be specified in the same SRS as given by the 'outputSRS' parameter.", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "maxDistance", | |
| "in": "query", | |
| "description": "The maximum distance (in metres) to search from the given point. If not specified, the search distance is unlimited.", | |
| "type": "integer", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgovapi-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": true, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "minDegree", | |
| "in": "query", | |
| "description": "The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 2 | |
| }, | |
| { | |
| "name": "maxDegree", | |
| "in": "query", | |
| "description": "The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 100 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of selected intersections near a given point. Each intersection is in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#intersection-address-representation\" target=\"_blank\">Intersection Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/sites/within.{outputFormat}": { | |
| "get": { | |
| "description": "Represents sites within a given area", | |
| "tags": [ | |
| "sites" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "bbox", | |
| "in": "query", | |
| "description": "Example: -119.51,49.48,-119.53,49.50. A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#bbox target=\"_blank\">bbox</a>", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 1 | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| }, | |
| { | |
| "name": "excludeUnits", | |
| "in": "query", | |
| "description": "If true, excludes sites that are units of a parent site", | |
| "type": "boolean", | |
| "required": false | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of selected sites within a given area. Each site in the response document is structured as a <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/occupants/within.{outputFormat}": { | |
| "get": { | |
| "description": "Represents all occupants within a given area", | |
| "tags": [ | |
| "occupants" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "bbox", | |
| "in": "query", | |
| "description": "Example: -119.51,49.48,-119.53,49.50. A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#bbox target=\"_blank\">bbox</a>", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "tags", | |
| "in": "query", | |
| "description": "Example: schools;courts;employment<br>A list of tags separated by semicolons.", | |
| "type": "string", | |
| "required": false | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgovapi-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results to return.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 200 | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of selected occupants within the given area. Each occupant is returned in a <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a> plus <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#occupant-representation\" target=\"_blank\">Occupant Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/intersections/within.{outputFormat}": { | |
| "get": { | |
| "description": "Represents all intersections within a given area", | |
| "tags": [ | |
| "intersections" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormattarget=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "bbox", | |
| "in": "query", | |
| "description": "Example: -119.51,49.48,-119.53,49.50. A bounding box (xmin,ymin,xmax,ymax) used to limit the search area. See <a href=https://github.com/bcgovapi-specs/blob/master/geocoder/glossary.md#bbox target=\"_blank\">bbox</a>", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "maxResults", | |
| "in": "query", | |
| "description": "The maximum number of search results", | |
| "type": "integer", | |
| "required": false, | |
| "default": 200 | |
| }, | |
| { | |
| "name": "minDegree", | |
| "in": "query", | |
| "description": "The minimum degree an intersection can have to be included in results. A dead-end has a degree of 1.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 2 | |
| }, | |
| { | |
| "name": "maxDegree", | |
| "in": "query", | |
| "description": "The maximum degree an interesection can have to be included in results. A four-way stop has a degree of 4.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 100 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "A list of selected intersections within the given area. Each intersection is in Each intersection is in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#intersection-address-representation\" target=\"_blank\">Intersection Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/sites/{siteID}.{outputFormat}": { | |
| "get": { | |
| "description": "Represents an individual site", | |
| "tags": [ | |
| "sites" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "siteID", | |
| "in": "path", | |
| "description": "A unique, but not immutable, site identifier.", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The site with the requested siteID in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/occupants/{occupantID}.{outputFormat}": { | |
| "get": { | |
| "description": "Represents an individual occupant", | |
| "tags": [ | |
| "occupants" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "occupantID", | |
| "in": "path", | |
| "description": "Occupant identifier", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgovapi-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| }, | |
| { | |
| "name": "locationDescriptor", | |
| "in": "query", | |
| "description": "Describes the nature of the address location. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#locationDescriptor target=\"_blank\">locationDescriptor</a>", | |
| "type": "string", | |
| "required": false, | |
| "default": "any", | |
| "enum": [ | |
| "any", | |
| "accessPoint", | |
| "frontDoorPoint", | |
| "parcelPoint", | |
| "rooftopPoint", | |
| "routingPoint" | |
| ] | |
| }, | |
| { | |
| "name": "setBack", | |
| "in": "query", | |
| "description": "The distance to move the accessPoint away from the curb and towards the inside of the parcel (in metres). Ignored if locationDescriptor not set to accessPoint.", | |
| "type": "integer", | |
| "required": false, | |
| "default": 0 | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The occupant with the requested occupantID in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#site-address-representation\" target=\"_blank\">Site Address Representation</a> plus <a href=\"https://github.com/bcgovapi-specs/blob/master/geocoder/geocoder-developer-guide.md#occupant-representation\" target=\"_blank\">Occupant Representation</a>" | |
| } | |
| } | |
| } | |
| }, | |
| "/intersections/{intersectionID}.{outputFormat}": { | |
| "get": { | |
| "description": "Represents a individual intersection", | |
| "tags": [ | |
| "intersections" | |
| ], | |
| "parameters": [ | |
| { | |
| "name": "intersectionID", | |
| "in": "path", | |
| "description": "A unique intersection identifier", | |
| "type": "string", | |
| "required": true | |
| }, | |
| { | |
| "name": "outputFormat", | |
| "in": "path", | |
| "description": "Results format. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputFormat target=\"_blank\">outputFormat</a>", | |
| "type": "string", | |
| "required": true, | |
| "default": "json", | |
| "enum": [ | |
| "json", | |
| "geojson", | |
| "xhtml", | |
| "kml", | |
| "gml", | |
| "csv", | |
| "shpz" | |
| ] | |
| }, | |
| { | |
| "name": "outputSRS", | |
| "in": "query", | |
| "description": "The EPSG code of the spatial reference system (SRS) to use for output geometries. See <a href=https://github.com/bcgov/api-specs/blob/master/geocoder/glossary.md#outputSRS target=\"_blank\">outputSRS</a>", | |
| "type": "integer", | |
| "required": false, | |
| "default": 4326, | |
| "enum": [ | |
| 4326, | |
| 4269, | |
| 3005, | |
| 26907, | |
| 26908, | |
| 26909, | |
| 26910, | |
| 26911 | |
| ] | |
| } | |
| ], | |
| "responses": { | |
| "200": { | |
| "description": "The Intersection with the requested intersectionID in <a href=\"https://github.com/bcgov/api-specs/blob/master/geocoder/geocoder-developer-guide.md#intersection-address-representation\" target=\"_blank\">Intersection Address Representation</a>" | |
| } | |
| } | |
| } | |
| } | |
| } | |
| } |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment