Webservice: Bookmark

Bookmarks management and search

Index Method Request(s) Response Description
1 bookmarkDocument sid
docId
bookmark bookmarks a document
2 deleteBookmark sid
bookmarkId
deletes a bookmark
3 unbookmarkFolder sid
folderId
unbookmarks a folder
4 saveBookmark sid
bookmark
bookmark crates or updates a bookmark
5 bookmarkFolder sid
folderId
bookmark bookmarks a folder
6 getBookmarks sid
bookmark retrieves all the bookmarks of the current user
7 unbookmarkDocument sid
docId
unbookmarks a document

Method #1: bookmarkDocument

bookmarks a document

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y

Response

Name Type Required Multiple Description
     bookmark
WSBookmark Y
          id
Long Y unique identifier
          userId
Long Y
          targetId
Long Y identifier of the referenced object
          title
String Y
          description
String Y
          position
Int Y
          fileType
String Y
          type
Int Y 0 = document, 1 = folder

Method #2: deleteBookmark

deletes a bookmark

Request

Name Type Required Multiple Description
     sid
String Y
     bookmarkId
Long Y

Method #3: unbookmarkFolder

unbookmarks a folder

Request

Name Type Required Multiple Description
     sid
String Y
     folderId
Long Y

Method #4: saveBookmark

crates or updates a bookmark

Request

Name Type Required Multiple Description
     sid
String Y
     bookmark
WSBookmark Y
          id
Long Y unique identifier
          userId
Long Y
          targetId
Long Y identifier of the referenced object
          title
String Y
          description
String Y
          position
Int Y
          fileType
String Y
          type
Int Y 0 = document, 1 = folder

Response

Name Type Required Multiple Description
     bookmark
WSBookmark Y
          id
Long Y unique identifier
          userId
Long Y
          targetId
Long Y identifier of the referenced object
          title
String Y
          description
String Y
          position
Int Y
          fileType
String Y
          type
Int Y 0 = document, 1 = folder

Method #5: bookmarkFolder

bookmarks a folder

Request

Name Type Required Multiple Description
     sid
String Y
     folderId
Long Y

Response

Name Type Required Multiple Description
     bookmark
WSBookmark Y
          id
Long Y unique identifier
          userId
Long Y
          targetId
Long Y identifier of the referenced object
          title
String Y
          description
String Y
          position
Int Y
          fileType
String Y
          type
Int Y 0 = document, 1 = folder

Method #6: getBookmarks

retrieves all the bookmarks of the current user

Request

Name Type Required Multiple Description
     sid
String Y

Response

Name Type Required Multiple Description
     bookmark
WSBookmark Y Y
          id
Long Y unique identifier
          userId
Long Y
          targetId
Long Y identifier of the referenced object
          title
String Y
          description
String Y
          position
Int Y
          fileType
String Y
          type
Int Y 0 = document, 1 = folder

Method #7: unbookmarkDocument

unbookmarks a document

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y