Search

 

Module: Editor

Version: 5.1.0 +

Category: Data

 

Description

Allows you to read the person XML you have imported into Futurama Vision. The difference with the VisionReference ReadData within the category 'Accounts' is that with this VisionReference it is only possible to retrieve the person XML in case for this person an account is created. This is not necessary for the ReadData VisionReference in the category 'Data'. 

Parameters

Identifier:

The PersonKey (see paragraph 'Required data') of the person which XML has to be retrieved .

Response

Format

<response xmlns="http://www.actuit.nl/futurama/vision/service/response/1.0">
	<resultcode code="00000" success="true">
		<description>Success</description>
	</resultcode>
	<result xsi:type="ReadDataResult">
		<policyxml xmlns="http://www.ActuIT.nl/Futurama/Vision/">
			<policy internalid="Policy123">
				<data>
					<!-- individual XML -->
				</data>
			</policy>
		</policyxml>
		<status>INITIALIZED</status>
		<!-- from Futurama 5.3.0 -->
	</result>
</response>

Within the Result element you find the result of your VisionReference webservice call. Use soapUI to get a quick overview of the responses (see the paragraph 'Example soapUI message').

Return codes

The following return codes can be encountered:

  • 00000 - GeneralSuccess: The operation completed successfully
  • 01999 - GeneralFailError: The operation caused an error
  • 11010 - AccountDoesNotExist - This account does not exist.
  • 11011 - AccountNotRelatedToApp - Account exists, but is not related to this Application
  • 11012 - AccountIsNotUnique - Multiple accounts with this name exist in relation to this App
  • 11013 - AccountPolicyDoesNotExist - This policy does not exist

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:futurama path="\\servername\path\futurama" version="1.0"/>
		<ns:document path="\\servername\path\data.xml" version="1.0">
			<ns:subdocument/>
		</ns:document>
	</soapenv:header>
	<soapenv:body>
		<request method="ReadData" version="1.0" module="Data" xmlns="http://www.actuit.nl/futurama/vision/service/request/1.0">
			<parameter name="Identifier" value="User123" type="System.String"/>
		</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

WriteMessage: Allows you to log information in Vision about (and/or activated by) a certain event in your application.

- ImportData: Manual page not yet available.

Feedback

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

Updated: 2014-03-17