ZipCodes Web Service 
NOTE: This is auto-generated web service description page.
For more information see Subscribe
Documentation
Contact
The service requires a subscription. There're several plans available including a free subscription.
Click here for a complete list of operations.
GetZipCodesWithinFiltered
Returns a list of zip codes within a specified distance from a given zip code. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), distance - distance in miles, filter - string to filter results, filterType - type of filter (StartsWith, EndsWith, Anywhere, None).
Test
To test the operation using the HTTP POST protocol, click the 'Invoke' button.
SOAP 1.1
(show / hide)
The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.
POST /geosvc_api/ZipCodeLookup.asmx HTTP/1.1
Host: api.geosvc.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://skats.net/services/GetZipCodesWithinFiltered"
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://skats.net/services/" xmlns:types="http://skats.net/services/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<tns:AuthenticationHeader>
<SessionID xsi:type="xsd:string">string</SessionID>
</tns:AuthenticationHeader>
<tns:Pager>
<Cursor xsi:type="xsd:string">string</Cursor>
<TotalCount xsi:type="xsd:int">int</TotalCount>
</tns:Pager>
</soap:Header>
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<tns:GetZipCodesWithinFiltered>
<zip xsi:type="xsd:string">string</zip>
<distance xsi:type="xsd:float">float</distance>
<filter xsi:type="xsd:string">string</filter>
<filterType xsi:type="tns:FilterType">None or StartsWith or EndsWith or Anywhere</filterType>
</tns:GetZipCodesWithinFiltered>
</soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soapenc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:tns="http://skats.net/services/" xmlns:types="http://skats.net/services/encodedTypes" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Header>
<tns:Pager>
<Cursor xsi:type="xsd:string">string</Cursor>
<TotalCount xsi:type="xsd:int">int</TotalCount>
</tns:Pager>
</soap:Header>
<soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
<tns:GetZipCodesWithinFilteredResponse>
<GetZipCodesWithinFilteredResult href="#id1" />
</tns:GetZipCodesWithinFilteredResponse>
<soapenc:Array id="id1" soapenc:arrayType="tns:ZipCodeDistances[2]">
<Item href="#id2" />
<Item href="#id3" />
</soapenc:Array>
<tns:ZipCodeDistances id="id2" xsi:type="tns:ZipCodeDistances">
<ZipCode xsi:type="xsd:string">string</ZipCode>
<Distance xsi:type="xsd:float">float</Distance>
</tns:ZipCodeDistances>
<tns:ZipCodeDistances id="id3" xsi:type="tns:ZipCodeDistances">
<ZipCode xsi:type="xsd:string">string</ZipCode>
<Distance xsi:type="xsd:float">float</Distance>
</tns:ZipCodeDistances>
</soap:Body>
</soap:Envelope>
HTTP GET
(show / hide)
The following is a sample HTTP GET request and response. The placeholders shown need to be replaced with actual values.
GET /geosvc_api/ZipCodeLookup.asmx/GetZipCodesWithinFiltered?zip=string&distance=string&filter=string&filterType=string HTTP/1.1
Host: api.geosvc.com
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfZipCodeDistances xmlns="http://skats.net/services/literalTypes">
<ZipCodeDistances>
<ZipCode>string</ZipCode>
<Distance>float</Distance>
</ZipCodeDistances>
<ZipCodeDistances>
<ZipCode>string</ZipCode>
<Distance>float</Distance>
</ZipCodeDistances>
</ArrayOfZipCodeDistances>
HTTP POST
(show / hide)
The following is a sample HTTP POST request and response. The placeholders shown need to be replaced with actual values.
POST /geosvc_api/ZipCodeLookup.asmx/GetZipCodesWithinFiltered HTTP/1.1
Host: api.geosvc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length
zip=string&distance=string&filter=string&filterType=string
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfZipCodeDistances xmlns="http://skats.net/services/literalTypes">
<ZipCodeDistances>
<ZipCode>string</ZipCode>
<Distance>float</Distance>
</ZipCodeDistances>
<ZipCodeDistances>
<ZipCode>string</ZipCode>
<Distance>float</Distance>
</ZipCodeDistances>
</ArrayOfZipCodeDistances>