dms.GetSubscriptions

This job returns the active subscriptions of the current user as an XML list — the DMS counterpart to the subscription functions of the abn engine.

This job is not described in the official enaio® documentation but is listed as known in the DMS engine overview’s "Undocumented Endpoints" section. This description was reconstructed from the call code of the enaio-jobs-custom template. On the server, the job prefix is uppercase (DMS.GetSubscriptions); enaio® servers accept both spellings.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

Bitfield controlling the response. The call code uses the default 4112 (0x1010).

RequestType

STRING

Yes

Filter by subscription status (e.g. HOL for active subscriptions). Call-code default: HOL.

MaxHits

INT

Yes

Maximum number of returned entries. Call-code default: 1000.

2. Output Files

Name Description

JobResponseFile

List of subscriptions as a UTF-8-encoded XML stream.

3. Return Value

(INT): 0 = job successful, otherwise error code.

For further return values see Error Codes.

4. See Also