AIMSAddressWebService Web Service

AIMSAddressWebService

Click here for a complete list of operations.

ValidateAddressWithCity

Validates an address string plus a city, state, zip combination and returns matching records. This may give more accurate results than the ValidateAddressLine.

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 /webservices/AddressWebService2/AddressWebService.asmx HTTP/1.1
Host: ims.jocogov.org
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "https://ims.jocogov.org/webservices/ValidateAddressWithCity"

<?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>
    <ValidateAddressWithCity xmlns="https://ims.jocogov.org/webservices">
      <securityKey>string</securityKey>
      <addressLine>string</addressLine>
      <cityLine>string</cityLine>
    </ValidateAddressWithCity>
  </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>
    <ValidateAddressWithCityResponse xmlns="https://ims.jocogov.org/webservices">
      <ValidateAddressWithCityResult>
        <Address>
          <APID>string</APID>
          <StreetNumber>string</StreetNumber>
          <Predirection>string</Predirection>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <SecUnitDesignator>string</SecUnitDesignator>
          <SecUnit>string</SecUnit>
          <City>string</City>
          <County>string</County>
          <State>string</State>
          <Zipcode>string</Zipcode>
          <X>string</X>
          <Y>string</Y>
          <AddressLine>string</AddressLine>
          <CityLine>string</CityLine>
          <Lon>string</Lon>
          <Lat>string</Lat>
          <TaxPropID>string</TaxPropID>
          <GeoPropID>string</GeoPropID>
          <SourceTable>string</SourceTable>
          <Score>string</Score>
          <Validity>string</Validity>
        </Address>
        <Address>
          <APID>string</APID>
          <StreetNumber>string</StreetNumber>
          <Predirection>string</Predirection>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <SecUnitDesignator>string</SecUnitDesignator>
          <SecUnit>string</SecUnit>
          <City>string</City>
          <County>string</County>
          <State>string</State>
          <Zipcode>string</Zipcode>
          <X>string</X>
          <Y>string</Y>
          <AddressLine>string</AddressLine>
          <CityLine>string</CityLine>
          <Lon>string</Lon>
          <Lat>string</Lat>
          <TaxPropID>string</TaxPropID>
          <GeoPropID>string</GeoPropID>
          <SourceTable>string</SourceTable>
          <Score>string</Score>
          <Validity>string</Validity>
        </Address>
      </ValidateAddressWithCityResult>
    </ValidateAddressWithCityResponse>
  </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 /webservices/AddressWebService2/AddressWebService.asmx HTTP/1.1
Host: ims.jocogov.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>
    <ValidateAddressWithCity xmlns="https://ims.jocogov.org/webservices">
      <securityKey>string</securityKey>
      <addressLine>string</addressLine>
      <cityLine>string</cityLine>
    </ValidateAddressWithCity>
  </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>
    <ValidateAddressWithCityResponse xmlns="https://ims.jocogov.org/webservices">
      <ValidateAddressWithCityResult>
        <Address>
          <APID>string</APID>
          <StreetNumber>string</StreetNumber>
          <Predirection>string</Predirection>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <SecUnitDesignator>string</SecUnitDesignator>
          <SecUnit>string</SecUnit>
          <City>string</City>
          <County>string</County>
          <State>string</State>
          <Zipcode>string</Zipcode>
          <X>string</X>
          <Y>string</Y>
          <AddressLine>string</AddressLine>
          <CityLine>string</CityLine>
          <Lon>string</Lon>
          <Lat>string</Lat>
          <TaxPropID>string</TaxPropID>
          <GeoPropID>string</GeoPropID>
          <SourceTable>string</SourceTable>
          <Score>string</Score>
          <Validity>string</Validity>
        </Address>
        <Address>
          <APID>string</APID>
          <StreetNumber>string</StreetNumber>
          <Predirection>string</Predirection>
          <StreetName>string</StreetName>
          <StreetType>string</StreetType>
          <SecUnitDesignator>string</SecUnitDesignator>
          <SecUnit>string</SecUnit>
          <City>string</City>
          <County>string</County>
          <State>string</State>
          <Zipcode>string</Zipcode>
          <X>string</X>
          <Y>string</Y>
          <AddressLine>string</AddressLine>
          <CityLine>string</CityLine>
          <Lon>string</Lon>
          <Lat>string</Lat>
          <TaxPropID>string</TaxPropID>
          <GeoPropID>string</GeoPropID>
          <SourceTable>string</SourceTable>
          <Score>string</Score>
          <Validity>string</Validity>
        </Address>
      </ValidateAddressWithCityResult>
    </ValidateAddressWithCityResponse>
  </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 /webservices/AddressWebService2/AddressWebService.asmx/ValidateAddressWithCity?securityKey=string&addressLine=string&cityLine=string HTTP/1.1
