BSXZipCodeLookup


Click here for a complete list of operations.

GetRecordByZipXml

This method call will return an XML string containing the city name and type, county name and state abbreviation for a given zip code. City types include: D - Default, A - Alias and N - Not Used

Test

The test form is only available for requests from the local machine.

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /ZipCodeLookup/BSXZipCodeLookup.asmx HTTP/1.1
Host: api.brookssystems.com
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://brookssystems.com/zipcodesvc/GetRecordByZipXml"

<?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:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRecordByZipXml xmlns="http://brookssystems.com/zipcodesvc">
      <zip>string</zip>
    </GetRecordByZipXml>
  </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:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetRecordByZipXmlResponse xmlns="http://brookssystems.com/zipcodesvc">
      <GetRecordByZipXmlResult>string</GetRecordByZipXmlResult>
    </GetRecordByZipXmlResponse>
  </soap:Body>
</soap:Envelope>

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /ZipCodeLookup/BSXZipCodeLookup.asmx HTTP/1.1
Host: api.brookssystems.com
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRecordByZipXml xmlns="http://brookssystems.com/zipcodesvc">
      <zip>string</zip>
    </GetRecordByZipXml>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetRecordByZipXmlResponse xmlns="http://brookssystems.com/zipcodesvc">
      <GetRecordByZipXmlResult>string</GetRecordByZipXmlResult>
    </GetRecordByZipXmlResponse>
  </soap12:Body>
</soap12:Envelope>