Skip to main content

MembershipCreate

Struct MembershipCreate 

Source
pub struct MembershipCreate {
    pub comment: Option<Option<String>>,
    pub fields: Option<Option<BTreeMap<String, Value>>>,
    pub group_member_status: Option<Option<String>>,
    pub group_type_role_id: Option<i64>,
    pub ignore_group_full: Option<bool>,
    pub ignore_waiting_list_full: Option<bool>,
    pub inform_leader: Option<bool>,
    pub member_end_date: Option<Option<NaiveDate>>,
    pub member_start_date: Option<Option<DateOrDateTime>>,
    pub only_add: Option<bool>,
    pub waitinglist_position: Option<Option<i64>>,
    pub extra: Map<String, Value>,
}
Expand description

Creates a membership linking the group and person from the path. All properties are optional. Defaults select the group type’s standard role and active status; active membership starts at the current time unless a start is provided.

Fields§

§comment: Option<Option<String>>

Membership comment; surrounding whitespace is trimmed. Null or empty text clears it. Omission clears an existing comment in the legacy update path.

None leaves the field out, Some(None) sends null.

§fields: Option<Option<BTreeMap<String, Value>>>

Values keyed by numeric membership-field definition ID. Only submitted known fields are updated; unknown IDs are ignored. Null clears one field; an omitted/null fields container changes no fields. Field-specific validation applies: text up to 4000 characters, numeric values, dates, timestamps, checkbox booleans, option IDs or labels for select/radioselect, and arrays of option IDs or labels for multiselect.

None leaves the field out, Some(None) sends null.

§group_member_status: Option<Option<String>>

New memberships default to active for omitted/null status. On legacy updates omitted/null preserves the previous status. A supplied waiting-list position can override the status to waiting. Allowed values: active, requested, to_delete, waiting.

None leaves the field out, Some(None) sends null.

§group_type_role_id: Option<i64>

Role ID for this group type; 0 or omission selects its default role for creation. Existing memberships retain their role when 0/omitted.

§ignore_group_full: Option<bool>

Skip the group-capacity check when creating the membership.

§ignore_waiting_list_full: Option<bool>

Allow the update even when it would exceed waiting-list capacity.

§inform_leader: Option<bool>

Whether membership-change processing should inform group leaders.

§member_end_date: Option<Option<NaiveDate>>

End date or null; omission clears an existing end date in the legacy update path.

None leaves the field out, Some(None) sends null.

§member_start_date: Option<Option<DateOrDateTime>>

Date or UTC timestamp not in the future. Omitted/null defaults to now when a new membership becomes active, otherwise null. Explicit null is rejected if active is explicitly submitted. Legacy updates generally retain an existing start when omitted/null.

None leaves the field out, Some(None) sends null.

§only_add: Option<bool>

Reject with 403 if the person already belongs to the group.

§waitinglist_position: Option<Option<i64>>

0 selects the next free waiting-list position; a positive value selects that position. Supplied positions set status to waiting and can shift other positions. For creation, null/omission assigns no position. For legacy updates, null/omission preserves it and -1 removes it but also sets status to waiting; -1 on creation reaches an assertion.

None leaves the field out, Some(None) sends null.

§extra: Map<String, Value>

Fields not described by the spec, e.g. instance-specific DB fields.

Trait Implementations§

Source§

impl Clone for MembershipCreate

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 MembershipCreate

Source§

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

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

impl Default for MembershipCreate

Source§

fn default() -> Self

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

impl<'de> Deserialize<'de> for MembershipCreate

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl PartialEq for MembershipCreate

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl Serialize for MembershipCreate

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for MembershipCreate

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

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