Represents a postal address. The PostalAddress object is based on the HR-XML Consortium's Postal Address specification.

Usage

PostalAddress objects are only meaningful in the context of a Firmwater LMS location (see LmsLocationObject field PostalAddress) or a Firmwater LMS user (see LmsPersonObject field PostalAddress).

Permissions

Postal address information is ignored if the licensee associated with the location or user does not have address support enabled.

• The licensee must have location addresses enabled (see LmsLicenseeObject field UseLocationAddress) if a location with a postal address is being created or if a location's postal address is being updated.
• The licensee must have person addresses enabled (see LmsLicenseeObject field UsePersonAddress) if a user with a postal address is being created or if the user's postal address is being updated.

Identifying Fields

None

Attributes

type

An enumerated type representing the type of address being specified. Valid types are "militaryAddress", "streetAddress", "postOfficeBoxAddress", and "undefined". If no type is specified, then "undefined" is used.

Fields

CountryCode

An ISO 3166-1 string representing the country code of the address. All country codes are two-characters (see the Country Code List).

PostalCode

A string representing the postal code of the address.

Regions

Any number of strings representing the region of the address (typically the province or state of North American addresses).

Municipality

A string representing the municipality of the address (typically the city or town).

DeliveryAddress

An object which represents the delivery address containing the following fields:

• AddressLine

Any number of strings representing the name or number of the building, house, and/or street. If the address is decomposed into StreetName and BuildingNumber, AddressLine should not be used to store the address.

• StreetName

A string representing the street name or street number of the address. If the address is decomposed into StreetName, BuildingNumber and Unit, do not use AddressLine to duplicate that part of the information.

• BuildingNumber

A string representing the building number of the address. If the address is decomposed into StreetName, BuildingNumber and Unit, do not use AddressLine to duplicate that part of the information.

• Unit

A string representing the apartment, suite, unit, room, floor, etc. of the address. If the address is decomposed into StreetName, BuildingNumber and Unit, do not use AddressLine to duplicate that part of the information.

• PostOfficeBox

A string representing the post office box of the address.

Recipient

An object which represents the recipient containing the following fields:

• PersonName

A string representing the name of the person.

• AdditionalText

Any number of strings representing other recipient routing information in addition to organization and person name.

• Organization

A string representing the organization "for which the enrollment data is being transmitted" (from HR-XML Consortium's Postal Address specification).

• OrganizationName

A string representing information about the recipient. This may include a person's name, organization and/or additional information.