Host: ims.jocogov.org

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAddress xmlns="https://ims.jocogov.org/webservices">
  <Address>
    <APID>string</APID>
    <StreetNumber>string</StreetNumber>
    <Predirection>string</Predirection>
    <StreetName>string</StreetName>
    <StreetType>string</StreetType>
    <SecUnitDesignator>string</SecUnitDesignator>
    <SecUnit>string</SecUnit>
    <City>string</City>
    <County>string</County>
    <State>string</State>
    <Zipcode>string</Zipcode>
    <X>string</X>
    <Y>string</Y>
    <AddressLine>string</AddressLine>
    <CityLine>string</CityLine>
    <Lon>string</Lon>
    <Lat>string</Lat>
    <TaxPropID>string</TaxPropID>
    <GeoPropID>string</GeoPropID>
    <SourceTable>string</SourceTable>
    <Score>string</Score>
    <Validity>string</Validity>
  </Address>
  <Address>
    <APID>string</APID>
    <StreetNumber>string</StreetNumber>
    <Predirection>string</Predirection>
    <StreetName>string</StreetName>
    <StreetType>string</StreetType>
    <SecUnitDesignator>string</SecUnitDesignator>
    <SecUnit>string</SecUnit>
    <City>string</City>
    <County>string</County>
    <State>string</State>
    <Zipcode>string</Zipcode>
    <X>string</X>
    <Y>string</Y>
    <AddressLine>string</AddressLine>
    <CityLine>string</CityLine>
    <Lon>string</Lon>
    <Lat>string</Lat>
    <TaxPropID>string</TaxPropID>
    <GeoPropID>string</GeoPropID>
    <SourceTable>string</SourceTable>
    <Score>string</Score>
    <Validity>string</Validity>
  </Address>
</ArrayOfAddress>

HTTP POST

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

POST /webservices/AddressWebService2/AddressWebService.asmx/ValidateAddressWithCity HTTP/1.1
Host: ims.jocogov.org
Content-Type: application/x-www-form-urlencoded
Content-Length: length

securityKey=string&addressLine=string&cityLine=string

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

<?xml version="1.0" encoding="utf-8"?>
<ArrayOfAddress xmlns="https://ims.jocogov.org/webservices">
  <Address>
    <APID>string</APID>
    <StreetNumber>string</StreetNumber>
    <Predirection>string</Predirection>
    <StreetName>string</StreetName>
    <StreetType>string</StreetType>
    <SecUnitDesignator>string</SecUnitDesignator>
    <SecUnit>string</SecUnit>
    <City>string</City>
    <County>string</County>
    <State>string</State>
    <Zipcode>string</Zipcode>
    <X>string</X>
    <Y>string</Y>
    <AddressLine>string</AddressLine>
    <CityLine>string</CityLine>
    <Lon>string</Lon>
    <Lat>string</Lat>
    <TaxPropID>string</TaxPropID>
    <GeoPropID>string</GeoPropID>
    <SourceTable>string</SourceTable>
    <Score>string</Score>
    <Validity>string</Validity>
  </Address>
  <Address>
    <APID>string</APID>
    <StreetNumber>string</StreetNumber>
    <Predirection>string</Predirection>
    <StreetName>string</StreetName>
    <StreetType>string</StreetType>
    <SecUnitDesignator>string</SecUnitDesignator>
    <SecUnit>string</SecUnit>
    <City>string</City>
    <County>string</County>
    <State>string</State>
    <Zipcode>string</Zipcode>
    <X>string</X>
    <Y>string</Y>
    <AddressLine>string</AddressLine>
    <CityLine>string</CityLine>
    <Lon>string</Lon>
    <Lat>string</Lat>
    <TaxPropID>string</TaxPropID>
    <GeoPropID>string</GeoPropID>
    <SourceTable>string</SourceTable>
    <Score>string</Score>
    <Validity>string</Validity>
  </Address>
</ArrayOfAddress>

Parameter	Value
securityKey:
addressLine:
cityLine: