GetUsersBySynchronisationResult

From
(Difference between revisions)
Jump to: navigation, search
(Description)
(Success Mode)
 
Line 3: Line 3:
  
 
== Success Mode ==
 
== 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.
+
Returns an array of zero or more [[UserBean]] in the customers field which match the criteria described above. The field may also be null, indicating there was no record found.
  
 
== Failure Modes ==
 
== Failure Modes ==

Latest revision as of 22:14, 3 January 2006

[edit] 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

[edit] Success Mode

Returns an array of zero or more UserBean in the customers field which match the criteria described above. The field may also be null, indicating there was no record found.

[edit] 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