| Layer | Management |
| Direction | To CallGem |
| Type of Service | CG |
| Interface ID | MA |
| Message Purpose | This message is sent by the control application to CallGem to request a list of Tenants currently provisioned. |
| Example | E1\TXABCTenants |
| Explanation | The control application is requesting (with transaction identifier ABCTenants) a list of all tenants currently provisioned. |
| Notes |
Produces
TenantData [Z1] responses from CallGem. If an agent is in any state other than 'logged in and working'
at the time the request is made, he will not be included in the subsequent
TenantData [Z1] message set.
For on overview of the query process, see Resource Enumeration API From V10.6.263 there is a change to Enumeration behaviour when using the PersistToken (PS) parameter - see Resource Enumeration API. |
| Last Changed | 9.3.0.9 |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| CS | RateControl | string | false | 1 | 1000000 | From V10.6.660 - The number of event messages per second that the subscriber can handle during rollforward after re-subscribing. Defaults to 100 (per PersistToken). See Resource Enumeration API. |
| PS | PersistToken | string | false | 1 | 80 | Persist token. This tells CallGem to persist this transaction even if the socket connection from the originator fails. The transaction will buffer events in anticipation of reconnect and re-issue of the transaction. |
| TK | Token | string | false | 1 | 80 | Token parameter |
| TX | TransactionIdentifier | string | true | 1 | 87 |
Only 80 characters used by integrators. 7 characters reserved for internal
use.
Used by subsequent messages from CallGem to identify the corresponding request. Must be unique across all requests. |