GetUsersBySynchronisation

From
(Difference between revisions)
Jump to: navigation, search
(Description)
(Parameters)
Line 17: Line 17:
 
|String
 
|String
 
|synchronisationID
 
|synchronisationID
|The ID of the organisation to which the customer record(s) have been synchronised to.  It is usually the name of the organisation.
+
|The ID of the organisation to which the user record(s) have been synchronised to.  It is usually the name of the organisation.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|String
 
|String
 
|synchronisationReference
 
|synchronisationReference
|The ID of the customer record (that has been synchronised) in the external record, i.e. accounting package's Account ID.
+
|The ID of the user record (that has been synchronised) in the external record, i.e. accounting package's Account ID.
 
|---- bgcolor=#EDEDFF
 
|---- bgcolor=#EDEDFF
 
|String
 
|String

Revision as of 22:11, 3 January 2006

Contents

Method

GetUsersBySynchronisationResult getUsersBySynchronisation(UserIDBean userID, String synchronisationID, String synchronisationReference, String afterPK)

Description

Retrieve the user(s), specified by the ID of the user(s) in the external application data to which they are synchronised to, from the user synchronisation table. If the last parameter, i.e. afterPK, is not null, the user record(s) retrieved must have a Primary Key greater than the afterPK.

Parameters

Type Name Description
UserIDBean userID The admin username and password.
String synchronisationID The ID of the organisation to which the user record(s) have been synchronised to. It is usually the name of the organisation.
String synchronisationReference The ID of the user record (that has been synchronised) in the external record, i.e. accounting package's Account ID.
String afterPK The lower bound of the PK of the customer record(s) that can be retrieved.

Return Value

GetCustomersBySynchronisationResult

Personal tools
MediaWiki Appliance - Powered by TurnKey Linux