Skip to main content

 Version 5

Legacy documentation for PageSeeder v5

get membership

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

obsolete

Description

Use Service: /groups/{group}/members/{member} [GET] instead.

Get a membership

Parameters

NameDescriptionRequiredTypeDefault
subgroupsIf subgroups should be included in the responsenobooleantrue

subgroups

This parameter used as a flag to specify if subgroup membership is to 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