GetUsersBySynchronisationResult

From
(Difference between revisions)
Jump to: navigation, search
 
(Description)
Line 1: Line 1:
 
== Description ==
 
== Description ==
Returns either the users details, if they can be found, no details if the cannot be found, or an access denied failure.
+
Returns an array of [[UserBean]] for user(s) which have an ID in the external record matching the value specified in the synchronisationReference parameter and has been synchronised to the organisation (flag) specified in the synchronisationID parameter
  
 
== Success Mode ==
 
== Success Mode ==

Revision as of 22:13, 3 January 2006

Description

Returns an array of UserBean for user(s) which have an ID in the external record matching the value specified in the synchronisationReference parameter and has been synchronised to the organisation (flag) specified in the synchronisationID parameter

Success Mode

Populates the userDetail with a UserBean containing all the user's details, or null if the user cannot be found, but you did have permission to run the method.

Failure Modes

One or more failure fields will be populated with a failure object (will contain a non-null reference) indicating the nature of the failure, with relevant information.

Type Description
AccessDeniedFailure The username or password was incorrect, or lacked the right to complete this function.
Personal tools
MediaWiki Appliance - Powered by TurnKey Linux