abn.GetSubscriptions

This job returns the subscriptions for the logged-in user in DMS Content format.

Additionally, the following parameters can be set to format the returned XML document: RequestType, OutputFormat, OutputLanguage, Baseparams, Offset, Pagesize, MaxHits, Rights, DateFormat, Variants, FileInfo. The description of these parameters can be found in dms.GetResultList.

1. Input Parameters

Name Type Required Description

Flags

INT

Yes

No options currently available — pass 0.

[XML]

BASE64

No

Request in XML format. This can be used to select within the subscribed objects. The query possibilities are limited to linear queries.

2. Output Parameters

Name Type Dependency Description

[Count]

INT

Optional

Number of subscriptions

[XML]

BASE64

Optional

Subscriptions in DMSContent XML format. The following fields are returned:

Object status fields: Number of links; Main type (documents only); Number of pages (documents only); Archiving status (documents only); Checkout status (documents only)

Subscription properties: Creation timestamp (dbname="firstvisit"); Subscription type (dbname="osabotype": 2=OBJECT_CREATED; 3=DATA_CHANGED; 4=DOCUMENT_CHANGED; 38=DOCMOVEDFROMTRAY (treat like OBJECT_CREATED); 39=CREATEREFERENCE); Confirmation status (dbname="osconfirm": 0=do not confirm; 1=confirm; 2=confirmed; 3=password query); ID of the user who triggered the action (dbname="set_user_id"); User GUID of the subscription admin (only set when another user); Comment (dbname="infotext")

Index data of the object

3. Return Value

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

Example: returned XML
<Rowset>
  <Columns>
    <Column object="Photos" type="DOCUMENT" name="links" system="1"
            datatype="INTEGER" dbname="links" ostype="9" size="10">OBJECT_LINKS</Column>
    <Column object="Photos" type="DOCUMENT" name="count" system="1"
            datatype="INTEGER" dbname="anzahl" ostype="9" size="10">OBJECT_COUNT</Column>
    <Column object="Photos" type="DOCUMENT" name="flags" system="1"
            datatype="INTEGER" dbname="flags" ostype="9" size="10">OBJECT_FLAGS</Column>
    <Column object="Photos" type="DOCUMENT" name="lockuser" system="1"
            datatype="INTEGER" dbname="lockuser" ostype="9" size="10">OBJECT_LOCKUSER</Column>
    <Column object="Photos" type="DOCUMENT" name="main_type" system="1"
            datatype="INTEGER" dbname="haupttyp" ostype="9" size="10">OBJECT_MAIN</Column>
    <Column object="Revisit" type="REVISIT" name="firstvisit" system="1"
            datatype="DATETIME" dbname="firstvisit" ostype="9" size="10">REV_FIRSTVISIT</Column>
    <Column object="Revisit" type="REVISIT" name="osabotype" system="1"
            datatype="INTEGER" dbname="osabotype" ostype="9" size="10">REV_OSABOTYPE</Column>
    <Column object="Revisit" type="REVISIT" name="osconfirm" system="1"
            datatype="INTEGER" dbname="osconfirm" ostype="9" size="10">REV_OSCONFIRM</Column>
    <Column object="Revisit" type="REVISIT" name="set_user_id" system="1"
            datatype="INTEGER" dbname="set_user_id" ostype="9" size="10">REV_SET_USER_ID</Column>
    <Column object="Revisit" type="REVISIT" name="osuserid" system="1"
            datatype="TEXT" dbname="osuserid" ostype="X" size="32">REV_OSUSERID</Column>
    <Column object="Revisit" type="REVISIT" name="infotext" system="1"
            datatype="TEXT" dbname="infotext" ostype="X" size="225">REV_INFOTEXT</Column>
    <Column object="Photos" type="DOCUMENT" name="Notes"
            datatype="TEXT" dbname="feld1" ostype="X" size="248">Notes</Column>
  </Columns>
  <Rows>
    <Row id="73543">
      <Value>0</Value>
      <Value>1</Value>
      <Value value="2">NOT_ARCHIVABLE</Value>
      <Value value="0">UNLOCKED</Value>
      <Value value="3">COLOR</Value>
      <Value value="1089804789">14.07.2004 13:33:09</Value>
      <Value value="2">OBJECT_CREATED</Value>
      <Value>1</Value>
      <Value value="53">LIEBE</Value>
      <Value value=""/>
      <Value>New photos</Value>
      <Value>Front view</Value>
    </Row>
  </Rows>
</Rowset>