Web service API

How to use PageSeeder's Web service API

<subgroup>

Summary

A group used as subgroup for another group.

The <subgroup> element includes information to describe how it affects the membership of its members (the subgroup) in relation to the group it it included in (the main group)

It contains a <group> element to describe the group that acts as a subgroup.

Usage context

Permitted content<group>
Permitted parent<subgroup-addition>

Attributes

This element includes the following attributes.

NameTypeRequiredDescription
idxs:longyesThe ID of the group in PageSeeder
listedenumyesWhether the 
notificationenumyesNotification preference for members of subgroup
roleenumyesRole for members of subgroup

@id

The PageSeeder database identifier for the subgroup. It is always an immutable positive long value that is unique on a specific PageSeeder server amongst subgroups.

@listed

This attribute indicates whether the members have their email address listed on the main group.

The possible values "true" or "false" or "inherit". The latter means that the notification preference on the main group is inherited from the subgroup.

@notification

This attribute indicates which notification preference the members of the subgroup should have on the main group.

The possible values are the same as for the @notification attribute of the <membership> element with the addition of the "inherit" which means that the notification preference on the main group is inherited from the subgroup.

@role

This attribute indicates which role the members of the subgroup should have on the main group.

The possible values are the same as for the @role attribute of the <membership> element with the addition of the "inherit" which means that the notification preference on the main group is inherited from the subgroup.

Examples

Schema

XML Schema

<xs:element name="subgroup" type="subgroup"/>

<xs:complexType name="subgroup">
  <xs:sequence>
     <xs:element name="group" type="group-basic"/>
  </xs:sequence>
  <xs:attribute name="id"           type="id"                    use="required"/>
  <xs:attribute name="listed"       type="subgroup-listed"       use="required"/>
  <xs:attribute name="notification" type="subgroup-notification" use="required"/>
  <xs:attribute name="role"         type="subgroup-role"/>
</xs:complexType>
Attribute types

The attribute types are based on the element <membership> attribute types .

​​​​​​​<xs:simpleType name="inherit">
  <xs:restriction base="xs:string">
    <xs:enumeration value="inherit" />
  </xs:restriction>
</xs:simpleType>

<xs:simpleType name="subgroup-listed">
  <xs:union memberTypes="boolean inherit" />
</xs:simpleType>

<xs:simpleType name="subgroup-notification">
  <xs:union memberTypes="notification inherit" />
</xs:simpleType>

<xs:simpleType name="subgroup-role">
  <xs:union memberTypes="membership-role inherit" />
</xs:simpleType>

Relax Schema

element subgroup {
   attribute id            { xs:long },
   attribute email-listed  { "false" | "inherit" | "true" },
   attribute notification  { "none" | "daily" | "immediate" | "inherit"},
   attribute role          { "guest" | "reviewer" | "contributor"
                           | "inherit" | "manager" | "moderator"
                           | "approver" | "moderator-and-approver" }?,
   element group
}

Compatibility

See also

Created on , last edited on