Search

 

Module: Editor

Version: 4.1.0 +

Category: Accounts

 

Description

The VisionReference 'Login' has to be used to verify the identity of an user. Only with the correct combination of the username and the password the user can succesfully login to your webapplication. 

Parameters

LogIn:

The username of the account.

Password:

The password of the account. This password is either a temporary password the user has to change or the password the user had chosen itself.

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="AuthenticateResult">
        <email>email@address.com</email>
        <login>User123</login>
        <status>ACTIVATED</status>
        <lastvisit>2014-02-26T14:03:38.693</lastvisit>
    </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.
  • 11014 - This policy uses external security (Futurama version 5.3.0 +)
  • 11100 - PasswordNotCorrect: The submitted password is not valid.
  • 11010 - AccountDoesNotExist - The submitted account does not exist.
  • 11050 - StatusInvalid - This account is invalid for this operation.
  • 11051 - StatusBlocked - This account has been blocked.
  • 11052 - StatusDeactivated - This account has been deactivated.

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\document.xml" version="1.0">
			<ns:subdocument>
			</ns:subdocument>
		</ns:document>
	</soapenv:header>
	<soapenv:body>
		<request method="LogIn" 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>
	</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

- ReadData: description on how to read data from a person.

- 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.

- 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: 2014-03-14