invite self

Description

Invite self to a group.

Allows a member to join themselves to a group in PageSeeder.

Group membership parameters

All group membership parameters are optional, and default to the group’s default values.

The notification parameter must be one of immediate, essential, daily, weekly or none.

The invitation behavior follows the value of Group Setting Self Registration as follows:

• Normal – The member is joined immediately to the group.
• Moderated – A request is emailed to a moderator who must approve it.
• Confirmed – The member is sent an email with a link that they must follow.

Additional information specific to the group can also be attached to the user using the details fields field1 to field15.

Parameters

Permission

Anyone can invoke this service if the group visibility is defined as public.

Response

If successful, the created membership is returned as a <membership> element wrapped in a <membership-creation> element.

If the service attempted but failed to send the email notification to the user, it is indicated using one of:

• @welcome-email-failed – if unable to send the membership-new-member template.
• @confirm-email-failed – if unable to send the membership-confirm template.
• @moderate-email-failed – if unable to send the membership-accept template.

<membership-creation [welcome-email-failed="true"]
                     [confirm-email-failed="true"]
                     [moderate-email-failed="true"]>
  <membership id="[membership id]"
              email-listed="[true|false]"
              notification="[notification]"
              status="[self-invited|moderated|normal]"
              role="[role]">
    <member id="[member id]"
            firstname="[first name]"
            surname="[surname]"
            username="[username]"
            status="[activated|unactivated|set-password]">
      <fullname>[full name]</fullname>
    </member>
    <group id="[group id]"
           name="[name]"
           visibility="[visibility]"
           template="[template]">
      <description>[description]</description>
    </group>
  </membership>
</membership-creation>

Error Handling