Web service API

How to use PageSeeder's Web service API

invite self

/groups/{group}/members/inviteself [POST]

com.pageseeder.membership.InviteSelf

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 will default to the group's default values.

The notification parameter must be one of "immediate", "daily" 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

NameDescriptionRequiredTypeDefault value
field1 no string
field10 no string
field11 no string
field12 no string
field13 no string
field14 no string
field15 no string
field2 no string
field3 no string
field4 no string
field5 no string
field6 no string
field7 no string
field8 no string
field9 no string
listed Whether the member's email address is listed in the group no boolean false
notification The member's notification option in the group no string
welcome-email Whether to send a welcome email to the member no boolean true

Permission

Undocumented permissions requirements.

Response

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

If the serviced attempted but failed to send the email notification to the user, it will be indicated using one of:

<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

CodeCause / Description
0x1003 If the specified group is a personal group.
0x1023 Invite to admin group not allowed
0x1025 The member already belongs to the group
0x6004 If the member details have not been configured properly
0x6005 Group has no moderator with an email address (when Self Registration: Moderated)

Created on , last edited on