GET api/ZipCode?zipCode={zipCode}&key={key}

Search for a zip code and return city and state.

Request Information

URI Parameters

Name	Description	Type	Additional information
zipCode	zip code to search for	string	Required
key	zip-codes.com api key	string	Required

Body Parameters

None.

Response Information

Resource Description

ZipCodeDto

Name	Description	Type	Additional information
City		string	None.
County		string	None.
State		string	None.
CityAliasList		CityAliases	None.
Error	If Error has a value then the api call failed.	string	None.

Response Formats

application/json, text/json

Sample:

{
  "City": "sample string 1",
  "County": "sample string 2",
  "State": "sample string 3",
  "CityAliasList": {
    "Item": [
      {
        "MixedCaseAlias": "sample string 1"
      },
      {
        "MixedCaseAlias": "sample string 1"
      }
    ]
  },
  "Error": "sample string 4"
}

text/javascript

Sample:

{"City":"sample string 1","County":"sample string 2","State":"sample string 3","CityAliasList":{"Item":[{"MixedCaseAlias":"sample string 1"},{"MixedCaseAlias":"sample string 1"}]},"Error":"sample string 4"}

application/xml, text/xml

Sample:

<ZipCode xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ccx.Xrm.ZipCodes.Controllers">
  <City>sample string 1</City>
  <CityAliasList>
    <Item>
      <Item>
        <MixedCaseAlias>sample string 1</MixedCaseAlias>
      </Item>
      <Item>
        <MixedCaseAlias>sample string 1</MixedCaseAlias>
      </Item>
    </Item>
  </CityAliasList>
  <County>sample string 2</County>
  <Error>sample string 4</Error>
  <State>sample string 3</State>
</ZipCode>