{
"uuid": "7f16b70e-b673-477c-8c16-d371504d2a06",
"lastMigration": 29,
"name": "Geocoder REST API",
"endpointPrefix": "",
"latency": 0,
"port": 3000,
"hostname": "",
"routes": [
{
"uuid": "d513b0da-1f0e-442a-9a56-f76516592020",
"documentation": "Geocode an address",
"method": "get",
"endpoint": "addresses.:outputFormat",
"responses": [
{
"uuid": "56538861-56e1-45b3-8178-e808d784fdb0",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of matching sites or intersections and their physical locations. See addresses response",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "a7eb484a-ce75-4171-96da-b94ed4bebc1c",
"documentation": "Find intersections near to a geographic point",
"method": "get",
"endpoint": "intersections/near.:outputFormat",
"responses": [
{
"uuid": "988e92c7-c01a-4a8d-bf9c-6957ca0adf02",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of selected intersections near a given point. Each intersection is in Intersection Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "5ce918c5-9f74-4942-985d-b6af9de93053",
"documentation": "Find nearest intersection to a geographic point",
"method": "get",
"endpoint": "intersections/nearest.:outputFormat",
"responses": [
{
"uuid": "5b91826a-a144-4bb2-8f83-aeed336715fc",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "The nearest intersection in Intersection Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "011c8b40-24fc-436a-963d-e2da98bde6f0",
"documentation": "Find intersections in a geographic area",
"method": "get",
"endpoint": "intersections/within.:outputFormat",
"responses": [
{
"uuid": "bb287e41-d8a3-4065-8f8e-c6ea9538ec58",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of selected intersections within the given area. Each intersection is in Each intersection is in Intersection Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "194ed436-d017-410c-92d6-9ae8584dfa89",
"documentation": "Get an intersection by its unique ID",
"method": "get",
"endpoint": "intersections/:intersectionID.:outputFormat",
"responses": [
{
"uuid": "82acaf08-aeed-4837-a3cc-3196643d7ff4",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "The Intersection with the requested intersectionID in Intersection Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "2e95a9fb-dd2b-46c9-8600-a00816e08878",
"documentation": "Geocode an address and identify site occupants",
"method": "get",
"endpoint": "occupants/addresses.:outputFormat",
"responses": [
{
"uuid": "55e7a056-4228-4a9b-95e3-e2787a3f16b7",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of matching occupants, sites, and their physical locations. Response document will contain one About Query Representation and one Site Address Representation plus Occupant Representation for each matching occupant.",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "b19d76ee-fe3b-461d-95cc-7b806b6b67e5",
"documentation": "Find occupants of sites near to a geographic point",
"method": "get",
"endpoint": "occupants/near.:outputFormat",
"responses": [
{
"uuid": "a3e81883-a53b-4042-b998-b549418465da",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of selected occupants that are near a given point in order of closest to farther. Each occupant is returned as a Site Address Representation plus a Occupant Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "698a8039-f966-4324-a4dd-30d6fc6d5a44",
"documentation": "Find occupants of the site nearest to a geographic point",
"method": "get",
"endpoint": "occupants/nearest.:outputFormat",
"responses": [
{
"uuid": "4fc27d3f-2c05-4250-a05c-435e8fb564f7",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "The nearest occupant in Site Address Representation plus Occupant Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "0b1c8eac-5045-448f-bf78-c9bcb8adabc2",
"documentation": "Find occupants of sites in a geographic area",
"method": "get",
"endpoint": "occupants/within.:outputFormat",
"responses": [
{
"uuid": "0de31059-1e9d-4949-a7b8-56f51cf2aee1",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of selected occupants within the given area. Each occupant is returned in a Site Address Representation plus Occupant Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "3a5971c0-879f-4d7f-9d6b-957726432201",
"documentation": "Get an occupant (of a site) by its unique ID",
"method": "get",
"endpoint": "occupants/:occupantID.:outputFormat",
"responses": [
{
"uuid": "1a813458-1250-4e84-a7b9-82d28d48843d",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "The occupant with the requested occupantID in Site Address Representation plus Occupant Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "ef1807df-f97e-4c9b-8f95-0e6c08bf45ac",
"documentation": "Get a comma-separated string of all pids for a given site",
"method": "get",
"endpoint": "parcels/pids/:siteID.:outputFormat",
"responses": [
{
"uuid": "8192b63c-4a4d-4ff1-94e8-6cdb2401e270",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A comma-separated string containing all the parcel identifiers associated with the requested siteID",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "a6093a12-b1f3-4124-9164-e55d1fe9959a",
"documentation": "Find sites near to a geographic point",
"method": "get",
"endpoint": "sites/near.:outputFormat",
"responses": [
{
"uuid": "3b1776b0-af6c-43b7-b087-307ffe259319",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "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 Site Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "272f1950-a009-441b-b69b-bbfa3ece4390",
"documentation": "Find the site nearest to a geographic point",
"method": "get",
"endpoint": "sites/nearest.:outputFormat",
"responses": [
{
"uuid": "ba8acd6b-5d18-4a3e-b110-1b67d05c74f3",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "The nearest site in Site Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "0b0f600d-4dfe-4b43-be25-c4e2e80aa2b2",
"documentation": "Find sites in a geographic area",
"method": "get",
"endpoint": "sites/within.:outputFormat",
"responses": [
{
"uuid": "c8bece02-c58e-4f2c-b837-c510965ed416",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "A list of selected sites within a given area. Each site in the response document is structured as a Site Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "f59adb69-c0e5-4e8c-b29f-66e7599ad6ce",
"documentation": "Get a site by its unique ID",
"method": "get",
"endpoint": "sites/:siteID.:outputFormat",
"responses": [
{
"uuid": "e3cc483d-22c6-4ba6-acbb-369d9ff56657",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "The site with the requested siteID in Site Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
},
{
"uuid": "0e30b931-5f6f-4769-81c2-a56604047608",
"documentation": "Represents all subsites of a given site",
"method": "get",
"endpoint": "sites/:siteID/subsites.:outputFormat",
"responses": [
{
"uuid": "ad60cd07-c19a-4c4a-bd36-06e4ca0c1087",
"body": "",
"latency": 0,
"statusCode": 200,
"label": "Returns all subsites of a given site in Site Address Representation",
"headers": [{ "key": "Content-Type", "value": "application/json" }],
"bodyType": "INLINE",
"filePath": "",
"databucketID": "",
"sendFileAsBody": false,
"rules": [],
"rulesOperator": "OR",
"disableTemplating": false,
"fallbackTo404": false,
"default": true,
"crudKey": "id"
}
],
"enabled": true,
"responseMode": null,
"type": "http"
}
],
"proxyMode": false,
"proxyHost": "",
"proxyRemovePrefix": false,
"tlsOptions": {
"enabled": false,
"type": "CERT",
"pfxPath": "",
"certPath": "",
"keyPath": "",
"caPath": "",
"passphrase": ""
},
"cors": true,
"headers": [],
"proxyReqHeaders": [{ "key": "", "value": "" }],
"proxyResHeaders": [{ "key": "", "value": "" }],
"data": [],
"folders": [],
"rootChildren": [
{ "type": "route", "uuid": "d513b0da-1f0e-442a-9a56-f76516592020" },
{ "type": "route", "uuid": "a7eb484a-ce75-4171-96da-b94ed4bebc1c" },
{ "type": "route", "uuid": "5ce918c5-9f74-4942-985d-b6af9de93053" },
{ "type": "route", "uuid": "011c8b40-24fc-436a-963d-e2da98bde6f0" },
{ "type": "route", "uuid": "194ed436-d017-410c-92d6-9ae8584dfa89" },
{ "type": "route", "uuid": "2e95a9fb-dd2b-46c9-8600-a00816e08878" },
{ "type": "route", "uuid": "b19d76ee-fe3b-461d-95cc-7b806b6b67e5" },
{ "type": "route", "uuid": "698a8039-f966-4324-a4dd-30d6fc6d5a44" },
{ "type": "route", "uuid": "0b1c8eac-5045-448f-bf78-c9bcb8adabc2" },
{ "type": "route", "uuid": "3a5971c0-879f-4d7f-9d6b-957726432201" },
{ "type": "route", "uuid": "ef1807df-f97e-4c9b-8f95-0e6c08bf45ac" },
{ "type": "route", "uuid": "a6093a12-b1f3-4124-9164-e55d1fe9959a" },
{ "type": "route", "uuid": "272f1950-a009-441b-b69b-bbfa3ece4390" },
{ "type": "route", "uuid": "0b0f600d-4dfe-4b43-be25-c4e2e80aa2b2" },
{ "type": "route", "uuid": "f59adb69-c0e5-4e8c-b29f-66e7599ad6ce" },
{ "type": "route", "uuid": "0e30b931-5f6f-4769-81c2-a56604047608" }
]
}