GrooveForms2 Web Service

Article
10/16/2013

The GrooveForms2 service accesses a Groove Forms tool or an InfoPath Forms tool. You can use it to read, update, and create forms records. You can replace the design of a Groove Forms or InfoPath Forms tool with the design from another tool, but cannot make individual updates to the design from this service.

XML Definitions

WSDL

GrooveForms2.wsdl 2.0

with references to:

Core.xsd 2.0
Events.xsd 2.0
Forms2.xsd 2.0

SOAP Operation Namespace

 http://webservices.groove.net/Groove/2.0/Forms2/

HTTP Post URL

https://localhost:port-number/GWS/Groove/2.0/Forms2/service-specific-data

Operations, Complex Types, and Events

The following sections describe the GrooveForms2 operations, complex types, and events.

Operations

Operation	Description
CreateRecords	Creates new Forms tool records.
DeleteRecords	Deletes the specified Forms tool records.
IsFormsToolDesignInitialized	Tests if the Forms tool contains a design definition.
QueryRecords	Returns the Forms tool records that match the specified conditions.
ReadFormFields	Returns information about the fields that are defined in the targeted form.
ReadForms	Returns information about the forms that are defined in the Forms tool.
ReadInfoPathTemplate	Returns the template that defines the specified InfoPath form.
ReadRecords	Returns the specified Forms tool records.
ReadToolProperties	Returns information about the Forms tool.
ReadViews	Returns information about the Views defined in the Forms tool and the columns defined within each view.
ReplaceDesign	Replaces the design of a target forms tool with the design from a source forms tool.
UpdateRecords	Updates Forms tool records as specified in the Forms2RecordDataSet.
UpdateUnreadMark	Marks the specified records as read or unread.

Complex Types

Complex type	Description
FileAttachment	Contains the file attachment metadata and contents.
FileContents	Contains the contents of a file.
Form	Describes a form.
Forms2RecordDataSet	Contains the record schema and record data.
FormsField	Describes a form field.
FormsView	Describes a view.
InfoPathTemplate	Contains the InfoPath definition of a form.
RecordQuery	Specifies the selection conditions for a record query.
ToolProperties	Describes the overall properties of the tool.
ViewColumn	Describes a column in a view.

Events

Event class URN	Event	Description
urn:groove-net:Forms3Event	Forms2RecordAddEventData	Indicates that records were added to a Forms tool.
	Forms2RecordDeleteEventData	Indicates that records were deleted from a Forms tool.
	Forms2RecordUpdateEventData	Indicates that records in a Forms tool were updated.

Remarks

The GrooveForms2 service can access the versions of the Forms tool that are added to workspaces by members running Groove 2007. These are the Groove Forms Tool Version 5.0 and the InfoPath Forms Tool Version 1.0. If you are a member of a workspace created by a user running an earlier version of Groove, the workspace will contain Groove Forms Tool Version 4.0 or earlier. These earlier versions of the Forms tool are accessed by the deprecated GrooveForms Web Service.