Skip to main content

 Version 5

Legacy documentation for PageSeeder v5

invite self

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

obsolete

Description

Invite self to a group.

This service has been deprecated, use /groups/{group}/members/inviteself [POST] instead.

Parameters

NameDescriptionRequiredTypeDefault
field1nostring
field10nostring
field11nostring
field12nostring
field13nostring
field14nostring
field15nostring
field2nostring
field3nostring
field4nostring
field5nostring
field6nostring
field7nostring
field8nostring
field9nostring
listedWhether the member's email address is listed in the groupnobooleanfalse
notificationThe member’s notification option in the groupnostring
welcome-emailWhether to send a welcome email to the membernobooleantrue

Permission

Anyone can invoke this service since the group visible is defined as public.

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 is 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

Created on , last edited on