GetCustomersBySynchronisation
From
(Difference between revisions)
(→Description) |
(added information about scrolling through a large result) |
||
| (12 intermediate revisions by one user not shown) | |||
| Line 1: | Line 1: | ||
== Method == | == Method == | ||
| − | [[ | + | [[GetCustomersBySynchronisationResult]] getCustomersBySynchronisation([[UserIDBean]] userID, String synchronisationID, String synchronisationReference, String afterPK) |
== Description == | == Description == | ||
| − | + | Retrieve the customer(s), specified by the ID of the customer(s) in the external application data to which they are synchronised to, from the customer synchronisation table. If the last parameter, i.e. afterPK, is not null, the customer 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 15: | Line 15: | ||
|The admin username and password. | |The admin username and password. | ||
|---- bgcolor=#EDEDFF | |---- bgcolor=#EDEDFF | ||
| − | | | + | |String |
| − | | | + | |synchronisationID |
| − | | | + | |The ID of the organisation to which the customer record(s) have been synchronised to. It is usually the name of the organisation. |
| + | |---- bgcolor=#EDEDFF | ||
| + | |String | ||
| + | |synchronisationReference | ||
| + | |The ID of the customer record (that has been synchronised) in the external record, i.e. accounting package's Account ID. | ||
| + | |---- bgcolor=#EDEDFF | ||
| + | |String | ||
| + | |afterPK | ||
| + | |The lower bound of the PK of the customer record(s) that can be retrieved. | ||
|} | |} | ||
== Return Value == | == Return Value == | ||
| − | [[ | + | [[GetCustomersBySynchronisationResult]] |
Latest revision as of 23:22, 14 February 2006
Contents |
[edit] Method
GetCustomersBySynchronisationResult getCustomersBySynchronisation(UserIDBean userID, String synchronisationID, String synchronisationReference, String afterPK)
[edit] Description
Retrieve the customer(s), specified by the ID of the customer(s) in the external application data to which they are synchronised to, from the customer synchronisation table. If the last parameter, i.e. afterPK, is not null, the customer 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 customer record(s) have been synchronised to. It is usually the name of the organisation. |
| String | synchronisationReference | The ID of the customer 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. |
