Web service API

How to use PageSeeder's Web service API

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 value
archivedWhether to return archived projects/groups only.nobooleanfalse
subgroupsIf subgroups should be included in the response.nobooleantrue
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]"
            flags="[flags]"
            status="[activated|unactivated|set-password]">
        <fullname>[full name]</fullname>
    </member>
    <membership id="[membership id]"
                email-listed="[true|false]"
                notification="[notification]"
                flags="[flags]"
                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

CodeCause / Description
0x0204The Member was not found.

Created on , last edited on