Address Assert Recognition Service

Address Assert Recognition & Query Service

To query address information from the Assert Database and Location Hub, use the Address Assert Recognition Service interface of the Address Assert Service.

The Address Assert Recognition Service interface is available as a SOAP request and is required in order to perform recognition and query requests against an Address Assert Database. 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.

This service is only available as a SOAP request and the documentation below only covers information new to Address Assert that is not available in the standard Address Recognition SOAP service.

AttributeQuery

This operation allows the user to input a freeform or parsed address, and will return all attribute information that is associated with the address.
The attributes returned are those unique to Location Hub such as CI and UAID, and/or those which have been added through the Assert Database.
Specific attributes can be returned by indicating the attribute name in the AttributeQuery request, however for all attributes to be returned this field should be left blank.
Attributes returned from the Assert Database are represented as a key value pair.

IsAsserted;

When using the Address Assert Recognition Service interface, all results returned will be appended with an additional field indicating if the address components returned are retrieved from the Assert Database or Location Hub. This flag does not indicate if additional attributes were appended to an address and stored in the assert database, it will only indicate if the address is currently available in Location Hub.

This is a boolean data type and will be set to “true” if the address information was returned from the Assert Database. It will be set to “false” if the address information was returned from Location Hub.

Sample XML

<!--Request-->
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <RecognizeRequestFreeForm xmlns="http://www.dmtispatial.com/recognition/v2.1/">
      <AttributeQuery/>
      <Item SequenceId="1">
      <AddressLine>10 abc st unit 102 toronto on</AddressLine>
      </Item>
    </RecognizeRequestFreeForm>
  </s:Body>
</s:Envelope>
 
<!--Response-->
<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
  <s:Body xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <RecognizeResponseFreeForm xmlns="http://www.dmtispatial.com/recognition/v2.1/">
      <ResponseItems>
        <ResponseItem SequenceId="1">
          <InsufficientFlag>false</InsufficientFlag>
          <LocationCandidates>
            <Location xsi:type="LocationAddress" IsAsserted="true">
              <Score>0.7858</Score>
              <AddressLine>10 ABC ST UNIT 102 TORONTO ON</AddressLine>
              <Municipality>TORONTO</Municipality>
              <StateProvince>ON</StateProvince>
              <UAID>2a8166b4-b4eb-8827-20e0-b14def11ac37</UAID>
              <RDSID>9213648</RDSID>
              <CI>0</CI>
              <MDUFlag xsi:nil="true"/>
              <ResidentialFlag xsi:nil="true"/>
              <SubAddress>
                <UUAID>54456607-6591-3a33-85ea-5cc90bdd5584</UUAID>
                <CI>0</CI>
                <SubAddressType>UNIT</SubAddressType>
                <SubAddressNumber>102</SubAddressNumber>
              </SubAddress>
              <StreetNumber>10</StreetNumber>
              <StreetName>ABC</StreetName>
              <StreetType>ST</StreetType>
              <Attributes>
                <Attribute Key="a1">v1</Attribute>
                <Attribute Key="a2">v2</Attribute>
              </Attributes>
            </Location>
          </LocationCandidates>
        </ResponseItem>
      </ResponseItems>
    </RecognizeResponseFreeForm>
  </s:Body>
</s:Envelope>