SectionsOption

Description

SectionsOption indicates the sections that should be returned for a record.

Parameters

Name	Type	Description
SECTIONS-ALL	string	Returns all sections. This is the default value for the sections argument. If no value is specified, ALL is the assumed value.
SECTIONS-NONE	string	No sections are returned (only the Identifier is returned). Note that the Identifier element is always returned, regardless of the value or values specified in the sections parameter.
SECTIONS-SPECIFIED	string	Returns sections that you specify.

Usage

Use the sections and specifiedSections arguments to specify which parts of a record should be returned in order to limit the total amount of data that is returned. The sections that are not specified are not included in the response. For example, if the items that you want to return have a large number of item links, notes, URL and file attachments that don't need to be returned in the response, use these parameters to return only the sections of an item you want. If you only need basic user information in the GetUsers response, use the specifiedSections parameter to return only the STANDARD section. If you need basic user information and group information, specify STANDARD and GROUPS.

In the sections parameter, specify one of the following enumeration options:

SECTIONS-ALL – Returns all sections. This is the default value for the sections argument. If no value is specified, ALL is the assumed value. For example:
```
<urn:sections>SECTIONS-ALL</urn:sections>
<urn:specifiedSections></urn:specifiedSections>
```
SECTIONS-NONE – No sections are returned (only the Identifier element is returned). For example:
```
<urn:sections>SECTIONS-NONE</urn:sections>
<urn:specifiedSections></urn:specifiedSections>
```
Note: The Identifier is always returned, regardless of the value or values specified in the sections parameter.

SECTIONS-SPECIFIED – Returns sections that you specify. For example:

<urn:sections>SECTIONS-SPECIFIED</urn:sections>
<urn:specifiedSections>SECTION:EXTENDED</urn:specifiedSections>

You can also use a comma-separated list in specifiedSections to return only the sections of a record that you want. For example:

<urn:specifiedSections>SECTION:FIXED,SECTION:EXTENDED</urn:specifiedSections>

This ensures that only the fixed and extended sections of an item are returned. Below are the sections that you can specify for items:

SECTION:FIXED – All parameters in TTItem (from <urn:itemType> to <urn:url>) prior to the extendedField parameter are returned.
SECTION:EXTENDED – Returns all of the extendedFields in TTItem.
SECTION:ATTACHMENTS – Returns all of the attachment sections of TTItem. You can return the next four sections simply by specifying:
```
<urn:specifiedSections>SECTION:ATTACHMENTS</urn:specifiedSections>
```
SECTION:NOTES – Returns all note sections of TTItem.
SECTION:ITEMLINKS – Returns all itemLink sections of TTItem.
SECTION:URLATTACHMENTS – Returns all urlAttachment sections of TTItem.
SECTION:FILEATTACHMENTS – Returns all fileAttachment sections of TTItem.

Below are the possible sections that you can specify for user records:

SECTION:STANDARD – Returns parameters from UserInfo such as the accessType, e-mail address, contact, date and time information, phone number, locale, and the various display preferences.
SECTION:GROUPS – Returns one or more GroupIdentifiers for each group to which the user belongs.
SECTION:SOLUTIONS – Returns the preferredSolution and solutionData elements.

Note: If you specify SECTION:NONE after other sections, those preceding sections will not be returned. For example, SECTION:FIXED,SECTION:NONE,SECTION:EXTENDED will only return the extendedField sections. For the GetUsers call, SECTION:STANDARD,SECTION:NONE,SECTION:GROUPS will only return the groups section.

XML

The following XML shows SectionsOption in the <urn:sections> element of a typical call.

<urn:options>
    <urn:extraOption>
        <urn:name></urn:name>
        <urn:value></urn:value>
    </urn:extraOption>
    <urn:multiOption>CONTINUE-ON-FAILURE</urn:multiOption>
    <urn:sections>SECTIONS-SPECIFIED</urn:sections>
    <urn:specifiedSections>SECTION:FIXED</urn:specifiedSections>
    </urn:limitedField>
</urn:options>