Methods

Method detail for: getGeoListByPoly

This request requires you to submit a WKT-formatted polygon (with SRID). The API will spatially determine the number of objects that are wholly or partially within that area and return their IDs. You may also specify which type of spatial search is performed (INTERSECT/WITHIN). The method defaults to WITHIN.

Valid Datasets

DatasetDataset DetailsMethod Parameters
Maponics College Campus BoundariesClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Carrier RoutesClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Carrier Route CentroidsClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Maponics City PointsClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Maponics Neighborhood Centroids North AmericaClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Zip +4 PointsClick To ViewClick To View

When calling this dataset using this method, use these parameters:

ZIP Code CentroidsClick To ViewClick To View

When calling this dataset using this method, use these parameters:

Sample Request and Return Data

<?xml version="1.0" encoding="UTF-8" ?> <data> <auth> <loginname>your_username</loginname> <key>your_api_key</key> </auth> <request> <dataset>Z4</dataset> <method>getGeoListByPoly</method> <returnType>xml</returnType> <parameters> <geom>SRID=4326;MULTIPOLYGON(((-74.011683 40.719734,-74.00000 40.719734,-74.00000 40.713734, -74.011683 40.713734, -74.011683 40.719734)))</geom> </parameters> </request> </data>
{ "data":{ "auth":{ "loginname":"your_username", "key":"your_api_key" }, "request":[ { "dataset":"Z4", "method":"getGeoListByPoly", "returnType":"json", "parameters":{ "geom":"SRID=4326;MULTIPOLYGON(((-74.011683 40.719734,-74.00000 40.719734,-74.00000 40.713734, -74.011683 40.713734, -74.011683 40.719734)))" } } ] } }
<?xml version="1.0" encoding="UTF-8" ?> <data> <resultcode>0</resultcode> <message>Return OK</message> <requestid>01-11333997</requestid> <request> <item> <z9>100070016</z9> </item> <item> <z9>100071100</z9> </item> <item> <z9>100071102</z9> </item> ... <item> <z9>100134015</z9> </item> <item> <z9>100134044</z9> </item> <item> <z9>100134313</z9> </item> </request> </data>
[ { "resultcode":0, "message":"Return OK", "requestid":"01-11333973", "request":[ [ { "z9":"100070016" }, { "z9":"100071100" }, { "z9":"100071102" }, ..., { "z9":"100134044" }, { "z9":"100134313" } ] ] } ]