...
GET | /favourites/bookmarks/{id} |
|---|
User permission required
...
Status codes
- 200 = Bookmark found
- 401 = User is not authorized
- 404 = Bookmark ID not found
- 500 = Internal server error
Related Use Case(s)
- All info of a bookmark is retrieved to display it in the frontend.
...
FA03 | Retrieve bookmarks
GET | /favourites/bookmarks |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| folderIds | ID of folder(s) | Multiple | - |
Status codes
- 200 = Bookmark(s) found
- 400 = Missing some search params
- 401 = User not authorized
- 500 = Internal server error
Related Use Case(s)
- Bookmarks according to certain criteria are retrieved to be displayed in the frontend.
...
FA04 | Update bookmark
PUT | /favourites/bookmarks/{id} |
|---|
...
- The parameter folderId defines all lists (folders) to add the bookmark.
- Duplicates for folderIds are not possible because of using a set.
- The folderId favorites is always used. If no folderId is specified, only favorites is used.
- If the folder favorites not exists, because a new user adds the first bookmark, then the folder favorites is created.
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| userId | ID of user | Once | - |
| itemIds | List of IDs | Multiple | - |
| offset | Beginn offset of results | Once | -1 |
| size | Size data of results | Once | -1 |
Status codes
- 200 = Bookmark updated
- 401 = User is not authorized
- 404 = Bookmark ID not found
- 500 = Internal server error
Related Use Case(s)
- UC07 | Change bookmark description
- A user changes the description of a bookmark.
- A user changes the description of a bookmark.
...
FA05 | Delete bookmark
DELETE | /favourites/bookmarks/{id} |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| folderIds | ID of folder(s) | Multiple | - |
Status codes
- 200 = Bookmark deleted
- 401 = User is not authorized
- 404 = Bookmark ID not found
- 500 = Internal server error
Related Use Case(s)
- UC06 | Delete bookmarks in All Favorites
- A user deletes a bookmark from favorites (and the rest of the lists).
- A user deletes a bookmark from favorites (and the rest of the lists).
...
FA06 | Create folder
POST | /favourites/folders |
|---|
User permission required
...
Status codes
- 200 = Folder created
- 400 = Title attribute is missing
- 401 = User is not authorized
- 409 = Folder already exists
- 500 = Internal server error
Related Use Case(s)
- UC05 | Add personal folder
- A user creates a personal folder.
- A user creates a personal folder.
...
FA07 | Add bookmark to folder
...
- A bookmark could not be added to the main folder (favorites), because it is added to this folder when you create a bookmark.
- The folder ID and bookmark ID must exist before adding something.
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| bookmarkId | ID of bookmark to add | Once | - |
Status codes
- 200 = Bookmarks added
- 400 = Bookmark ID not exist
- 401 = User is not authorized
- 404 = Folder ID not exist
- 500 = Internal server error
Related Use Case(s)
- UC02 | Assign bookmarks to selected lists
- A user stores bookmarks (additionally) in personal lists.
- UC08 | Copy bookmarks from All Favorites to personal lists
- A user copies bookmarks into personal lists.
- UC14 | Copy bookmarks to another personal list
- A user copies bookmarks from a personal list to other personal lists.
- A user copies bookmarks from a personal list to other personal lists.
...
FA08 | Retrieve folder
GET | /favourites/folders/{id} |
|---|
User permission required
...
Status codes
- 200 = Folder found
- 401 = User is not authorized
- 404 = Folder not exist
- 500 = Internal server error
Related Use Case(s)
- All info of a list is retrieved to display it in the frontend.
...
FA09 | Retrieve bookmarks of a folder
GET | /favourites/folders/{id}/bookmarks |
|---|
User permission required
...
Status codes
- 200 = Folder found
- 401 = User not authorized
- 404 = Folder not exist
- 500 = Internal server error
Related Use Case(s)
- UC04 | Retrieve bookmarks of a list
- The user retrieves bookmarks of a specified list.
- The user retrieves bookmarks of a specified list.
...
FA10 | Retrieve folders
GET | /favourites/folders |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| userId | ID of user | Once | - |
| title | Title of folder | Once | - |
| offset | Beginn offset of results | Once | -1 |
| size | Size data of results | Once | -1 |
...
Status codes
- 200 = Folder(s) found
- 400 = Missing some search params
- 401 = User not authorized
- 500 = Internal server error
Related Use Case(s)
- UC03 | Listennamen eines Benutzers abrufen
- The user retrieves bookmarks of a specified list.
- The user retrieves bookmarks of a specified list.
...
FA11 | Update folder
POST | /favourites/folders/{id} |
|---|
User permission required
Query parameters
| Name | Value | Occurence |
|---|---|---|
| folderIds | ID of folder(s) | Multiple |
Status codes
- 200 = Folder updated
- 401 = User not authorized
- 404 = Folder ID not found
- 500 = Internal server error
Related Use Case(s)
- UC09 | Publish or privatize personal list
- A user publishes a list or make a published list private again.
- UC10 | Change properties of personal list
- Furthermore, the user can change name, description, private/public, name abbreviation of a personal list.
- Furthermore, the user can change name, description, private/public, name abbreviation of a personal list.
...
FA12 | Delete folder
DELETE | /favourites/folders/{id} |
|---|
User permission required
Query parameters
| Name | Value | Occurence |
|---|---|---|
| folderIds | ID of folder(s) | Multiple |
Status codes
- 200 = Folder deleted
- 400 = Folder favorite could not be deleted
- 401 = User not authorized
- 404 = Folder ID not found
- 500 = Internal server error
Related Use Case(s)
- UC11 | Remove personal list with bookmarks
- The user deletes a personal list with the contained bookmarks.
- The user deletes a personal list with the contained bookmarks.
...
FA13 | Delete bookmark from folder
...
- A bookmark could not be deleted from the main folder (favorites), because this is done only if the bookmark is deleted (see Delete Bookmark).
- The folder ID and bookmark ID must exist before deleting something.
...
Status codes
- 200 = Bookmark in Folder deleted
- 400 = Bookmark ID not found
- 401 = User not authorized
- 404 = Folder ID not found
- 500 = Internal server error
Related Use Case(s)
- FA13 | Delete bookmark from list
- A bookmark is removed from a personal list.
- A bookmark is removed from a personal list.
...
FA14 | Delete all bookmarks and folders
DELETE | /favourites/folders |
|---|
User permission required
Query parameters
| Name | Value | Occurence | Default |
|---|---|---|---|
| userId | ID of user to delete | Once | - |
Status codes
- 200 = Bookmarks and Folders deleted
- 401 = User not authorized
- 404 = User ID not found
- 500 = Internal server error
Related Use Case(s)
- A user deletes his account. Then the system first deletes all bookmarks in all lists of the user. Then all lists including favorites are deleted.