GetUsersBySynchronisation
From
(Difference between revisions)
(→Parameters) |
(added information about scrolling through a large result) |
||
| (2 intermediate revisions by one user not shown) | |||
| Line 3: | Line 3: | ||
== Description == | == 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. | + | 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. The number of objects returned by a single call is limited, to aquire a complete list, this method should be called repeatedly with the afterPK parameter set to the primary key of the last element in the result of the previous call, until an empty result is returned. |
== Parameters == | == Parameters == | ||
| Line 25: | Line 25: | ||
|String | |String | ||
|afterPK | |afterPK | ||
| − | |The lower bound of the PK of the | + | |The lower bound of the PK of the user record(s) that can be retrieved. |
|} | |} | ||
== Return Value == | == Return Value == | ||
| − | [[ | + | [[GetUsersBySynchronisationResult]] |
Latest revision as of 23:23, 14 February 2006
Contents |
[edit] Method
GetUsersBySynchronisationResult getUsersBySynchronisation(UserIDBean userID, String synchronisationID, String synchronisationReference, String afterPK)
[edit] 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. The number of objects returned by a single call is limited, to aquire a complete list, this method should be called repeatedly with the afterPK parameter set to the primary key of the last element in the result of the previous call, until an empty result is returned.
[edit] 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 user record(s) that can be retrieved. |
