GET api/ZipCodeSearch/ListZipCodes?apiKey={apiKey}&zip={zip}

Documentation for 'ListZipCodes'.

Request Information

Parameters

Name	Description	Additional information
apiKey	Documentation for 'apiKey'.	Define this parameter in the request URI.
zip	Documentation for 'zip'.	Define this parameter in the request URI.

Response Information

Response body formats

application/json, text/json

Sample:

{
  "IsSuccessful": true,
  "ErrorMessage": "sample string 2",
  "Results": [
    {
      "Sequence": 1,
      "Country": "sample string 2",
      "CountryCode": "sample string 3",
      "PostalCode": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "TimeZone": "sample string 7"
    },
    {
      "Sequence": 1,
      "Country": "sample string 2",
      "CountryCode": "sample string 3",
      "PostalCode": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "TimeZone": "sample string 7"
    },
    {
      "Sequence": 1,
      "Country": "sample string 2",
      "CountryCode": "sample string 3",
      "PostalCode": "sample string 4",
      "City": "sample string 5",
      "State": "sample string 6",
      "TimeZone": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<ZipCodeSearchResponseResult xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <IsSuccessful>true</IsSuccessful>
  <ErrorMessage>sample string 2</ErrorMessage>
  <Results>
    <ZipCodeSearchResponse>
      <Sequence>1</Sequence>
      <Country>sample string 2</Country>
      <CountryCode>sample string 3</CountryCode>
      <PostalCode>sample string 4</PostalCode>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <TimeZone>sample string 7</TimeZone>
    </ZipCodeSearchResponse>
    <ZipCodeSearchResponse>
      <Sequence>1</Sequence>
      <Country>sample string 2</Country>
      <CountryCode>sample string 3</CountryCode>
      <PostalCode>sample string 4</PostalCode>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <TimeZone>sample string 7</TimeZone>
    </ZipCodeSearchResponse>
    <ZipCodeSearchResponse>
      <Sequence>1</Sequence>
      <Country>sample string 2</Country>
      <CountryCode>sample string 3</CountryCode>
      <PostalCode>sample string 4</PostalCode>
      <City>sample string 5</City>
      <State>sample string 6</State>
      <TimeZone>sample string 7</TimeZone>
    </ZipCodeSearchResponse>
  </Results>
</ZipCodeSearchResponseResult>