Search

 

Module: Editor

Version: 4.1.0 +

Category: Accounts

 

Description

The VisionReference 'ReadData' has to be used to obtain the XML-data that is stored for this account. The data can only be obtained for those users which potentially has access to your application.

Parameters

LogIn:

The username of this account.

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>
		<Email>email@address.com</Email>
		<Status>REINITIALIZED</Status>
		<UseExternalSecurity>false</UseExternalSecurity>
	</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.
  • 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.
  • 11010 - AccountDoesNotExist: This account does not exist.
  • 11011 - AccountNotRelatedToApp: The account exists, but is not related to this application.
  • 11012 - AccountIsNotUnique: The are multiple accounts existing in this application.

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.

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/">
	<s:Header>
		<Futurama path="\\servername\path\futurama" version="1.0" xmlns="http://www.actuit.nl/futurama/vision/service/header/1.0"/>
		<Document path="\\servername\path\data.xml" version="1.0" xmlns="http://www.actuit.nl/futurama/vision/service/header/1.0"/>
	</s:Header>
	<s:Body>
		<Request method="ReadData" version="1.0" module="Accounts" xmlns="http://www.actuit.nl/futurama/vision/service/request/1.0">
			<Parameter name="LogIn" value="User123" type="System.String"/>
			<Parameter name="Password" value="Password13" type="System.String"/>
		</Request>
	</s:Body>
</s: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

- CreateAccount: description on how to create an account.

- ActivateAccount: description on how to activate an account.

- ChangeAccount: description on how to change an existing account.

- GetQuestion: description on how to get the security question the user had chosen.

- GetQuestions: description on how to get the list of security questions.

- Login: description on how to login.

- ReinitializeAccount: description on how to reinitialize an account.

Feedback

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

Updated: 2015-08-07