apidocs

AddUserToFolderSubscribers API

Adds a user to the subscription list of a folder. The subscriber receives email notifications for the selected events on the folder and, optionally, all subfolders and their documents.

Endpoint

/srv.asmx/AddUserToFolderSubscribers

Methods

GET /srv.asmx/AddUserToFolderSubscribers?authenticationTicket=...&FolderPath=...&UserName=...&ON_READ=...&...&IncludeSubObjects=...
POST /srv.asmx/AddUserToFolderSubscribers (form data)
SOAP Action: http://tempuri.org/AddUserToFolderSubscribers

Parameters

Parameter	Type	Required	Description
`authenticationTicket`	string	Yes	Authentication ticket obtained from `AuthenticateUser`.
`FolderPath`	string	Yes	Full infoRouter path to the folder (e.g. `/Finance/Reports`).
`UserName`	string	Yes	Login name of the user to subscribe.
`ON_READ`	boolean	Yes	`true` to notify when documents in the folder are read/viewed.
`ON_CHANGE`	boolean	Yes	`true` to notify when folder or document metadata changes.
`ON_UPDATE`	boolean	Yes	`true` to notify when a new document version is uploaded.
`ON_CHECKOUT`	boolean	Yes	`true` to notify when a document is checked out.
`ON_APPROVE`	boolean	Yes	`true` to notify when a document or workflow step is approved.
`ON_REJECT`	boolean	Yes	`true` to notify when a document or workflow step is rejected.
`ON_COMMENT`	boolean	Yes	`true` to notify when a comment is added to a document.
`ON_MOVE`	boolean	Yes	`true` to notify when a document or subfolder is moved.
`ON_DELETE`	boolean	Yes	`true` to notify when a document or subfolder is deleted.
`ON_CHECKIN`	boolean	Yes	`true` to notify when a document is checked in.
`ON_NEWDOC`	boolean	Yes	`true` to notify when a new document is added to the folder.
`IncludeSubObjects`	boolean	Yes	`true` to also apply this subscription to all subfolders and their documents recursively. `false` to subscribe to the specified folder only.

Response

Success Response

<response success="true"/>

Error Response

<response success="false" error="[901]Session expired or Invalid ticket"/>

Required Permissions

Any authenticated user may call this API. The specified user and folder must both exist.

Example

GET /srv.asmx/AddUserToFolderSubscribers
    ?authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c
    &FolderPath=/Finance/Reports
    &UserName=jdoe
    &ON_READ=false
    &ON_CHANGE=false
    &ON_UPDATE=true
    &ON_CHECKOUT=false
    &ON_APPROVE=false
    &ON_REJECT=false
    &ON_COMMENT=false
    &ON_MOVE=false
    &ON_DELETE=false
    &ON_CHECKIN=false
    &ON_NEWDOC=true
    &IncludeSubObjects=true
HTTP/1.1
Host: yourserver

POST Request

POST /srv.asmx/AddUserToFolderSubscribers HTTP/1.1
Host: yourserver
Content-Type: application/x-www-form-urlencoded

authenticationTicket=3f7a1b2c-4d5e-6f7a-8b9c-0d1e2f3a4b5c&FolderPath=/Finance/Reports&UserName=jdoe&ON_READ=false&ON_CHANGE=false&ON_UPDATE=true&ON_CHECKOUT=false&ON_APPROVE=false&ON_REJECT=false&ON_COMMENT=false&ON_MOVE=false&ON_DELETE=false&ON_CHECKIN=false&ON_NEWDOC=true&IncludeSubObjects=true

Notes

ON_NEWDOC is unique to folder subscriptions and fires when a document is added to the subscribed folder.
When IncludeSubObjects = true, the subscription is applied to all subfolders recursively at the time of the call. New subfolders created later do not automatically inherit the subscription.
If the user is already subscribed to the folder, the existing subscription is replaced with the new event flags.
At least one event flag should be set to true.
To subscribe a user group instead of a single user, use AddUsergroupToFolderSubscribers.
To subscribe to a single document, use AddUserToDocumentSubscribers.

AddUsergroupToFolderSubscribers -“ Subscribe a user group to a folder.
AddUserToDocumentSubscribers -“ Subscribe a user to a specific document.
RemoveUserFromFolderSubscribers -“ Remove a user subscription from a folder.
GetSubscribers -“ List all subscribers of a document or folder.
GetSubscriptions -“ List all subscriptions of the current user.

Error Codes

Error	Description
`[900]`	Authentication failed -“ invalid credentials.
`[901]`	Session expired or invalid authentication ticket.
User not found	No user with the specified `UserName` exists.
Folder not found	No folder was found at the specified `FolderPath`.