<details>

Summary

The XML representation of member details within a membership.

The <details> element acts as a container for <field> elements when a member has some custom member details for a group.

For details to appear with the <membership> elements of members, the member details configuration must be defined and the group must be configured so that it uses this details type.

The list of fields included in the returned details depends on the visibility configured for each field and the role of the member requesting the information.

Usage context

Attributes

This element does not have any attributes.

Examples

The following example shows the details of a member:

<membership id="8" email-listed="true" 
            notification="immediate" 
            status="normal" 
            role="manager" 
            created="2022-07-04T16:44:53+10:00">
  <member id="1" 
          firstname="Michael" surname="Hodges" 
          username="mhodges" 
          email="mhodges@example.com" status="activated">
    <fullname>Michael Hodges</fullname>
  </member>
  <details>
    <field position="1" name="title" editable="true" 
           title="Title">Mr</field>
    <!-- This field is only available to managers -->
    <field position="2" name="dob" editable="true"
           title="Date of Birth" type="date">1986-10-14</field>
    <field position="3" name="country" editable="true"
           title="Country">Australia</field>
  </details>
</membership>

It is based on the following configuration:

<?xml version="1.0"?>
<member-details>
  <field position="1" name="title" editable="true" visibility="group"
         title="Title" />
  <field position="2" name="dob" editable="true" visibility="manager"     
         title="Date of Birth" type="date" />
  <field position="3" name="country" editable="true" visibility="group"
         title="Country" />
</member-details>

Schema

XML Schema

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

<xs:complexType name="details">
  <xs:sequence>
    <xs:element name="field"
                type="field"
                minOccurs="0"
                maxOccurs="15"/>
  </xs:sequence>
</xs:complexType>

Relax Schema

element details {
   field*
}

Compatibility

No change since initial API release.