Skip to main content

 Services

Web services from /about to /webhooks

list member memberships

/members/{member}/memberships [GET]

com.pageseeder.membership.ListMembershipsForMember

Description

Get the memberships for the member.

Returns the list of group memberships for the given member.

Parameters

NameDescriptionRequiredTypeDefault
archivedWhether to return archived projects/groups onlynobooleanfalse
inheritedWhether to return inherited memberships (guest project memberships inherited from child group membership)nobooleanfalse
subgroupsIf subgroups should be included in the responsenobooleantrue
extendedmemberIf extended information for member should be returned (administrators or self only)nobooleanfalse

Permission

Only the member herself or an administrator can invoke this service.

Response

This service returns a list of <membership> elements wrapped in a <memberships> element with a single <member> included before the list.

<memberships>
  <member id="[member id]"
          firstname="[first name]"
          surname="[surname]"
          username="[username]"
          status="[activated|unactivated|set-password]">
    <fullname>[full name]</fullname>
  </member>
  <membership [id="[membership id]"]
              email-listed="[true|false]"
              notification="[notification]"
              status="normal"
              role="[role]"
              [subgroups="[subgroups]"]
              [created="[date]"]>
    <group|project id="[group id]"
                   name="[group name]"
                   description="[description]"
                   owner="[owner]"
                   [relatedurl="[url]"] />
    <details>
      <field position="1"
             name="[field name]"
             editable="[true|false]"
             [title="[field title]"]
             [type="[field type]"]>
               [field value]
      </field>
      ...
    </details>
  </membership>
  <membership status="invited" ...> ...
  </membership>
  ...
</memberships>

Error Handling

No specific error handling.

Created on , last edited on