address_direction |
xs:string |
Optional |
Single |
Specifies the (inter-)cardinal direction
of the entire address. An example is
“NE” for the address “100 E Capitol St
NE.” |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
city |
xs:string |
Required |
Single |
The city specifies the city or town of
the address. |
If the field is invalid, then the
implementation is required to ignore the
StreetSegment element containing it. |
includes_all_addresses |
xs:boolean |
Optional |
Single |
Specifies if the segment covers every
address on this street. If this is
true, then the values of
StartHouseNumber and
EndHouseNumber should be ignored.
The value of OddEvenBoth must be
both. |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
includes_all_streets |
xs:boolean |
Optional |
Single |
Specifies if the segment covers every
street in this city. If this is true,
then the values of OddEvenBoth,
StartHouseNumber,
EndHouseNumber, StreetName, and
Zip should be ignored. |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
odd_even_both |
oeb_enum |
Optional |
Single |
Specifies whether the odd side of the
street (in terms of house numbers), the
even side, or both are in included in
the street segment. |
If the field is not present or invalid,
the implementation is required to ignore
the StreetSegment containing it. |
precinct_id |
xs:IDREF |
Required |
Single |
References the precinct
that contains the entire street segment.
If a precinct has a
spatial_boundary which
also contains the entire street segment,
then the precinct assignment from the
segment will be preferred over the
assignment defined by the spatial
boundary. |
If the field is invalid, then the
implementation is required to ignore the
StreetSegment element containing it. |
start_house_number |
xs:integer |
Optional |
Single |
The house number at which the street
segment starts. This value is necessary
for the street segment to make any
sense. Unless IncludesAllAddresses
or IncludesAllStreets are true, this
value must be less than or equal to
EndHouseNumber. If
IncludesAllAddresses or
IncludesAllStreets are true, this
value is ignored. |
Unless IncludesAllAddresses or
IncludesAllStreets are true, if the
field is not present or invalid, the
implementation is required to ignore the
StreetSegment element containing it. If
the StartHouseNumber is greater than
the EndHouseNumber, the
implementation should ignore the element
containing them. |
end_house_number |
xs:integer |
Optional |
Single |
The house number at which the street
segment ends. This value is necessary
for the street segment to make any
sense. Unless IncludesAllAddresses
or IncludesAllStreets are true, it
must be greater than or equal to
StartHouseNumber. If
IncludesAllAddresses or
IncludesAllStreets are true, this
value is ignored. |
Unless IncludesAllAddresses or
IncludesAllStreets are true, if the
field is not present or invalid, the
implementation is required to ignore the
StreetSegment element containing it. If
the EndHouseNumber is less than the
StartHouseNumber, the implementation
should ignore the element containing it. |
house_number_prefix |
xs:string |
Optional |
Single |
Part of a street address. It may contain
letters or slashes (e.g., ‘B’ in ‘B22
Main St’). If this value is present then
StartHouseNumber must be equal to
EndHouseNumber. This field cannot be
used if IncludesAllAddresses or
IncludesAllStreets are true. |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
house_number_suffix |
xs:string |
Optional |
Single |
Part of a street address. It may contain
letters or slashes (e.g., 1/2 in ‘22 1/2
Main St’). If this value is present then
StartHouseNumber must be equal to
EndHouseNumber. This field cannot be
used if IncludesAllAddresses or
IncludesAllStreets are true. |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
state |
xs:string |
Required |
Single |
Specifies the two-letter state
abbreviation of the address. |
If the field is invalid, then the
implementation is required to ignore the
StreetSegment element containing it. |
street_direction |
xs:string |
Optional |
Single |
Specifies the (inter-)cardinal direction
of the street address (e.g., the “E” in
“100 E Capitol St NE”). |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
street_name |
xs:string |
Optional |
Single |
Represents the name of the street for
the address. A special wildcard, “*”,
denotes every street in the given
city/town. It optionally may contain
street direction, street suffix or
address direction (e.g., both “Capitol”
and “E Capitol St NE” are acceptable for
the address “100 E Capitol St NE”),
however this is not preferred. Preferred
is street name alone (e.g. “Capitol”). |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
street_suffix |
xs:string |
Optional |
Single |
Represents the abbreviated,
non-directional suffix to the street
name. An example is “St” for the address
“100 E Capitol St NE.” |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
unit_number |
xs:string |
Optional |
Repeats |
The apartment/unit number for a street
segment. If this value is present then
StartHouseNumber must be equal to
EndHouseNumber. This field cannot be
used if IncludesAllAddresses or
IncludesAllStreets are true. |
If the field is invalid or not present,
then the implementation is required to
ignore it. |
zip |
xs:string |
Optional |
Single |
Specifies the zip code of the address.
It may be 5 or 9 digits, and it may
include a hyphen (‘-‘). It is required
as it helps with geocoding, which is
crucial for distributors. |
If the field is invalid or not present,
then the implementation is required to
ignore it. |