Address Assert Recognition – REST Service
Address Assert Recognition & Query Service
The Address Assert Recognition Service interface is also available as a RecognizeFreeForm REST operation and is required in order to perform recognition and query requests against an Address Assert Database using the REST interface. This service should be used instead of the standard Location Hub Address Recognition service as it contains all operations required for use with an Address Assert database along with those needed to interact with Location Hub Address Recognition Service. When implementing Address Assert, please note that the Address Assert Recognition Service will query both the Assert database and Location Hub on each request.
The documentation below only covers information new to Address Assert that is not available in the standard Address Recognition REST service.
RecognizeFreeForm
The RecognizeFreeForm operation processes a full address entered as a single line, similar to the SOAP interface. It supports additional optional parameters and returns a complete set of output attributes, consistent with the SOAP version. Details about the available parameters for RecognizeFreeForm are provided on the Address Recognition REST Service page.
Assert Indicators
When using the Address Assert Recognition – REST Service interface, all results returned will be appended with the following 2 additional fields indicating if this address record was retrieved from the Address Assert Database or Location Hub; IsAsserted, and IsAssertedSpecified. These flags only indicate if the address was in the assert database or whether it was retrieved from Location Hub.
These fields are a boolean data type and will be set to “true” if the address information was returned from the Assert Database, and “false” if the address information was returned from Location Hub.
Example (RecognizeFreeForm request):
A request for “10 ABC ST TORONTO ON” (address simulated to be in an assert database) will produce the following output:
/assert/recognition/rest/RecognizeFreeForm REST Request:
/assert/recognition/rest/RecognizeFreeForm?address=10%20ABC%20ST%20TORONTO%20ON&limit=1
//RecognizeFreeForm REST Response:
{"ResponseItems": [{
"InsufficientFlag": false,
"LocationCandidates": [ {
"Type": "LocationAddress",
"UAID": "2a8166b4-b4eb-8827-20e0-b14def11ac37",
"RDSID": 9213648,
"CI": 0,
"StreetNumber": {
"ChangeFlagSpecified": false,
"Value": 10
},
"StreetNumberSuffix": {
"ChangeFlagSpecified": false,
"Value": null
},
"StreetPreDirection": {
"ChangeFlagSpecified": false,
"Value": null
},
"StreetPreType": {
"ChangeFlagSpecified": false,
"Value": null
},
"StreetName": {
"ChangeFlagSpecified": false,
"Value": "ABC"
},
"StreetType": {
"ChangeFlagSpecified": false,
"Value": "ST"
},
"StreetDirection": {
"ChangeFlagSpecified": false,
"Value": null
},
"PostalCode": {
"ChangeFlagSpecified": false,
"IsDerived": false,
"Value": null
},
"UsedMunicipalityAlias": "",
"IsAsserted": true,
"IsAssertedSpecified": true,
"Score": 0.7858,
"Coordinates": [ {
"Lat": 43.6535,
"Lon": -79.3839,
"CoordinateType": 1,
"AddressPointType": 0,
"AddressPointTypeSpecified": true,
"LegacyPDC": 107,
"PMC": 301,
"PDC": 30
}],
"AddressLine": "10 ABC ST TORONTO ON",
"Municipality": {
"ChangeFlagSpecified": false,
"Value": "TORONTO"
},
"StateProvince": {
"ChangeFlagSpecified": false,
"Value": "ON"
},
"Country": {
"ChangeFlag": 2,
"ChangeFlagSpecified": true,
"Value": "CANADA"
}
}],
"SequenceId": "1"
}]}