{"_id":"54605cba809c100800b23516","is_link":false,"project":"5446bf21ae0040140035fa39","version":{"_id":"5446bf21ae0040140035fa3c","project":"5446bf21ae0040140035fa39","__v":15,"createdAt":"2014-10-21T20:16:33.426Z","releaseDate":"2014-10-21T20:16:33.426Z","categories":["5446bf21ae0040140035fa3d","545ecdc45c79e60800a9078d","545ecdd8d986c40800e44af3","545ecdf8d986c40800e44af4","545ece065c79e60800a9078f","545ece0cd986c40800e44af5","545ece13d986c40800e44af6","545ece195c79e60800a90790","545eced2d986c40800e44afa","545eced95c79e60800a90792","545eceded986c40800e44afb","545ecee4d986c40800e44afc","545ecee9d986c40800e44afd","545eceedd986c40800e44afe","545ecef2d986c40800e44b00"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"user":"5446beccae0040140035fa37","category":{"_id":"545eced95c79e60800a90792","__v":2,"project":"5446bf21ae0040140035fa39","version":"5446bf21ae0040140035fa3c","pages":["54605cba809c100800b23516","54605cf0809c100800b2351c"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-09T02:18:01.360Z","from_sync":false,"order":1,"slug":"clearances","title":"Clearances"},"__v":0,"editedParams":true,"editedParams2":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-11-10T06:35:38.737Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{\n  \"clearances\": [\n    {\n      \"zone\": {\n        \"id\": 3435, \n        \"slug\": \"conservation-overlay\", \n        \"name\": \"Conservation Overlay\", \n        \"display_name\": \"CON - Conservation Overlay\", \n        \"description\": \"\", \n        \"municipal_code_url\": nil, \n        \"code\": \"CON\", \n        \"overlay\": true\n      },\n      \"permission\": {\n        \"id\": 68,\n        \"slug\": \"prohibited\",\n        \"code\": \"NP\",\n        \"name\": \"Prohibited\",\n        \"type\": \"Permission::Prohibited\",\n        \"description\": \"Prohibited means that your planned use is either specifically disallowed in this zoning district, or that the code is \\\"silent.\\\" The best next step for you to take is to call the Planning Office.\",\n        \"municipal_code_url\": \"\"\n      }\n    }\n  ]\n}","name":""},{"status":404,"language":"json","code":"{\n  \"status\": \"404\",\n  \"error\": \"Not Found\"\n}","name":""},{"status":500,"code":"{\n  \"status\": \"500\", \n  \"error\": \"Internal Server Error\"\n}","language":"json"}]},"settings":"","examples":{"codes":[]},"try":false,"basic_auth":false,"auth":"never","params":[{"_id":"54605cba809c100800b2351b","ref":"","in":"query","required":false,"desc":"","default":"required","type":"string","name":"jurisdiction"},{"_id":"54605cba809c100800b2351a","ref":"","in":"query","required":false,"desc":"","default":"","type":"string","name":"id"},{"_id":"54605cba809c100800b23519","ref":"","in":"query","required":false,"desc":"","default":"","type":"array_mixed","name":"permission"},{"_id":"54605cba809c100800b23518","ref":"","in":"query","required":false,"desc":"","default":"","type":"object","name":"use"},{"_id":"54605cba809c100800b23517","ref":"","in":"query","required":false,"desc":"","default":"","type":"object","name":"zone"}],"url":"/clearances.json"},"isReference":false,"order":0,"body":"[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"http://santa-cruz.zoning.io/en/api/1.0/clearances.json?use[slug]=bakery\",\n      \"language\": \"text\"\n    }\n  ]\n}\n[/block]","excerpt":"This endpoint returns all of the clearances for a given land use code across all zoning districts.","slug":"clearances","type":"endpoint","title":"/clearances"}

get/clearances

This endpoint returns all of the clearances for a given land use code across all zoning districts.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Query Params

jurisdiction:
stringrequired
id:
string
permission:
array of mixed
use:
object
zone:
object

Result Format


Documentation

[block:code] { "codes": [ { "code": "http://santa-cruz.zoning.io/en/api/1.0/clearances.json?use[slug]=bakery", "language": "text" } ] } [/block]

User Information

Try It Out

get
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}