# Subscriber Group Transactions

{% hint style="warning" %}
**Limited Support/End of Life Capabilities**

The Classic API has been replaced by the Alemba RestFul API.  While we will continue to support the Classic API for clients that are still using it, no further development will be done.

If you need to request a hotfix or support for these features, please contact [<mark style="color:blue;">**Alemba Support**</mark>](https://alemba.help/production/Portal.aspx)
{% endhint %}

### SubscriberGroupCreate Transaction

The SubscriberGroupCreate transaction can be used to create a new subscriber group record and save its details.

#### Input Parameters: SubscriberGroupCreateRequest

<table data-header-hidden><thead><tr><th></th><th width="117"></th><th></th><th width="102"></th><th></th></tr></thead><tbody><tr><td>Argument</td><td>Type</td><td>Mandatory</td><td>Default</td><td>Description</td></tr><tr><td>sID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s current Session ID</td></tr><tr><td>sLoginUserID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Login ID</td></tr><tr><td>sLoginPassword</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Password</td></tr><tr><td>sDatabase</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Name of the ASM System for logging in.</td></tr><tr><td>lEntityRef</td><td>Lookup Field</td><td>Ignored</td><td>-</td><td>Ignored on create</td></tr><tr><td>sGroupName</td><td>String</td><td>Yes</td><td>“”</td><td>Subscriber Group Name</td></tr><tr><td>sDescription</td><td>String</td><td>No</td><td>“”</td><td>Subscriber Group Description</td></tr><tr><td>lPhysicalStatus</td><td>Lookup Field</td><td>No</td><td>0</td><td>Subscriber Group Physical Status</td></tr><tr><td>lServiceLevel</td><td>Lookup Field</td><td>No</td><td>0</td><td>Subscriber Group Service Level</td></tr><tr><td>lPartition</td><td>Lookup Field</td><td>No</td><td>0</td><td>Partition in which to create the Subscriber Group</td></tr><tr><td>sReason</td><td>String</td><td>No</td><td>“”</td><td>Audit reason</td></tr><tr><td>aCustomParameters</td><td>Array</td><td>No</td><td>“”</td><td>See Defining Custom Parameters.</td></tr></tbody></table>

#### Return Values:SubscriberGroupResponse <a href="#subscribergroupresponse" id="subscribergroupresponse"></a>

| Argument   | Type      | Description                             |
| ---------- | --------- | --------------------------------------- |
| nEntityRef | Integer   | Newly created subscriber group ref      |
| sMessage   | String    | Error/Warning message returned from API |
| Ret        | APIReturn | Error/Warning number returned from API  |

### SubscriberGroupUpdate Transaction

The SubscriberGroupUpdate transaction can be used to update an existing subscriber group record and save its details.

#### Input Parameters: SubscriberGroupUpdateRequest

**SubscriberGroupUpdateRequest**

<table data-header-hidden><thead><tr><th></th><th width="125"></th><th></th><th width="89"></th><th></th></tr></thead><tbody><tr><td>Argument</td><td>Type</td><td>Mandatory</td><td>Default</td><td>Description</td></tr><tr><td>sID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s current Session ID</td></tr><tr><td>sLoginUserID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Login ID</td></tr><tr><td>sLoginPassword</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Password</td></tr><tr><td>sDatabase</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Name of the ASM System for logging in.</td></tr><tr><td>lEntityRef</td><td>Lookup Field</td><td>Yes</td><td>-</td><td>Reference number of the subscriber group to update</td></tr><tr><td>sGroupName</td><td>String</td><td>No</td><td>(As is)</td><td>Subscriber Group Name</td></tr><tr><td>sDescription</td><td>String</td><td>No</td><td>(As is)</td><td>Subscriber Group Description</td></tr><tr><td>lPhysicalStatus</td><td>Lookup Field</td><td>No</td><td>(As is)</td><td>Subscriber Group Physical Status</td></tr><tr><td>lServiceLevel</td><td>Lookup Field</td><td>No</td><td>(As is)</td><td>Subscriber Group Service Level</td></tr><tr><td>lPartition</td><td>Lookup Field</td><td>No</td><td>(As is)</td><td>Partition in which to create the Subscriber Group</td></tr><tr><td>sReason</td><td>String</td><td>No</td><td>“”</td><td>Audit reason</td></tr><tr><td>aCustomParameters</td><td>Array</td><td>No</td><td>“”</td><td>See Defining Custom Parameters.</td></tr></tbody></table>

#### Return Values: SubscriberGroupResponse

See SubscriberGroupResponse for more information.

### SubscriberGroupRetrieve Transaction

The SubscriberGroupRetrieve transaction can be used to return the details of an existing subscriber group record.

#### Input Parameters: SubscriberGroupEntityRequest

<table data-header-hidden><thead><tr><th></th><th width="119"></th><th></th><th width="96"></th><th></th></tr></thead><tbody><tr><td>Argument</td><td>Type</td><td>Mandatory</td><td>Default</td><td>Description</td></tr><tr><td>sID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s current Session ID</td></tr><tr><td>sLoginUserID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Login ID</td></tr><tr><td>sLoginPassword</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Password</td></tr><tr><td>sDatabase</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Name of the ASM System for logging in.</td></tr><tr><td>lEntityRef</td><td>Lookup Field</td><td>Yes</td><td>-</td><td>Reference number of the subscriber group to retrieve</td></tr><tr><td>aCustomParameters</td><td>Array</td><td>No</td><td>“”</td><td>See Defining Custom Parameters.</td></tr></tbody></table>

#### Return Values: SubscriberGroupRetrieveResponse

| Argument  | Type      | Description                            |
| --------- | --------- | -------------------------------------- |
| Ret       | APIReturn | Error/Warning number                   |
| sMessage  | String    | Error/Warning message                  |
| ResultSet | DataSet   | ResultSet containing attribute details |

### SubscriberGroupDelete Transaction

#### Input Parameters: SubscriberGroupDeleteRequest

<table data-header-hidden><thead><tr><th></th><th width="104"></th><th></th><th width="102"></th><th></th></tr></thead><tbody><tr><td>Argument</td><td>Type</td><td>Mandatory</td><td>Default</td><td>Description</td></tr><tr><td>sID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s current Session ID</td></tr><tr><td>sLoginUserID</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Login ID</td></tr><tr><td>sLoginPassword</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Analyst’s Password</td></tr><tr><td>sDatabase</td><td>String</td><td>No. See Transaction Login.</td><td>“”</td><td>Name of the ASM System for logging in.</td></tr><tr><td>lEntityRef</td><td>Lookup Field</td><td>Yes</td><td>-</td><td>Reference number of the subscriber group to delete</td></tr><tr><td>sReason</td><td>String</td><td>No</td><td>“”</td><td>Audit reason</td></tr><tr><td>aCustomParameters</td><td>Array</td><td>No</td><td>“”</td><td>See Defining Custom Parameters.</td></tr></tbody></table>

#### Return Values: SubscriberGroupResponse

See SubscriberGroupResponse for more information.