Address
Type: object
Additional Properties Allowed: False
| Property | Type | Required | Format | Title |
|---|---|---|---|---|
| address | string |
 |
||
| address2 | ['string', 'null'] |
|||
| city | string |
|
||
| state | enum |
|
||
| zip_code | string |
|
||
| external_building_id | string |
address
- is required
- Type:
string
address2
- is not required
- Type:
['string', 'null']
city
- is required
- Type:
string
state
- is required
- Type:
enum
| Value |
|---|
AL |
AK |
AZ |
AR |
CA |
CO |
CT |
DE |
FL |
GA |
HI |
ID |
IL |
IN |
IA |
KS |
KY |
LA |
ME |
MD |
MA |
MI |
MN |
MS |
MO |
MT |
NE |
NV |
NH |
NJ |
NM |
NY |
NC |
ND |
OH |
OK |
OR |
PA |
RI |
SC |
SD |
TN |
TX |
UT |
VT |
VA |
WA |
WV |
WI |
WY |
DC |
zip_code
- is required
- Type:
string
Regex Pattern: ^[0-9]{5}$
external_building_id
Allows an organization to assign an ID to the building for that organization's internal use. This field has no impact within the HES system, except that it can be filtered on in some of the retrieve_* methods.
- is not required
- Type:
string