Address Input

The detailed address information for a facility used as search criteria.

JSON Example 

1{
2  "facilityAddress": {
3    "addressText": "1000 Main Street, Suite 200, Springfield, IL 62704, USA",
4    "streetLines": [
5      "1000 Main Street",
6      "Suite 200"
7    ],
8    "city": "Springfield",
9    "district": "Sangamon County",
10    "stateProvince": "IL",
11    "postalCode": "62704",
12    "country": "USA",
13    "latitude": 39.7990,
14    "longitude": -89.6586
15  }
16}

Properties 

Property NameTypeDescriptionRequired
addressTextStringThe complete address in a single text string.Optional
streetLinesArray of StringsAn array of strings representing the street address lines, including building number, street name, and apartment/suite/P.O. Box details.Optional
cityStringThe name of the city, town, or locality.Optional
districtStringThe district, county, or administrative area.Optional
stateProvinceStringThe full name or standard abbreviation of the state, province, or region.Optional
postalCodeStringThe postal code, ZIP code, or postcode relevant to the address.Optional
countryStringThe country of the address, ideally a two-letter (ISO 3166-1 alpha-2) or three-letter (ISO 3166-1 alpha-3) country code.Optional
latitudeNumberThe geographical latitude coordinate of the address.Optional
longitudeNumberThe geographical longitude coordinate of the address.Optional