Web service API

How to use PageSeeder's Web service API

get membership

/groups/{group}/members/{member}/details [GET]

com.pageseeder.membership.GetMembership

This service is deprecated since version 5.7900

Description

Get a membership

Parameters

NameDescriptionRequiredTypeDefault value
subgroupsIf subgroups should be included in the responsenobooleantrue

subgroups

This parameter used as a flag to specify if subgroup membership should be considered. The possible values are "true" and "false" and the default value is "true".

Permission

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

Response

If successful, the full membership details are returned in a <membership> element.

<membership id="[membership id]"
            email-listed="[true|false]"
            notification="[none|immediate|daily]"
            status="[normal|invited|self-invited|disabled]"
            role="[role]
            [subgroups="[subgroups]"]">
   <member id="[member id]"
           firstname="[first name]"
           surname="[surname]"
           username="[username]" status="[activated|unactivated|set-password]">
      <fullname>[full name]</fullname>
   </member>
   <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>

Error handling

Created on , last edited on