UserResponseOptions

Description

UserResponseOptions holds the Options type, as well as an enumeration to determine if a service should stop on failure and send an error message or continue processing. It also enables you to limit the data that is returned in a response.

Parameters

Name	Type	Description
options	Extension. See Options.	Options extension base. Holds a name value pairing for future elements.
multiOption	MultipleOption	Enumeration element that holds the option to continue processing or stop when an error is encountered.
sections	SectionsOption	Enumeration element that controls the sections of a user record that should be returned.
specifiedSections	string	If SECTIONS-SPECIFIED is used in the sections element above, enter the specified section or sections here. The available options are described below in the Usage section.

Usage

The UserResponseOptions contains the same functionality as MultipleOptions, but it also enables you to limit the return results based on sections of a user record.

You use the following parameters to control service handling and the amount of data that is returned in the response:

multiOption – Use the multiOption element to specify whether the service should continue if an error is encountered, or stop and return an error. If any failures occur, each successive error message is appended to the string that is returned. Multiple error messages are separated by a single newline. If you specify CONTINUE-ON-FAILURE, then failures do not result in a return before all records have been processed. For more information, see MultipleOption.
sections and specifiedSections – Use these elements to specify which parts of a user record should be returned in order to limit the amount of data that is returned. The sections that are not specified are not included in the response. For example, if you only need basic user information in the response, use the specifiedSections parameter to return only the STANDARD section. If you need basic user information and group information, specify STANDARD and GROUPS. For more information, see SectionsOption.
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.
- SECTIONS-NONE – No sections are returned (only the UserIdentifier is returned). Note that the UserIdentifier is always returned, regardless of the value or values specified in the sections parameter.
- SECTIONS-SPECIFIED – Returns sections that you specify.
You can use a comma-separated list in specifiedSections to return only the sections of a user record that you want. For example:
```
<urn:specifiedSections>SECTION:STANDARD,SECTION:GROUPS</urn:specifiedSections>
```
This ensures that only the standard and groups sections of a user record are returned. Here are some of the possible sections you can specify:
- 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:STANDARD,SECTION:NONE,SECTION:GROUPS will only return the groups section.

XML

The following XML shows UserResponseOptions in the <urn:options> element of the GetUsers 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:STANDARD</urn:specifiedSections>
</urn:options>