Tree.getList (Method)

Returns zero or more structures, each containing information of a tree.

Returns:

Tree_GetList_Results (query)

Each row of the returned query results has the following fields:

Field Name	Type	Description
CanAdmin	Boolean	Boolean flag which when set to true indicates that the current user can administer this tree.
CanEdit	Boolean	Boolean flag which when set to true indicates that the current user can edit this tree.
Description	PlainText_2000	The description of the tree.
FamilyID	TreeFamilyID	The family id of the tree.
FamilyName	PlainText_NonNull_50	The name of the tree family.
ID	TreeID	The unique ID of the tree.
Name	TreeName	The name of the tree.
State	ActiveInactive	The state of the tree, i.e. 'Active' or 'Inactive'.
TypeDescription	PlainText_2000	The description of the tree type.
TypeID	TreeTypeID	The unique ID of the tree type.
TypeName	PlainText_NonNull_100	The name of the tree type.

Arguments:

Name	Type	Required	Description
typeID	TreeTypeID_0	Required	The unique ID of a tree type to return the trees for, or 0 to return tree of all tree types.
state	GeneralStateFilter	Optional. Defaults to 'Active'.	The state of the tree to filter by. Possible values are 'All', 'Active', 'Inactive'.
nameFilter	PlainText	Optional. Defaults to 'All'.	Filters result on the basis of tree name.
familyIDFilter	TreeFamilyIDFilter	Optional. Defaults to 'All'.	The family id of the tree to filter the results, or 'All' for all families.
boundToSubsiteIDList	SubsiteIDList_EmptyString	Optional. Defaults to an empty string.	Comma-delimited list of subsite IDs, or empty string.

Context:

License Requirements	(none)
Permission Requirements	(none)
Deny Context	(none)
Require Context	(none)
Author Lock	(not required)
Transaction Logging	Transaction logging is disabled for this method
Customization	Customization is not supported for this method.

Error Codes:

None

Notes:

None