Webservice: Bookmark

Bookmarks management and search

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

Method #1: 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 #2: unbookmarkFolder

unbookmarks a folder

Request

Name Type Required Multiple Description
     sid
String Y
     folderId
Long Y

Method #3: 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 #4: 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 #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: deleteBookmark

deletes a bookmark

Request

Name Type Required Multiple Description
     sid
String Y
     bookmarkId
Long Y

Method #7: unbookmarkDocument

unbookmarks a document

Request

Name Type Required Multiple Description
     sid
String Y
     docId
Long Y