Web service API

How to use PageSeeder's Web service API

invite member

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

com.pageseeder.membership.InviteMember

Description

Invite a member to a group

Adds a member to a group in PageSeeder.

If the member specified (with the email address) is non existent, it will be created.

The email must be less than 100 characters and be a valid Email address.

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 role parameter must be one of "guest", "reviewer", "contributor", "manager", "approver", "moderator-and-approver", "moderator".

The group invitation behavior follows the value of the project property acceptInvitationRequired .

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

Parameters

NameDescriptionRequiredTypeDefault value
emailThe member's email (required if no member-username)maybeemail
member-usernameThe member's username, defaults to the member's email (required if no email)maybestring
notify-asyncWhether to send emails asynchronously (for slow email servers).nobooleanfalse
field1Custom field #1nostring
field10Custom field #10nostring 
field11Custom field #11nostring 
field12Custom field #12nostring 
field13Custom field #13nostring 
field14Custom field #14nostring 
field15Custom field #15nostring 
field2Custom field #2nostring 
field3Custom field #3nostring 
field4Custom field #4nostring 
field5Custom field #5nostring 
field6Custom field #6nostring 
field7Custom field #7nostring 
field8Custom field #8nostring 
field9Custom field #9nostring 
firstnameThe member's first name (used if they don't exist)nostringMember
invitationWhether to create an invitation, otherwise force membership (admin only)nobooleandepends on group properties
listedWhether the member's email address is listed in the group nobooleanfalse
notificationThe member's notification option in the groupnoenumdepends on group config
roleThe member's role in the groupnoenumdepends on group config
surnameThe member's first name (used if they don't exist)nostring[4 digits]
welcome-emailWhether to send a welcome email to the new membernobooleantrue

Permission

Undocumented permissions requirements.

Response

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

Error Handling

CodeCause / Description
0x1002 If the email address is invalid.
0x1003 If the specified group is a personal group.
0x1005 If the maximum number of members on the server has been reached
0x1023 Invite to admin group not allowed

Created on , last edited on