Methods
Method detail for: getGeoListByCity
This request requires you to submit a city and two-letter State abbreviation. The API will return a list of IDs for all objects of the selected type within that city/state.
Valid Datasets
| Dataset | Dataset Details | Method Parameters |
|---|---|---|
| Maponics College Campus Boundaries | Click To View | Click To View |
When calling this dataset using this method, use these parameters:
(Note: Items marked with * are required) | ||
| Carrier Routes | Click To View | Click To View |
| Maponics Destination & Venue Boundaries | Click To View | Click To View |
| Maponics Neighborhood Boundaries North America | Click To View | Click To View |
| Maponics +Residential Boundaries | Click To View | Click To View |
| Maponics Shopping Boundaries | Click To View | Click To View |
| ZIP Codes | Click To View | Click To View |
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>Z</dataset>
<method>getGeoListByCity</method>
<returnType>xml</returnType>
<returnGeoType>wkt</returnGeoType>
<parameters>
<state>NY</state>
<city>New York</city>
</parameters>
</request>
</data>
{
"data":{
"auth":{
"loginname":"your_username",
"key":"your_api_key"
},
"request":[
{
"dataset":"Z",
"method":"getGeoListByCity",
"returnType":"json",
"parameters":{
"state":"NY",
"city":"New York"
}
}
]
}
}
<?xml version="1.0" encoding="UTF-8" ?>
<data>
<resultcode>0</resultcode>
<message>Return OK</message>
<requestid>01-11328529</requestid>
<request>
<item>
<zip>10020</zip>
</item>
<item>
<zip>10110</zip>
</item>
<item>
<zip>10120</zip>
</item>
...
<item>
<zip>10006</zip>
</item>
<item>
<zip>10001</zip>
</item>
<item>
<zip>13417</zip>
</item>
</request>
</data>
[
{
"resultcode":0,
"message":"Return OK",
"requestid":"03-14472",
"request":[
[
{
"zip":"12417"
},
{
"zip":"10024"
},
{
"zip":"11010"
}...{
"zip":"13638"
},
{
"zip":"13664"
},
{
"zip":"13665"
}
]
]
}
]
