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.

GetUserPlacesWithin

Returns a list of user-defined places within a specified distance from a given place. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), state - 2 letter state code (not required for zip codes), distance - distance in miles, category - an optional category, if not empy only user-defined places that match the category will be returned.

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

Parameter	Value
AuthenticationHeader:
zip:
distance:
category:

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/GetUserPlacesWithin"

<?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:GetUserPlacesWithin>
      <zip xsi:type="xsd:string">string</zip>
      <distance xsi:type="xsd:float">float</distance>
      <category xsi:type="xsd:string">string</category>
    </tns:GetUserPlacesWithin>
  </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:GetUserPlacesWithinResponse>
      <GetUserPlacesWithinResult href="#id1" />
    </tns:GetUserPlacesWithinResponse>
    <soapenc:Array id="id1" soapenc:arrayType="tns:UserPlaceDetail[2]">
      <Item href="#id2" />
      <Item href="#id3" />
    </soapenc:Array>
    <tns:UserPlaceDetail id="id2" xsi:type="tns:UserPlaceDetail">
      <Id xsi:type="xsd:int">int</Id>
      <Name xsi:type="xsd:string">string</Name>
      <Address xsi:type="xsd:string">string</Address>
      <City xsi:type="xsd:string">string</City>
      <State xsi:type="xsd:string">string</State>
      <ZipCode xsi:type="xsd:string">string</ZipCode>
      <Category xsi:type="xsd:string">string</Category>
      <Data xsi:type="xsd:string">string</Data>
      <LatDegrees xsi:type="xsd:float">float</LatDegrees>
      <LonDegrees xsi:type="xsd:float">float</LonDegrees>
      <LatRadians xsi:type="xsd:float">float</LatRadians>
      <LonRadians xsi:type="xsd:float">float</LonRadians>
      <Distance xsi:type="xsd:float">float</Distance>
      <Country xsi:type="xsd:string">string</Country>
    </tns:UserPlaceDetail>
    <tns:UserPlaceDetail id="id3" xsi:type="tns:UserPlaceDetail">
      <Id xsi:type="xsd:int">int</Id>
      <Name xsi:type="xsd:string">string</Name>
      <Address xsi:type="xsd:string">string</Address>
      <City xsi:type="xsd:string">string</City>
      <State xsi:type="xsd:string">string</State>
      <ZipCode xsi:type="xsd:string">string</ZipCode>
      <Category xsi:type="xsd:string">string</Category>
      <Data xsi:type="xsd:string">string</Data>
      <LatDegrees xsi:type="xsd:float">float</LatDegrees>
      <LonDegrees xsi:type="xsd:float">float</LonDegrees>
      <LatRadians xsi:type="xsd:float">float</LatRadians>
      <LonRadians xsi:type="xsd:float">float</LonRadians>
      <Distance xsi:type="xsd:float">float</Distance>
      <Country xsi:type="xsd:string">string</Country>
    </tns:UserPlaceDetail>
  </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/GetUserPlacesWithin?zip=string&distance=string&category=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"?>
<ArrayOfUserPlaceDetail xmlns="http://skats.net/services/literalTypes">
  <UserPlaceDetail>
    <Id>int</Id>
    <Name>string</Name>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <ZipCode>string</ZipCode>
    <Category>string</Category>
    <Data>string</Data>
    <LatDegrees>float</LatDegrees>
    <LonDegrees>float</LonDegrees>
    <LatRadians>float</LatRadians>
    <LonRadians>float</LonRadians>
    <Distance>float</Distance>
    <Country>string</Country>
  </UserPlaceDetail>
  <UserPlaceDetail>
    <Id>int</Id>
    <Name>string</Name>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <ZipCode>string</ZipCode>
    <Category>string</Category>
    <Data>string</Data>
    <LatDegrees>float</LatDegrees>
    <LonDegrees>float</LonDegrees>
    <LatRadians>float</LatRadians>
    <LonRadians>float</LonRadians>
    <Distance>float</Distance>
    <Country>string</Country>
  </UserPlaceDetail>
</ArrayOfUserPlaceDetail>

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/GetUserPlacesWithin HTTP/1.1
Host: api.geosvc.com
Content-Type: application/x-www-form-urlencoded
Content-Length: length

zip=string&distance=string&category=string

HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfUserPlaceDetail xmlns="http://skats.net/services/literalTypes">
  <UserPlaceDetail>
    <Id>int</Id>
    <Name>string</Name>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <ZipCode>string</ZipCode>
    <Category>string</Category>
    <Data>string</Data>
    <LatDegrees>float</LatDegrees>
    <LonDegrees>float</LonDegrees>
    <LatRadians>float</LatRadians>
    <LonRadians>float</LonRadians>
    <Distance>float</Distance>
    <Country>string</Country>
  </UserPlaceDetail>
  <UserPlaceDetail>
    <Id>int</Id>
    <Name>string</Name>
    <Address>string</Address>
    <City>string</City>
    <State>string</State>
    <ZipCode>string</ZipCode>
    <Category>string</Category>
    <Data>string</Data>
    <LatDegrees>float</LatDegrees>
    <LonDegrees>float</LonDegrees>
    <LatRadians>float</LatRadians>
    <LonRadians>float</LonRadians>
    <Distance>float</Distance>
    <Country>string</Country>
  </UserPlaceDetail>
</ArrayOfUserPlaceDetail>