AIMSAddressWebService
Click here for a complete list of operations.
GetTopMatches
Get the top 250 matches to an address string. This is a very general search that will return similar addresses sorted by their rank score. Use it to give possibilities to the user.
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/GetTopMatches"
<?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>
<GetTopMatches xmlns="https://ims.jocogov.org/webservices">
<securityKey>string</securityKey>
<addressLine>string</addressLine>
</GetTopMatches>
</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>
<GetTopMatchesResponse xmlns="https://ims.jocogov.org/webservices">
<GetTopMatchesResult>
<string>string</string>
<string>string</string>
</GetTopMatchesResult>
</GetTopMatchesResponse>
</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>
<GetTopMatches xmlns="https://ims.jocogov.org/webservices">
<securityKey>string</securityKey>
<addressLine>string</addressLine>
</GetTopMatches>
</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>
<GetTopMatchesResponse xmlns="https://ims.jocogov.org/webservices">
<GetTopMatchesResult>
<string>string</string>
<string>string</string>
</GetTopMatchesResult>
</GetTopMatchesResponse>
</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/GetTopMatches?securityKey=string&addressLine=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"?> <ArrayOfString xmlns="https://ims.jocogov.org/webservices"> <string>string</string> <string>string</string> </ArrayOfString>
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/GetTopMatches HTTP/1.1 Host: ims.jocogov.org Content-Type: application/x-www-form-urlencoded Content-Length: length securityKey=string&addressLine=string
HTTP/1.1 200 OK Content-Type: text/xml; charset=utf-8 Content-Length: length <?xml version="1.0" encoding="utf-8"?> <ArrayOfString xmlns="https://ims.jocogov.org/webservices"> <string>string</string> <string>string</string> </ArrayOfString>