Share via


GrooveForms2.DeleteRecords Operation

The DeleteRecords operation deletes the specified Forms tool records.

HTTP Post URL

The HTTP Post URL targets the Forms tool. This URI is provided by the GrooveTools.Read operation in the ToolData element.

Input Message Header

GrooveRequestHeader specifies information common to all Groove Web Services, including the Groove Identity URL and the Groove Request key.

Input Message Parameters

<RecordURIList>
  <!-- Array of -->  <URI />
</RecordURIList>
<ExceptionIfDeleted />
Element Data type Description

RecordURIList

Array of xs:anyURI

Identifies the Forms tool records to be deleted. These URLs are returned by the CreateRecords operation and by the RecordURI field in the Forms2RecordDataSet.

ExceptionIfDeleted

xs:boolean

If true and if any of the specified records have previously been deleted, then the operation fails, cancels the entire transaction, and generates an exception. If false, then the operation deletes all specified records that have not previously been deleted.

Output Message Header

GrooveResponseHeader specifies the Response key.

Return Value

None.

Remarks

If this operation fails for a single record for any reason other than that the record has been deleted, then it will fail for all records; the entire transaction will be canceled; and the operation will return a SOAP exception. For example, if the user specified by the Identity URL in the header does not have permission to delete any of the specified records, none of the specified records will be deleted.

See Also

Reference

GrooveForms2 Web Service

Concepts

Deleting Records