Arguments

This section provides detailed descriptions of SBM Application Web service arguments. The arguments are the request parameters that can be used by SBM Application Web service operations. The arguments listed here contain one or more parameters, which make up the data that is sent to the Web service. The parameters listed in each argument are either simple or complex types themselves. If the parameter is a complex type, click the link in the Type column for more detail.

The following table lists all supported arguments in alphabetical order, followed by a brief description of each type. Select an argument to view detailed information including:

Description – A brief description of the argument.
Parameters – A table that describes the simple and complex types for each argument. For each complex type, click the type name for a detailed description.
Usage – Any notes, additional details, and considerations are addressed here.
XML – This section contains an example of the actual XML that is sent. The XML provides detailed examples of each element and shows you how to format the expected data.

List of Arguments

Argument	Description
Auth	Supplies credentials and optionally, a host name for licensing.
ChangeHistoryResponseOptions	Holds the MultipleResponseItemOptions type, as well as boolean options for returning change history.
ExtendedData	Placeholder argument for future argument elements.
ExtraValue	Holds a name value pairing for future elements.
FieldObj	Holds complete identification information for a File or URL field and the action to be performed.
FileObj	Describes a file object contained within a File field in the UpdateFileField call
GetTransitionOptions	Indicates the type of transitions to return.
MultipleOption	Specifies whether a service should stop on failure and send an error message or continue processing.
MultipleOptions	Holds the Options type and an enumeration to determine if a service should stop on failure and send an error message or continue processing.
MultipleResponseItemOptions	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. Also enables you to limit the data that is returned in a response.
NameValue	Holds a field and indicates how the field value is set.
NoteAttachmentContents	Holds information, title, and content of a note.
Options	Holds the ExtraValue type, which contains name value pairing for future arguments on certain calls.
PrivilegeInfo	Holds the name and assignment information for a privilege.
ReportData	Holds the identification information for a report that is used by the RunReportXml call.
ReportsFilter	Allows you to filter reports.
ResponseItemOptions	Holds the Options type and enables you to limit the data that is returned in a response.
RoleInfo	Holds the role name and assignment information for users and groups.
SectionsOption	Determines the section of an item to return.
Set-Value-By	Indicates how the value in the NameValue type should be set on an update or create.
Set-Value-Method	Indicates the operation that should be performed with the values in the NameValue type.
URLObj	Describes a URL object contained within a URL field in the UpdateURLField call.
UserResponseOptions	Holds the UserSingleResponseOptions type, as well as an enumeration to determine if a service should stop on failure and send an error message or continue processing.
UserSingleResponseOptions	Holds the Options type and enables you to limit the data that is returned in a response.