ApartmentNumber aka ApartmentAppend

The ApartmentNumber service is used to append secondary address information, such as apartment number or floor.

The service attempts to find the apartment number for the person within the specified building. If secondary address information like apartment number or floor is missing, this information is added. Any existing apartment numbers or secondary address data is replaced.

Input Fields

The most commonly used fields for this service are listed in the ApartmentNumberField enumeration.

Required Input Fields

This service requires both address fields and name fields as input.

Address Fields

This service requires address information as input. As a general rule, at minimum, the service requires the AddressLine1, City, State, and ZIPCode fields. If these individual fields are not available, you can use the AddressBlock field.

There are other alternate combinations that can work. For more information, please see Supplying Required Address Information.

Name Fields

This service requires name information as input. As a general rule, at minimum, the service requires the FirstName and LastName fields. If these individual fields are not available, you can use the FullName field.

There are other alternate combinations that can work. For more information, please see Supplying Required Name Information.

In addition to the required fields, MiddleName and NameSuffix are optional, and are used by the service if present in the record.

Output Fields

Output fields populated by this service include:

• AddressBlock
• AddressLine1
• AddressLine2
• AddressType
• ApartmentNumberFootnote
• City
• LastLine
• State
• Urbanization
• ZipCode

Additionally, if these fields are included as input, content will be modified by this service during output:

• FirstName
• FullName
• LastName
• MiddleName
• NameSuffix
• Salutation