Web service API

How to use PageSeeder's Web service API

invite self

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

com.pageseeder.membership.InviteSelf

This service is deprecated since version 5.7900

Description

Invite self to a group.

Deprecation warning!

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

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

Created on , last edited on