Skip to main content

 Services

Web services from /about to /webhooks

list member invitations

/members/{member}/invitations [GET]

com.pageseeder.membership.ListInvitationsForMember

Description

Get the invitations for the member.

Returns the list of groups the given member was invited to.

Parameters

No parameters required.

Permission

Only the current member or administrators can invoke this service.

Only administrators can specified a different member with the member URL parameter.

Response

This service returns a list of <membership> elements with the status set to invited and wrapped in a <invitations> element.

<invitations>
  <membership id="[membership id]"
              email-listed="[true|false]"
              notification="[notification]"
              flags="[flags]"
              status="invited"
              role="[role]">
    <group|project id="[group id]"
                   name="[name]"
                   flags="[flags]"
                   visibility="[visibility]"
                   template="[template]">
      <description>[description]</description>
    </group|project>
  </membership>
  <membership status="invited" ...> ...
  </membership>
  ...
</invitations>

If the user has no invitation, the service returns an empty list:

<invitations/>

Error Handling

No specific errors expected for this service.

Created on , last edited on