Webservice: Audit

---

Method #1: unsubscribe

unsubscribes the current user to notifications emitted by documents or folders

Request

Name		Type		Required		Multiple		Description
sid		String		Y
ids		Long		Y		Y		identifiers of folders or documents
type		String		Y				the type of subscription: folder or document

---

Method #2: subscribe

subscribes the current user to notifications emitted by documents or folders

Request

Name		Type		Required		Multiple		Description
sid		String		Y
ids		Long		Y		Y		identifiers of folders or documents
type		String		Y				the type of subscription: folder or document
events		String		Y				comma separated list of event codes you want to subscribe to

---

Method #3: getMessages

lists messages routed to the current user

Request

Name		Type		Required		Multiple		Description
sid		String		Y

Response

Name		Type		Required		Multiple		Description
message		WSMessage		Y		Y
id		Long		Y				unique identifier
messageText		String		Y
author		String						who wrote the message
subject		String		Y
date		String		Y				format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
read		Int		Y				can be 0 or 1
type		Int		Y				0 = system, 1 = notification
priority		Int		Y

---

Method #4: getDocumentHistory

gets the history of a given document

Request

Name		Type		Required		Multiple		Description
sid		String		Y
docId		Long		Y

Response

Name		Type		Required		Multiple		Description
history		WSHistory		Y		Y
type		String		Y
id		Long		Y
docId		Long						document identifier
folderId		Long		Y
userId		Long		Y
date		String		Y				format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
username		String		Y
userLogin		String		Y
event		String		Y
comment		String		Y
version		String		Y
path		String		Y
pathOld		String		Y
sessionId		String		Y
filename		String		Y
filenameOld		String		Y
ip		String		Y

---

Method #5: getHistory

lists all the histories in the given tree

Request

Name		Type		Required		Multiple		Description
sid		String		Y
folderId		Long		Y				the tree to inspect
oldestDate		String						oldest date to use as filter (use the format 'yyyy-MM-dd HH:mm:ss')
events		String				Y		array of event codes to use as filter
max		Integer						the maximum number of records

Response

Name		Type		Required		Multiple		Description
history		WSHistory		Y		Y
type		String		Y
id		Long		Y
docId		Long						document identifier
folderId		Long		Y
userId		Long		Y
date		String		Y				format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
username		String		Y
userLogin		String		Y
event		String		Y
comment		String		Y
version		String		Y
path		String		Y
pathOld		String		Y
sessionId		String		Y
filename		String		Y
filenameOld		String		Y
ip		String		Y

---

Method #6: markAsRead

marks a set of messages as read by the current user

Request

Name		Type		Required		Multiple		Description
sid		String		Y
ids		Long		Y		Y		identifiers of the messages that have to be marked as read

---

Method #7: getSubscriptions

lists all the subscriptions of the current user

Request

Name		Type		Required		Multiple		Description
sid		String		Y

Response

Name		Type		Required		Multiple		Description
subscription		WSSubscription		Y		Y
id		Long		Y				unique identifier
name		String		Y
description		String
creation		String		Y				the creation date; format must be 'yyyy-MM-dd HH:mm:ss' or 'yyyy-MM-dd'
objectId		Long		Y				identifier of the referenced object(a document or folder)
fileType		String						in case of document, it's file type
type		String		Y				must be document or folder
events		String						comma separated list of event codes you want to subscribe to