LocationUIHelper Web Service

LocationUIHelper

Click here for a complete list of operations.

PostalCodeToCityState

Test

To test the operation using the HTTP POST protocol, click the 'Invoke' button.

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 /api/LocationUIHelper.asmx HTTP/1.1
Host: forms.nebraskafamilyalliance.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "http://LocationUiHelper.bisglobal.net/PostalCodeToCityState"

<?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>
    <PostalCodeToCityState xmlns="http://LocationUiHelper.bisglobal.net/">
      <postalCode>string</postalCode>
    </PostalCodeToCityState>
  </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>
    <PostalCodeToCityStateResponse xmlns="http://LocationUiHelper.bisglobal.net/">
      <PostalCodeToCityStateResult>
        <City>string</City>
        <State>
          <State_id>int</State_id>
          <StateName>string</StateName>
          <StateAbbreviation>string</StateAbbreviation>
          <Country>
            <Country_id>int</Country_id>
            <CountryName>string</CountryName>
            <CountryCode>string</CountryCode>
            <CountryAlias>string</CountryAlias>
            <Continent xsi:nil="true" />
            <Active>boolean</Active>
          </Country>
          <Active>boolean</Active>
        </State>
      </PostalCodeToCityStateResult>
    </PostalCodeToCityStateResponse>
  </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 /api/LocationUIHelper.asmx HTTP/1.1
Host: forms.nebraskafamilyalliance.org
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>
    <PostalCodeToCityState xmlns="http://LocationUiHelper.bisglobal.net/">
      <postalCode>string</postalCode>
    </PostalCodeToCityState>
  </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>
    <PostalCodeToCityStateResponse xmlns="http://LocationUiHelper.bisglobal.net/">
      <PostalCodeToCityStateResult>
        <City>string</City>
        <State>
          <State_id>int</State_id>
          <StateName>string</StateName>
          <StateAbbreviation>string</StateAbbreviation>
          <Country>
            <Country_id>int</Country_id>
            <CountryName>string</CountryName>
            <CountryCode>string</CountryCode>
            <CountryAlias>string</CountryAlias>
            <Continent xsi:nil="true" />
            <Active>boolean</Active>
          </Country>
          <Active>boolean</Active>
        </State>
      </PostalCodeToCityStateResult>
    </PostalCodeToCityStateResponse>
  </soap12:Body>
</soap12:Envelope>

HTTP GET

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

GET /api/LocationUIHelper.asmx/PostalCodeToCityState?postalCode=string HTTP/1.1
Host: forms.nebraskafamilyalliance.org

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

<?xml version="1.0" encoding="utf-8"?>
<LocationUIHelperResponse xmlns="http://LocationUiHelper.bisglobal.net/">
  <City>string</City>
  <State>
    <State_id>int</State_id>
    <StateName>string</StateName>
    <StateAbbreviation>string</StateAbbreviation>
    <Country>
      <Country_id>int</Country_id>
      <CountryName>string</CountryName>
      <CountryCode>string</CountryCode>
      <CountryAlias>string</CountryAlias>
      <Continent>
        <Continent_id>int</Continent_id>
        <ContinentName>string</ContinentName>
        <ContinentCode>string</ContinentCode>
      </Continent>
      <Active>boolean</Active>
    </Country>
    <Active>boolean</Active>
  </State>
</LocationUIHelperResponse>

HTTP POST

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

POST /api/LocationUIHelper.asmx/PostalCodeToCityState HTTP/1.1
Host: forms.nebraskafamilyalliance.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

postalCode=string

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

<?xml version="1.0" encoding="utf-8"?>
<LocationUIHelperResponse xmlns="http://LocationUiHelper.bisglobal.net/">
  <City>string</City>
  <State>
    <State_id>int</State_id>
    <StateName>string</StateName>
    <StateAbbreviation>string</StateAbbreviation>
    <Country>
      <Country_id>int</Country_id>
      <CountryName>string</CountryName>
      <CountryCode>string</CountryCode>
      <CountryAlias>string</CountryAlias>
      <Continent>
        <Continent_id>int</Continent_id>
        <ContinentName>string</ContinentName>
        <ContinentCode>string</ContinentCode>
      </Continent>
      <Active>boolean</Active>
    </Country>
    <Active>boolean</Active>
  </State>
</LocationUIHelperResponse>

Parameter	Value
postalCode: