Search

 

Module: Editor

Version: 4.3.0 +

Category: DataStore

 

Description

With the VisionReference 'DeleteDataItems' it is possible to delete all dataitems in a Dataset or delete all dataitems for a specific person from the Vision database.

When only a dataset name is provided, then all the dataitems will be deleted from the set. Should only a persons identifier be provided, then the dataitems for this person will be deleted from all datasets. Should both be supplied, then only the dataitems for a specific person will be removed from that particular data. If no parameter is provided, an error code will be returned.

Attention: deleting all the dataitems in a Dataset or deleting all the Dataitems for a person is only possible if there are no resulting not-deleted descendants.

Parameters

Person:

The unique identifier for a person who's dataitems must be deleted

Dataset:

The name of the dataset, in which the dataitems are located

Response

Format

A response will look like this:

<response xmlns="http://www.actuit.nl/futurama/vision/service/response/1.0">
	<resultcode code="00000" success="true">
		<description>Success</description>
	</resultcode>
	<result></result>
</response>

Return codes

The following return codes can be encountered:

  • 00000 - GeneralSuccess: The operation completed successfully.
  • 01000 - GeneralFailError: The operation caused an error. See the error log of the Vision Management Site for more details.
  • 01999 - GeneralFailError: The operation caused an error. See the error log of the Vision Management Site for more details.
  • 51007 - DataStoreDeleteFailure: The delete operation could not be completed.
  • 51003 - DataStoreErrorPersonDoesNotExist: Could not find the person with the provided identifier.
  • 51005 - DataStoreDataSetNotFound: Could not find the dataset with the provided name.
  • 51008 - DataStoreDeleteNoParameters: No valid delete parameters were provided.

Example soapUI message

In the preceding paragraph the parameters of the VisionReference are listed. The values of these parameters are used by Futurama to compose an XML-message. With soapUI it is possible to see the responses depending on the values of the parameters. Below you find an example of an XML-message. This example can be used in your soapUI project to test the connection with Vision and to see the response for a certain combination of parameters.

<soapenv:envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns="http://www.actuit.nl/futurama/vision/service/header/1.0" xmlns:ns1="http://www.actuit.nl/futurama/vision/service/request/1.0">
    <soapenv:header>
        <ns:document path="\\servername\path\datastore.xml" version=""/>
        <ns:futurama path="\\servername\path\futurama" version=""/>
    </soapenv:header>
    <soapenv:body>
        <ns1:request module="DataStore" version="1.0" method="DeleteDataItems">
            <ns1:parameter name="PersonID" value="" type="System.String"/>
			<ns1:parameter name="DataSetName" value="DataSet 1" type="System.String"/>
        </ns1:request>
    </soapenv:body>
</soapenv:envelope>

Within the Header element you find an element 'Document' and an element 'Futurama'. For these elements you have to fill in the path of the Document and the Futurama respectively you also configured in the Apps and Futuramas tab of the Vision Management Site. Within the Request element you find the parameters for this VisionReference. By changing the values of these parameters you can execute different webservice calls.

Related Topics

- DeleteDataItem: for deleting a single DataItem

- DeleteDataItemHierarchy: for deleting a hierarchial tree with DataItems

- StoreData: for storing Xml data in the Vision application

- GetDataItem: for getting the content of a single DataItem

- GetDataItemHierarchy: for getting the full hierarchy of s DataItem and its children

- GetDataItems: for getting the DataItems from a person, or the DataItems from a certain DataSet

Feedback

If you have any questions about this subject or if you want to provide us feedback please send us an e-mail.

Updated: 2013-05-08