retrieveLinkedCustomers (CRX010A) – allows the user to retrieve the customer information linked to a contact ID using the current session (registered). Once retrieved, displays the list of customers for the user too select, then use setCurrentCustomer to ensure that is the customer used. Otherwise the appropriate error message(s) will be returned.
N.B. The user needs to call the createSession web service for a registered user before calling this web service.
In most environments there will only be one customer per contact in which case there is no need to use this service. In some B2B environments a contact might buy for multiple customers. Internal users (company employees with iSeries profiles can be set up as contacts and sign on with their iSeries profile/password) have access to all customers so retrieveLinkedCustomers needs to be limited with page limits and search text.
Input parameters:
| Field ID | Description | Type | Length | Constraints |
| sessionId | The session ID for the logged in user | String | Mandatory | |
| searchText | Search text | String | Optional | |
| recordLimit | Record limit is the maximum number of records to be returned as a page | Integer | Optional | |
| recordKey | Record Key. Used in conjunction with record limit. This value is returned with the previous page and is used to ensure the next page starts with the correct record. Do not send with the request for the first page as a blank value can produce unpredictable results. | String | Optional |
Response:
| Field ID | Description | Type | Occurrence |
| customers | Customers | customers
Complex Type |
|
| recordKey | Record Key – for page control use as input for request of next page | ||
| recordCount | Record Count – number of records on the page | ||
| messageSet | Message set | messageSetDataType |
