Multi-source address normalization
Multi-source address normalization assigns a unique identifier, called a oneID, to a user-provided address. This ensures that different address entries pointing to the same physical location receive the same ID, which normalizes address data from multiple sources. The service supports normalization at the Point of Interest (POI) level and the room number (roomno) level.
Test
You can run an API test in the Address Purification console.
Request parameters
Name | Type | Required | Sample value | Description |
Action | String | Yes | OneIdAddress | The action that you want to perform. The value must be: OneIdAddress |
AppKey | String | Yes | Axqwerasdf1a | The AppKey of the project. |
ServiceCode | String | Yes | addrp | Static field: addrp |
Text | String | Yes | Hangsheng Science Park (Wenyi West Road) No. 37, Unit 1, Yienbei | The text content. |
level | String | No | POI | The level used to determine if locations are the same. Supported levels are POI and roomno (room number). |
DefaultProvince | String | No | Zhejiang Province | The default province. |
DefaultCity | String | No | Hangzhou City | The default city. |
DefaultDistrict | String | No | Yuhang District | The default administrative region. |
Return data
Name | Type | Example | Description |
Data | String | "online_address_unify":"a578b39633726c377ea18de669b3efe7", "status":"OK", "time_used":{ "rt":{"basic_chunking":0.06006503105163574, "online_address_unify":0.3345825672149658, "segment":0.00047278404235839844, "address_correct":0.003100156784057617, "address_search":0.12077140808105469, "structure":0.00008606910705566406}, "start":1675070211.2347264} | online_address_unify: The result of the multi-source address normalization. time_used: The time that the algorithm takes to run. status: The status of the request. |
RequestId | String | 3A9AB010-AC38-4E53-9D25-6B97238C2897 | RequestId |
Examples
Request example
http(s)://[Endpoint]/?Action=OneIdAddress
&AppKey=Axqwerasdf1a
&ServiceCode=addrp
&Text=Hangsheng Science Park (Wenyi West Road) No. 37, Unit 1, Yienbei
&<Common request parameters>Response example
XML format
<RequestId>3A9AB010-AC38-4E53-9D25-6B97238C2897</RequestId>
<Data>
<online_address_unify>a578b39633726c377ea18de669b3efe7</online_address_unify>
<status>OK</status>
<time_used>
<rt>
<basic_chunking>0.06006503105163574</basic_chunking>
<online_address_unify>0.3345825672149658</online_address_unify>
<segment>0.00047278404235839844</segment>
<address_correct>0.003100156784057617</address_correct>
<address_search>0.12077140808105469</address_search>
<structure>0.00008606910705566406</structure>
</rt>
<start>1675070211.2347264</start>
</time_used>
</Data>
JSON format
{
"RequestId": "3A9AB010-AC38-4E53-9D25-6B97238C2897",
"Data": {
"online_address_unify":"a578b39633726c377ea18de669b3efe7",
"status":"OK",
"time_used":{
"rt":{
"basic_chunking":0.06006503105163574,
"online_address_unify":0.3345825672149658,
"segment":0.00047278404235839844,
"address_correct":0.003100156784057617,
"address_search":0.12077140808105469,
"structure":0.00008606910705566406
},
"start":1675070211.2347264
}
}
}Error codes
HTTP status code | Error code | Error message | Description |
403 | Forbidden.NoAuth | Failed to perform user authentication. | User authentication failed. |
500 | InternalError | A service error occurred. | An internal service error occurred. |
400 | InvalidParameter | The parameter is invalid. | The parameter is invalid. |
404 | ResourceDoesNotExist | The resource does not exist. | The resource does not exist. |
429 | Throttling.User | Flow control has been triggered. | Throttling was triggered. |
400 | UserStatusInvalid | The user status is invalid. | The user status is invalid. |
You can view more error codes in the Error Center.