GetCustomersBySynchronisationResult

From
(Difference between revisions)
Jump to: navigation, search
 
(Description)
Line 1: Line 1:
 
== Description ==
 
== Description ==
Returns the details of the customers requested, or a reason why the data could not be obtained.
+
Returns an array of [[CustomerBean]] for customer(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:03, 3 January 2006

Description

Returns an array of CustomerBean for customer(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

The customers field is populated with an array of CustomerBean containing the details of the customer record(s). The field may also be null, indicating there was no record found.

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