Webservice: Reading Request

reading requests [Commercial editions only]

Index Method Request(s) Response Description
1 askReadingConfirmation sid
docIds
userIds
groupIds
alertConfirmation
comment
asks some users to confirm the reading of a set of documents.
2 getUnconfirmedReadings sid
Gets the list of all the unconfirmed readings
3 confirmReading sid
readingId
version
Confirms a reading request

Method #1: askReadingConfirmation

asks some users to confirm the reading of a set of documents.

Request

Name Type Required Multiple Description
     sid
String Y
     docIds
Long Y Y identifiers of the documents
     userIds
Long Y Y identifiers of the recipient users
     groupIds
Long Y Y identifiers of the groups whose members must be considered as recipients
     alertConfirmation
Boolean Y if the requestor must be notified on reading confirmation
     comment
String Y an optional message to include in the notification

Method #2: getUnconfirmedReadings

Gets the list of all the unconfirmed readings

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
    
WSReadingRequest Y Y
          id
Long Y unique identifier
          docId
Long Y the document identifier
          fileName
String Y the document file name
          fileVersion
String Y the document file version
          userId
Long Y identifier of the user that is required to confirm
          userLogin
String Y username of the user that is required to confirm
          username
String Y complete name of the user that is required to confirm
          requestorId
Long Y identifier of the requestor user
          requestorLogin
String Y username of the requestor
          requestorName
String Y complete name of the requestor
          confirmed
Date Y when the reading has been confirmed
          alertConfirmation
Int Y if the reading must be notified
          requestComment
String Y comment left by the requestor

Method #3: confirmReading

Confirms a reading request

Request

Name Type Required Multiple Description
     sid
String Y
     readingId
Long Y identifier of the reading request
     version
String Y exact version of the document being confirmed