Responses

This section provides detailed descriptions of SBM Application Web service responses. The responses are the data elements that are returned from SBM Application Web service operations. The responses listed here contain one or more parameters, which make up the data being sent back from the Web service. The parameters listed in each argument are either simple or complex types themselves. If the type is complex, a link to further detail of that type is provided in the Type column.

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

Description – A brief description of the response.
Parameters – A table that describes the simple and complex types for each response. 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 Responses

Response	Description
AccessType	Holds the user's product access type.
ApplicationData	Holds the name and other information about an application.
Change	Contains the field that was changed, plus prior and new values.
DatePreference	Indicates a user's preferred date format.
Field	Used to completely describe a field.
FieldObject	Describes the individual file or URL object contained within a File or URL field.
FieldObjectHolder	Holds one or more FieldObjects and any errors for objects that were not successfully returned.
FieldSelectionsHolder	Holds information about a field, its selection type, selection style, and its values.
Field-Type	Indicates the type of field.
FieldWithValue	Combines the Field response type with the field's value.
GetReportsResult	Holds the number of reports returned, as well as high-level information for each report.
GetStateChangeHistoryResult	Holds the state change history for an item and the query range used to return the history.
GroupMembersHolder	Holds a group name and users that belong to that group.
ItemChangeHistoryHolder	Holds the change history for an item.
ModScriptHolder	Holds the results of a RunModscript call.
NoteLoggerInfo	Holds the e-mail address of the E-mail Recorder.
OrderBy	Holds the ORDER BY definition for a report.
Point	Identifies the location of an object in the graphical workflow.
PrivilegeHolder	Holds privilege information and any applicable error messages.
ProjectData	Holds the name and other information about a project.
ReportDefinition	Holds the columns and any ORDER BY definition for a report.
ReportInfo	Holds a high-level description for a report.
ReportResult	Holds the actual item data returned in a report.
RoleHolder	Holds role information and any applicable error messages.
RunReportResult	Holds the results or output of a report.
RunReportXmlResult	Holds the results or output of a report in XML format.
SelectionOption	Holds information about field selections.
Size	Holds information about the size of objects in the graphical workflow.
SolutionData	Holds the name and other information about a solution.
StateChangeHistory	Holds the state change history for an item.
Status	Holds status information for a Web service operation.
StatusEnum	Indicates the type of status.
TableData	Holds the name and other information about a table.
TimePreference	Indicates a user's preferred time format.
Transition	Holds the name and other information about a transition.
TTItemHolder	Holds all of the SBM field information for an item and any applicable error messages.
TTItemList	Contains the items and the total count of items that are returned from GetItemsByQuery.
UserHolder	Holds user information and any applicable error messages.
UserInfo	Holds the name and additional information about a user.
UserSolutionData	Holds an ordered-list of applications that are accessible to a user. Also returns the user's home page report for each application and the preferred project list.
Workflow	Holds information about a graphical workflow.
WorkflowBand	Holds graphical workflow information for a swimlane.
WorkflowComment	Hold graphical workflow information for an annotation.
WorkflowHolder	Holds graphical workflow information and any applicable error messages.
WorkflowState	Holds graphical workflow information for a state.
WorkflowTransition	Holds graphical workflow information for a transition.