|
OutputSetId
|
integer
|
|
N
|
|
Override the default output set using a passed Output Set Id. Error is thrown if List has no default Output Set..
|
|
MailingDateTime
|
date
|
|
N
|
|
Postal and email addresses active on the entered date will be selected or, if a constituent does not have addresses with active dates, the primary address will be selected.
|
|
AddressPurposeId
|
integer
|
|
N
|
|
If a constituent has a postal address with the selected mailing purpose id that address will be used, otherwise the primary address will be used.
|
|
UseLabelAddress
|
boolean
|
|
N
|
|
This parameter determines whether or not a postal address must be a label address in order to be selected. If set to true, only postal addresses with the label box checked will be used.
|
|
SalutationTypeId
|
integer
|
|
N
|
|
If a constituent has a salutation of with the selected type id that salutation will be used, otherwise the primary salutation will be used.
|
|
ElectronicAddressTypeId
|
integer
|
|
N
|
|
If a constituent has an electronic address of the selected type that address will be used, otherwise the primary electronic address will be used.
|
|
ElectronicAddressPurposeId
|
integer
|
|
N
|
|
If a constituent has an electronic address with the selected purpose id that address will be used, otherwise the primary electronic address will be used.
|
|
EMarketingIndicator
|
boolean
|
|
N
|
|
This parameter is used to limit email addresses selected for output to those that are marked for marketing communications.
|
|
MembershipOrganizationId
|
integer
|
|
N
|
|
If the constituent has a membership for the selected membership organization, membership data is returned for that membership organization. If the constituent does not have a membership record in the selected membership organization, or no membership organization is selected, the default membership organization (as defined in T_DEFAULTS) is used.
/// If the constituent does not have a membership record in the default membership organization, or a default membership organization has not been defined, the membership organization for the record with the latest expiration date is used.
/// In all cases, only membership records with a status of Active, Pending, Awaiting Payment, Suspended and Lapsed are considered. If a constituent has two qualifying membership records (such an Active record and Pending record), data for either the record with the highest level (the default) or the record with the latest expiration date is returned, according to a setting in T_DEFAULTS table.
|
|
SearchText
|
string
|
|
N
|
|
If value is alphanumeric, searchText must be three or more characters and returns constituents that contain the search text in their sort name. If numeric, searches by constituent id.
|
|
SortBy
|
string
|
|
N
|
|
Value can be Id, IdDesc, Name, or NameDesc.
|
|
Page
|
integer
|
|
N
|
|
Results at a specific page. Dependent on PageSize value.
|
|
PageSize
|
integer
|
|
N
|
|
The number of rows to return per page.
|
|
DisableListGenerate
|
boolean
|
|
N
|
|
If value is true, dynamic list will not be generated when requesting list results.
|
|
FormatDate
|
boolean
|
|
N
|
|
If value is true, will return date/time in an Excel-friendly format.
|