Overview

The CLV GIS Public API provides programmatic access to the CLV GIS spatial database. This API enables developers to build web and mobile apps that provide users with an ever increasing repository of publicly available GIS datasets. All responses are available in JSON.

Feedback

If you find any issues with the API, please click here to contact us. We are actively listening to all of your feedback. We look forward to working with you and can’t wait to see what you create.

Disclaimer

GIS maps and data are normally produced only to meet the needs of the City. Due to continuous development activity these maps and data are for reference only.

TITLE - The name of your API call; also add additional information about your API call here such as a description. Try to use verbs that match both request type (fetching vs modifying) and plurality (one vs multiple).

VERSION - Using semantic versioning (see semver.org)

URL - The URL Structure (path only, no root URL); for example, /users or /users/:id or /users?id=:id

METHOD - The request type - 'GET' | 'POST' | 'DELETE' | 'PUT'

URL PARAMS - If URL params exist, specify them in accordance with name mentioned in URL section. Separate into optional and required., for example:
Required
field=value

Optional
field=value

DATA PARAMS - If making a post request, what should the body payload look like? Include data constraints. URL Params rules apply here also. For example
{
  u : {
    email : [string],
    name : [string],
    current_password : [alphanumeric],
    password : [alphanumeric],
    password_confirmation : [alphanumeric]
  }
}

SUCCESS RESPONSE - What should the status code be on success and is there any returned data? This is useful when people need to to know what their callbacks should expect. For example:
{
   Code: <integer>,
   Content: { JSON }
}

ERROR RESPONSE - Most endpoints will have many ways they can fail. From unauthorized access, to wrongful parameters etc. All of those should be listed here. It might seem repetitive, but it helps prevent assumptions from being made where they should be.
{
   Code: <integer>,
   Content: { JSON }
}

EXAMPLE REQUEST -
https :// <URL>?PARAMS

EXAMPLE RESULT - 
   {
      "field": "value"
   }
]

NOTES -
STARDATE 21YYYYMMMDDHHMMSS: This is where all uncertainties, commentary, discussion etc. can go. Recommend comments be time stamping and identified by user so they can be followed up on to ensure concerns are addressed.