Service: ContactAuthenticationPublicService

Version: 2_8 (other versions, change log, ZUMSTEIN_V4.1-SNAPSHOT) END OF LIFE. Please consider switching to the latest version of the webservices, because this version may be removed anytime from support.

SOAP Demo endpoint: https://myinstit.ws.secutix.com/tnco/external-remoting/com.secutix.service.contact.v2_8.ContactAuthenticationPublicService.webservice?wsdl

To get the endpoint for your own institution, replace "myinstit" (just after https://) in the url by your own institution code.

For further documentation and examples, please check in Platform Website.

Methods:

• authenticate: This method is used to authenticate a contact based on his login and password and more attributes available from {@link ContactAuthenticationData}.
• changePassword: This method allows to modify the current password of a contact identified by its contact number.
• listAuthorizedPOS: This method returns the list of point of sales authorized for given contact who needs to be authenticated.
• recoverPassword: This method allows a contact identified by the given email address to request a new randomly generated password for authentication.

authenticate

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method is used to authenticate a contact based on his login and password and more attributes available from {@link ContactAuthenticationData}.

Parameters

contactAuthenticationData

ContactAuthenticationData

ContactAuthenticationData
contactTypeScope	(INDIVIDUAL|STRUCTURE| ANY)
identification	String
identityProvider	String
login	String
password	String
pointOfSalesId	Long
providerUserReference	String
rememberMe	boolean
socialLogin	boolean
structureContactNumber	String (20)
targetContactNumber	String (20)
uniqueToken	String

Return value

ContactAuthenticationResult
contactNumber	String (20)
identification	String
uniqueToken	String
requestId	Integer
statusCode	String (8)
statusDetail	String

changePassword

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows to modify the current password of a contact identified by its contact number.

Parameters

contactNumber	String (20)	Mandatory number of the contact to alter its password; mandatory.
currentPassword	String	Mandatory current contact password; mandatory;
newPassword	String	Mandatory new password if the existing password match; mandatory.

Return value

WebMethodResult
requestId	Integer
statusCode	String (8)
statusDetail	String

listAuthorizedPOS

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method returns the list of point of sales authorized for given contact who needs to be authenticated.

Parameters

contactNumber

String (20)

- the contact number who needs to be authenticated.

Return value

ListAuthorizedPOSResult
pointOfSales	List of PosSummary
requestId	Integer
statusCode	String (8)
statusDetail	String

PosSummary
pointOfSalesId	Long
url	String (255)

recoverPassword

REST_RPC	MOSA	CUBE	PLAY
SOAP	MOSA	CUBE	PLAY

This method allows a contact identified by the given email address to request a new randomly generated password for authentication. The old password is automatically invalidated.

Parameters

email	String	Mandatory Mandatory, email of the contact
contactNumber	String (20)	Mandatory Only mandatory and to be considered for relay contacts.(STX-5744) Since the email is not unique and this function can used for individual contact and structure contact, we add a new parameter contactNumber to help identify the right contact to modify.
contactTypeScope	(INDIVIDUAL|STRUCTURE| ANY)

Return value

PasswordRecoveryResult
email	String
requestId	Integer
statusCode	String (8)
statusDetail	String