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.

GetPlacesInside

Returns a list of geo places inside a given zip code. Parameters: zip - 5 digit zip code or Canadian postal code (M3H, M3H 6A7), state - 2 letter state code (not required for zip codes).

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

<?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>
  </soap:Header>
  <soap:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:GetPlacesInside>
      <zip xsi:type="xsd:string">string</zip>
    </tns:GetPlacesInside>
  </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:Body soap:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
    <tns:GetPlacesInsideResponse>
      <GetPlacesInsideResult href="#id1" />
    </tns:GetPlacesInsideResponse>
    <soapenc:Array id="id1" soapenc:arrayType="tns:GeoPlaceDistance[2]">
      <Item href="#id2" />
      <Item href="#id3" />
    </soapenc:Array>
    <tns:GeoPlaceDistance id="id2" xsi:type="tns:GeoPlaceDistance">
      <ToPlace xsi:type="xsd:string">string</ToPlace>
      <ToState xsi:type="xsd:string">string</ToState>
      <Distance xsi:type="xsd:float">float</Distance>
    </tns:GeoPlaceDistance>
    <tns:GeoPlaceDistance id="id3" xsi:type="tns:GeoPlaceDistance">
      <ToPlace xsi:type="xsd:string">string</ToPlace>
      <ToState xsi:type="xsd:string">string</ToState>
      <Distance xsi:type="xsd:float">float</Distance>
    </tns:GeoPlaceDistance>
  </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/GetPlacesInside?zip=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"?>
<ArrayOfGeoPlaceDistance xmlns="http://skats.net/services/literalTypes">
  <GeoPlaceDistance>
    <ToPlace>string</ToPlace>
    <ToState>string</ToState>
    <Distance>float</Distance>
  </GeoPlaceDistance>
  <GeoPlaceDistance>
    <ToPlace>string</ToPlace>
    <ToState>string</ToState>
    <Distance>float</Distance>
  </GeoPlaceDistance>
</ArrayOfGeoPlaceDistance>

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

zip=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfGeoPlaceDistance xmlns="http://skats.net/services/literalTypes">
  <GeoPlaceDistance>
    <ToPlace>string</ToPlace>
    <ToState>string</ToState>
    <Distance>float</Distance>
  </GeoPlaceDistance>
  <GeoPlaceDistance>
    <ToPlace>string</ToPlace>
    <ToState>string</ToState>
    <Distance>float</Distance>
  </GeoPlaceDistance>
</ArrayOfGeoPlaceDistance>

Parameter	Value
AuthenticationHeader:
zip: