GET api/ZipCodeSearch/Detail?apiKey={apiKey}&zip={zip}&countryCode={countryCode}&city={city}

Documentation for 'Detail'.

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.
countryCode	Documentation for 'countryCode'.	Define this parameter in the request URI.
city	Documentation for 'city'.	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,
      "PostalCode": "sample string 2",
      "State": "sample string 3",
      "City": "sample string 4",
      "Country": "sample string 5",
      "CountryCode": "sample string 6",
      "AreaCode": 1,
      "StateFIPS": 1,
      "CountryFIPS": 1,
      "PlaceFIPS": 1,
      "MSACode": 1,
      "TimeZone": "sample string 7",
      "TimeZoneAbbreviation": "sample string 8",
      "DST": "sample string 9",
      "ZIPType": "sample string 10"
    },
    {
      "Sequence": 1,
      "PostalCode": "sample string 2",
      "State": "sample string 3",
      "City": "sample string 4",
      "Country": "sample string 5",
      "CountryCode": "sample string 6",
      "AreaCode": 1,
      "StateFIPS": 1,
      "CountryFIPS": 1,
      "PlaceFIPS": 1,
      "MSACode": 1,
      "TimeZone": "sample string 7",
      "TimeZoneAbbreviation": "sample string 8",
      "DST": "sample string 9",
      "ZIPType": "sample string 10"
    },
    {
      "Sequence": 1,
      "PostalCode": "sample string 2",
      "State": "sample string 3",
      "City": "sample string 4",
      "Country": "sample string 5",
      "CountryCode": "sample string 6",
      "AreaCode": 1,
      "StateFIPS": 1,
      "CountryFIPS": 1,
      "PlaceFIPS": 1,
      "MSACode": 1,
      "TimeZone": "sample string 7",
      "TimeZoneAbbreviation": "sample string 8",
      "DST": "sample string 9",
      "ZIPType": "sample string 10"
    }
  ]
}

application/xml, text/xml

Sample:

<ZipCodeSearchResponseDetailResult 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>
    <ZipCodeSearchResponseDetail>
      <Sequence>1</Sequence>
      <PostalCode>sample string 2</PostalCode>
      <State>sample string 3</State>
      <City>sample string 4</City>
      <Country>sample string 5</Country>
      <CountryCode>sample string 6</CountryCode>
      <AreaCode>1</AreaCode>
      <StateFIPS>1</StateFIPS>
      <CountryFIPS>1</CountryFIPS>
      <PlaceFIPS>1</PlaceFIPS>
      <MSACode>1</MSACode>
      <TimeZone>sample string 7</TimeZone>
      <TimeZoneAbbreviation>sample string 8</TimeZoneAbbreviation>
      <DST>sample string 9</DST>
      <ZIPType>sample string 10</ZIPType>
    </ZipCodeSearchResponseDetail>
    <ZipCodeSearchResponseDetail>
      <Sequence>1</Sequence>
      <PostalCode>sample string 2</PostalCode>
      <State>sample string 3</State>
      <City>sample string 4</City>
      <Country>sample string 5</Country>
      <CountryCode>sample string 6</CountryCode>
      <AreaCode>1</AreaCode>
      <StateFIPS>1</StateFIPS>
      <CountryFIPS>1</CountryFIPS>
      <PlaceFIPS>1</PlaceFIPS>
      <MSACode>1</MSACode>
      <TimeZone>sample string 7</TimeZone>
      <TimeZoneAbbreviation>sample string 8</TimeZoneAbbreviation>
      <DST>sample string 9</DST>
      <ZIPType>sample string 10</ZIPType>
    </ZipCodeSearchResponseDetail>
    <ZipCodeSearchResponseDetail>
      <Sequence>1</Sequence>
      <PostalCode>sample string 2</PostalCode>
      <State>sample string 3</State>
      <City>sample string 4</City>
      <Country>sample string 5</Country>
      <CountryCode>sample string 6</CountryCode>
      <AreaCode>1</AreaCode>
      <StateFIPS>1</StateFIPS>
      <CountryFIPS>1</CountryFIPS>
      <PlaceFIPS>1</PlaceFIPS>
      <MSACode>1</MSACode>
      <TimeZone>sample string 7</TimeZone>
      <TimeZoneAbbreviation>sample string 8</TimeZoneAbbreviation>
      <DST>sample string 9</DST>
      <ZIPType>sample string 10</ZIPType>
    </ZipCodeSearchResponseDetail>
  </Results>
</ZipCodeSearchResponseDetailResult>