Validate a Location
Validate address data and automatically correct most typos
Required inputs
For location validation, at least one required piece of information is necessary. For example, if you search for a particular street without specifying a ZIP code or street number, Foxentry will validate the request based on the information provided. It will return the most probable street address in its response, drawing from similar requests and various other factors.
Street & street numbers and vice versa
The best way to explain this is with an example. Here is an address: Jeseniova 2770/56d, 130 00 Praha. In the table, you can see the correct way to separate an address for validation. You can use part of the address, a full address, or even incomplete address data, and Foxentry will validate it based on the information provided.
| Address | Content |
|---|---|
| Street | Jeseniova |
| Street with number | Jeeniova 55 |
| Full house number | 1151/55d |
| The first section of house number | 1151 |
| Numerical part of the first section | 1151 |
| Textual part of the first section | - |
| The second section of house number | 55d |
| Numerical part of the second section | 55 |
| Textual part of the second section. | d |
| City | Praha |
| ZIP code | 18600 |
| Full address | Jeseniova 2770/56d, 130 00 Praha |
Country ID
By an international system of https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2
| State | ISO 3166-1 alpha-2 |
|---|---|
| Czech Republic | CZ |
| Poland | PL |
| Slovakia | SK |
What can you set?
| Data scope | Content |
|---|---|
| Empty | The setting will be set to the default state, which in this case means 'Basic'. |
| Basic | Retrieves the address associated with a specific ID. You can obtain the address in several different formats, depending on your needs. |
| Full | The full data scope provides the same information as the basic version but with additional details. For example, it includes the region, the name of the district, whether it has external IDs, and its GPS coordinates. The availability of data varies depending on the state. For information about availability, refer to Location datasopes. |
| Data source | Content |
|---|---|
| CZ | Addresses and locations from the Czech Republic. |
| PL | Addresses and locations from Poland. |
| SK | Addresses and locations from Slovakia. |
| ZIP format | Content |
|---|---|
| Yes | This option determines the format in which the ZIP is returned - 130 00. |
| No | This option determines the format in which the ZIP is returned - 13000. |
| Empty | The setting will be set to the default state, which in this case means 'No'. |
| City format | Content |
|---|---|
| Yes | The setting will be set to the default state, which in this case means ''. |
| Minimal | This option determines the format in which the city is returned - Praha. |
| Basic | This option determines the format in which the city is returned - Praha 8. |
| Extended | This option determines the format in which the city is returned - Praha 8 - Karlín. |
What can you find in the response?
Basic
json
{
"status": 200,
"request": { "endpoint": "location/validate", "code": "59eb4125-d449-4041-9ee6-422e206be226" },
"response": {
"result": {
"isValid": null,
"proposal": "invalidWithCorrection",
"dataTypes": { "valid": ["city"], "invalid": ["full"] },
"data": {
"country": "CZ", "ids": { "internal": null, "external": null }, "street": null,
"number": { "type": null, "part1": null, "part1Number": null, "part1Letter": null, "part2": null, "part2Number": null, "part2Letter": null, "full": null },
"streetWithNumber": null, "city": null, "zip": null, "full": "Thámova 137/16 18600 Praha 8"
},
"errors": [
{ "group": "SYNTAX", "type": "INVALID", "subtype": null, "severity": "critical", "relatedTo": ["full"], "description": "Value has invalid syntax." }
],
"resultCorrected": {
"isValid": true,
"dataTypes": { "valid": ["city"], "invalid": [] },
"data": {
"country": "CZ",
"ids": { "internal": "d2ade877-1e95-4a83-baa6-54...", "external": "22349995" },
"street": "Thámova",
"number": { "type": "č.p.", "part1": "137", "part1Number": "137", "part1Letter": null, "part2": "16", "part2Number": "16", "part2Letter": null, "full": "137/16" },
"streetWithNumber": "Thámova 137/16", "city": "Praha 8", "zip": "18600", "full": "Thámova 137/16, 18600 Praha 8",
"errors": []
},
"fixes": [
{ "group": "SYNTAX", "type": "VALUE_CHANGED", "subtype": null, "data": { "typeFrom": "full", "type": "full", "valueFrom": "Thámova 137/16 18600 Praha", "value": "Thámova 137/16, 18600 Praha 8" } }
],
"suggestions": []
},
"errors": []
}
}
}
Extended
Neověřeno: zdrojový obrázek (locationvalidate_full-01.png, přes tuto stránku odkazovaný pod nadpisem "Extended") je v resultCorrected.data useknutý — končí na cityDistrictSpecial: 86 bez uzavření objektu. Přepsáno přesně, co je vidět, zbytek pole (number, city, zip, geometry, …) screenshot neobsahuje.
json
{
"errors": [], "status": 200,
"request": { "code": "c370eeaa-12a0-44bb-9e40-d5271cea636b", "endpoint": "location/validate" },
"response": {
"result": {
"data": {
"ids": {
"city": null, "region": null, "street": null, "cityPart": null, "district": null,
"external": null, "internal": null, "cityDistrict": null, "cadastralArea": null, "cityDistrictSpecial": null
},
"zip": null, "city": null, "full": "Thámova 137/16 18600 Praha 8",
"number": { "full": null, "type": null, "part1": null, "part2": null, "part1Letter": null, "part1Number": null, "part2Letter": null, "part2Number": null },
"region": null, "street": null, "country": "CZ", "cityPart": null, "district": null,
"geometry": { "gps": { "lat": null, "lon": null }, "custom": [] },
"postOffice": { "name": null },
"cityDistrict": null, "cadastralArea": null, "streetWithNumber": null, "cityAdministrative": null, "cityDistrictSpecial": null
},
"errors": [
{ "type": "INVALID", "group": "SYNTAX", "subtype": null, "severity": "critical", "relatedTo": ["full"], "description": "Value has invalid syntax." }
],
"isValid": null,
"proposal": "invalidWithCorrection",
"dataTypes": { "valid": ["city"], "invalid": ["full"] },
"suggestions": [],
"resultCorrected": {
"data": {
"ids": {
"city": "554782", "region": "19", "street": "472093", "cityPart": "400637", "district": "9999",
"external": "22349995", "internal": "d2ade877-1e95-4a83-baa6-54...", "cityDistrict": "500208",
"cadastralArea": "730955", "cityDistrictSpecial": "86"
}
}
}
}
}
}