Subscriber Group Transactions

The ASM web service provides basic subscriber group transactions such as create, update, delete and retrieve.

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 Alemba Support

SubscriberGroupCreate Transaction

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

Input Parameters: SubscriberGroupCreateRequest

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Ignored	-	Ignored on create
sGroupName	String	Yes	“”	Subscriber Group Name
sDescription	String	No	“”	Subscriber Group Description
lPhysicalStatus	Lookup Field	No	0	Subscriber Group Physical Status
lServiceLevel	Lookup Field	No	0	Subscriber Group Service Level
lPartition	Lookup Field	No	0	Partition in which to create the Subscriber Group
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values:SubscriberGroupResponse

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

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

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

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the subscriber group to retrieve
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

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

Argument	Type	Mandatory	Default	Description
sID	String	No. See Transaction Login.	“”	Analyst’s current Session ID
sLoginUserID	String	No. See Transaction Login.	“”	Analyst’s Login ID
sLoginPassword	String	No. See Transaction Login.	“”	Analyst’s Password
sDatabase	String	No. See Transaction Login.	“”	Name of the ASM System for logging in.
lEntityRef	Lookup Field	Yes	-	Reference number of the subscriber group to delete
sReason	String	No	“”	Audit reason
aCustomParameters	Array	No	“”	See Defining Custom Parameters.

Return Values: SubscriberGroupResponse

See SubscriberGroupResponse for more information.