Skip to main content

GetGroupsIdMembersQuery

Struct GetGroupsIdMembersQuery 

Source
pub struct GetGroupsIdMembersQuery {
Show 14 fields pub limit: Option<i64>, pub role_ids: Option<Vec<i64>>, pub person_id: Option<Vec<i64>>, pub group_member_statuses: Option<Vec<String>>, pub allowed_chat_users_only: Option<bool>, pub allowed_chat_writers_only: Option<bool>, pub query: Option<String>, pub comment: Option<String>, pub member_start_date_after: Option<Value>, pub member_start_date_before: Option<Value>, pub order_fields: Option<Vec<String>>, pub order_directions: Option<Vec<String>>, pub person_fields: Option<Vec<String>>, pub include: Option<Vec<String>>,
}
Expand description

Query parameters for GET /groups/{groupId}/members.

Fields§

§limit: Option<i64>

Maximum number of memberships per page.

§role_ids: Option<Vec<i64>>

Filter by role definition IDs (Role.id from GET /roles), matching groupTypeRoleId on memberships. Multiple IDs match any of the selected roles.

§person_id: Option<Vec<i64>>

Filter by person IDs. These are the IDs in person.domainIdentifier, not membership record IDs.

§group_member_statuses: Option<Vec<String>>

Filter by membership status, independently of the member’s role. Multiple values match any selected status. Omit this filter to include all visible statuses. Allowed values: active, requested, to_delete, waiting.

§allowed_chat_users_only: Option<bool>

If true, return only group members, that are allowed to chat in this group

§allowed_chat_writers_only: Option<bool>

If true, return only group members that are allowed to write in the chat.

§query: Option<String>

Search the first and last names of the persons belonging to the group.

§comment: Option<String>

Return memberships whose comment contains the supplied text.

§member_start_date_after: Option<Value>

Filter by a membership start date strictly after this value. Memberships without a start date do not match. Use YYYY-MM-DD; UTC timestamps are also accepted for compatibility.

§member_start_date_before: Option<Value>

Filter by a membership start date strictly before this value. Memberships without a start date do not match. Use YYYY-MM-DD; UTC timestamps are also accepted for compatibility.

§order_fields: Option<Vec<String>>

Fields used to sort the member list. Use person_ for person fields and member_ for membership properties or custom member fields. For example: person_lastName or member_groupTypeRoleId. Without this parameter, results are ordered by role type, role sort key, last name, first name and person ID.

§order_directions: Option<Vec<String>>

Sort directions corresponding by position to orderFields. Supply one direction per sort field. Built-in fields default to ASC when their direction is omitted. Allowed values: ASC, DESC.

§person_fields: Option<Vec<String>>

Additional person-field keys to include in each member’s personFields object, for example firstName. Person-field permissions apply; membership-specific fields are returned separately in fields.

§include: Option<Vec<String>>

Additional member-list data. newsletter and tags add properties to each member; aggregations adds meta.aggregations.fields with numeric group member field aggregates over all filtered members, across all pages. Allowed values: aggregations, newsletter, tags.

Trait Implementations§

Source§

impl Clone for GetGroupsIdMembersQuery

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for GetGroupsIdMembersQuery

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl Default for GetGroupsIdMembersQuery

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more