A request to the Address Parser Service Rest endpoint returns a list of results. Not every field will be returned with a result.
Request Parameters
The below table lists the response parameters for Address Parser Service:
| Field | Type | Description |
|---|---|---|
| errorMessage | String | Error message: The error message returned from the service with an error code. |
| status | Status | Status of the response. |
| results | <Result array> | List of results based on the specified criteria. |
Below are the Response fields returned:
| Field | Type | Description |
|---|---|---|
| addressNumber | String | House of building number
|
| street | String | Street name
|
| admin1 | String | Specifies the geographic area like:
state
|
| city | String | Specifies the geographic area like:
city
|
| suburb | String | Specifies the geographic area like: suburb |
| postalCode | String | Main postal code
|
| placeName | String | If applicable, represents the name of the candidate's place or building |
| floor | String | Each level within a building |
| unit | String | The unit number
|
Below is a sample Response for Address Parser:
{
"response": {
"status":"OK",
"address": {
"addressNumber":"1-7-1",
"city":"tokyo",
"city_district":"minato-ku",
"country":"japan",
"postalCode":"108-0075",
"suburb":"konan"
}
}
}