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.