| Layer | Campaign Manager |
| Direction | To CallGem |
| Type of Service | CM |
| Interface ID | DE |
| Message Purpose | Get Portions (list apportionment ratios) for the campaigns linked to the specified master campaign |
| Example | CM:DE:GA\TDdefault\CNCustCare\OIxyz |
| Explanation | A client requests the list of portions for the master campaign CustCare. Portion data is returned in the Portion Data [AB] message. |
| Notes | See also SDMP Message Protocol |
| Parameters | ||||||
|---|---|---|---|---|---|---|
| Code | Name | Type | Mandatory? | Min Val | Max Val | Description |
| AP | ApportionmentType | int | false | 0 | 1 | This parameter is optional. The specified apportionment type will be used to generate the apportionment data. When not supplied the current master campaign parameter value will be used. |
| CN | CampaignName | string | true | 1 | 80 | Campaign Name parameter that identifies the master campaign. |
| OI | OriginatorID | string | true | 1 | 255 |
Originator ID. A token identifying the originator of the message.
The Originator ID (OI) parameter does not need to be specified if using the RouterNet method and event API. RouterNet appends the Originator ID by default. |
| TD | TenantDescriptor | string | true | 1 | 80 |
Mandatory when operating in
Multi-Tenancy. Otherwise it must not be used.
This parameter is alphanumeric and identifies to which tenant this message applies. Typically contains a company name. |
| TK | Token | string | false | 1 | 80 | Token parameter |
| TX | TransactionIdentifier | string | true | 1 | 87 | From V10.7.1025 - Transaction identifier uniquely identifying this request. |