Page History

...

Name	Value	Occurence	Default
folderIds	ID of folder(s)	Multiple	-

...

Response payload

Returns Bookmark JSON object:

...

{
	"id": "rjzgAIgBdHmpxQQKvQHm",			// Not used
	"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",	// Required
	"description": "My important description",	// Optional
	"userId": "fachstelle_museum",			// Not used
	"type": "CULTURAL_ITEM",			// Required
	"createdAt": 1683641908448,			// Not used
	"updatedAt": 1683641908448,			// Not used
	"keywordTool": {				// Optional
		"done": trueTrue
	}
}

Response payload

Returns Bookmark JSON object:

Status codes

200 = Bookmark created
400 = Item Id is missing (required)
401 = User is not authorized
500 = Internal server error

Related Use Case(s)

UC01 | Create bookmark
- The user selects an object from an object list as a favorite.

Example call(s)

Create bookmark in only main folder
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks
Create bookmark in main folder and two additional folders
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?folderIds=Sjszo4cBdHmpxQQKUvah&folderIds=rjwQKYgBdHmpxQQKKgSs

...

FA02 | Retrieve bookmark

GET	/favourites/bookmarks/{id}

Response payload

Returns Bookmark JSON object:

{
	"id": "rjzgAIgBdHmpxQQKvQHm",
	"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
	"description": "My important description",
	"userId": "fachstelle_museum",
	"type": "{
	"id": "rjzgAIgBdHmpxQQKvQHm",
	"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
	"description": "My important description",
	"userId": "fachstelle_museum",
	"type": "CULTURAL_ITEM",
	"createdAt": 1683641908448,
	"updatedAt": 1683641908448,
	"keywordTool": {
		"done": trueTrue
	}
}

Status codes

200 = Bookmark created400 = Item Id is missing (required)found
401 = User is not authorized
404 = Bookmark ID not found
500 = Internal server error

Related Use Case(s)

UC01 | Create bookmark
- The user selects an object from an object list as a favorite.

Example call(s)

Create bookmark in only main folder
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks
Create bookmark in main folder and two additional folders
- GET https://dev-ddb.fiz-karlsruhe.de/api/2/favourites/bookmarks?folderIds=Sjszo4cBdHmpxQQKUvah&folderIds=rjwQKYgBdHmpxQQKKgSs

FA02 | Retrieve bookmark

...

GET

...

/favourites/bookmarks/{id}

All info of a bookmark is retrieved to display it in the frontend.

...

FA03 | Retrieve bookmarks

GET	/favourites/bookmarks

Query parameters

Name	Value	Occurence	Default
folderIds	ID of folder(s)	Multiple	-

Response payload

Returns BookmarkResult

Request payload

Returns User JSON object:

{
    "nickname	"query": "testuser-riuser:"73611165cc142ae53176707d5a92e8f3",
    "email	"total": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    4,
	"offset": 0,
	"size": 9999,
	"bookmarks": [
		{
			"id": "cb5d9c5810e985e7beda092b22e1e480rjzgAIgBdHmpxQQKvQHm",
    "nickname			"itemId": "testuser-riIVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
    "status			"description": "CONFIRMED",
    "surName			"userId": "surname is unknownfachstelle_museum",
    "email			"type": "testuser-ri-1@ddb.deCULTURAL_ITEM",
    "created			"createdAt": "2024-01-31T12:13:30",
    "creatorId1683641908448,
			"updatedAt": "anonymous"1683641908448,
    "modified			"keywordTool": "2024-01-31T12:13:30",
    "modifierId{
				"done": "anonymous"
}

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

Query parameters

...

False
			},
		},
		{
			"id": "nDxWtIgBdHmpxQQKNxNQ",
			"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
			"description": "Neues Lesezeichen",
			"userId": "fachstelle_museum",
			"type": "CULTURAL_ITEM",
			"createdAt": 1683641908448,
			"updatedAt": 1683641908448,
			"keywordTool": {
				"done": False
			},
		}
	]
}

Status codes

200 = Bookmark(s) found
400 = Missing some search params
401 = User not authorized
500 = Internal server

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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.

...

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

Request payload

Returns User Bookmark JSON object:

{
    "nickname	"id": "testuser-rirjzgAIgBdHmpxQQKvQHm",
    "email				// Not used
	"itemId": "testuser-ri@ddb.deIVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
    "pswd		// Not used
	"description": "testuser-ri"
}

Response payload

Returns User JSON object:

Another description",			// Optional
	"userId": "fachstelle_museum",				// Not used
	"type": "INSTITUTION",					// Optional
	"createdAt": 1683641908448,				// Not used
	"updatedAt": 1683641908448,				// Not used
	"keywordTool": {					// Optional
		"done": false
	}
}

Response payload

Returns Bookmark JSON object:

{
	"id": "rjzgAIgBdHmpxQQKvQHm",
	"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
	"description": "Another description",
	"userId": "fachstelle_museum",
	"type": "INSTITUTION",
	"createdAt": 1683641908448,
	"updatedAt": 1683641908555,
	"keywordTool": {
		"done": false
	}
}
{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

Status codes

200 = Bookmark updated
401 = User is not authorized
404 = Bookmark ID not found
500 = Internal server error

...

Name	Value	Occurence	Default
folderIds	ID of folder(s)	Multiple	-

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

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).

...

FA06 | Create folder

POST	/favourites/folders

Request payload

Returns Folder Returns User JSON object:

{
    "	"id": "cb5d9c5810e985e7beda092b22e1e48073611165cc142ae53176707d5a92e8f3",
    "nickname	// Not used
	"title": "testuser-rifavorites",
    "status				// Required
	"description": "CONFIRMEDDas ist ein Test!",
    "surName		// Optional
	"userId": "surname is unknown",
    "emailfachstelle_museum",			// Not used
	"publishingName": "testuser-ri-1@ddb.dexxx",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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).

FA06 | Create folder

...

POST

...

/favourites/folders

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"			// Optional
	"createdAt": 1682070216141,			// Not used
	"updatedAt": 1683642142482,			// Not used
	"bookmarkIds": [				// Optional
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [				// Optional
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",			// Optional
	"blocked": true,				// Optional
	"published": true,				// Optional
	"keywordTool": {				// Optional
		"sentToAdmin": false
	}
}

Response payload

Returns User Folder JSON object:

{
    	"id": "cb5d9c5810e985e7beda092b22e1e48073611165cc142ae53176707d5a92e8f3",
    "nickname	"title": "favorites"testuser-ri",
    "status	"description": "CONFIRMEDDas ist ein Test!",
    "surName	"userId": "surname is unknownfachstelle_museum",
    "email	"publishingName": "testuser-ri-1@ddb.dexxx",
    "created	"createdAt": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}1682070216141,
	"updatedAt": 1683642142482,
	"bookmarksIds": [
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",
	"blocked": true,
	"published": true,
	"keywordTool": {
		"sentToAdmin": false
	}
}

Status codes

200 = Folder created
400 = Title attribute is missing
401 = User is not authorized
409 = Folder already exists
500 = Internal server error

...

Name	Value	Occurence	Default
bookmarkId	ID of bookmark to add	Once	-

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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.

...

FA08 | Retrieve folder

GET	/favourites/folders/{id}

Response payload

Returns Folder JSON object:

{
	"id": "73611165cc142ae53176707d5a92e8f3"
	"title": "favorites",
	"description": "Das ist ein Test!",
	"userId": "fachstelle_museum",
	"publishingName": "xxx",
	"createdAt": 1682070216141,
	"updatedAt": 1683642142482,
	"bookmarksIds": [
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",
	"blocked": true,
	"published": true,
	"keywordTool": {
		"sentToAdmin": false
	}
}

Status codes

200 = Folder found
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.

FA08 | Retrieve folder

...

GET

...

/favourites/folders/{id}

All info of a list is retrieved to display it in the frontend.

...

FA09 | Retrieve bookmarks of a folder

GET	/favourites/folders/{id}/bookmarks

Response payload

Returns BookmarkResult

Request payload

Returns User JSON object:

{
    "nickname	"query": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    user:"73611165cc142ae53176707d5a92e8f3" AND folder:"p0Qyo4cBosJ3rUWznjiY"",
	"total": 4,
	"offset": 0,
	"size": 9999,
	"bookmarks": [
		{
			"id": "cb5d9c5810e985e7beda092b22e1e480rjzgAIgBdHmpxQQKvQHm",
    "nickname			"itemId": "testuser-riIVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
    "status			"description": "CONFIRMED",
    "surName			"userId": "surname is unknownfachstelle_museum",
    "email			"type": "testuser-ri-1@ddb.deCULTURAL_ITEM",
    "created			"createdAt": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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.

FA10 | Retrieve folders

...

GET

...

/favourites/folders

Query parameters

...

1683641908448,
			"updatedAt": 1683641908448,
			"keywordTool": {
				"done": False
			},
		},
		{
			"id": "nDxWtIgBdHmpxQQKNxNQ",
			"itemId": "IVMX3IRHKU725WR2HHT6VY2AFFS72FGK",
			"description": "Neues Lesezeichen",
			"userId": "fachstelle_museum",
			"type": "CULTURAL_ITEM",
			"createdAt": 1683641908448,
			"updatedAt": 1683641908448,
			"keywordTool": {
				"done": False
			},
		}
	]
}

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.

...

FA10 | Retrieve folders

GET	/favourites/folders

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

Response payload

Returns FolderResult JSON object:

{
	"query": "user:"73611165cc142ae53176707d5a92e8f3"",
	"total": 19,
	"offset": 0,
	"size": 9999,
	"folders": [
		{
			"id": "Sjszo4cBdHmpxQQKUvah",
			"title": "Schiller",
			"description": "",
			"userId": "fachstelle_museum",
			"publishingName": "dio",
			"createdAt": 1682070262371,
			"updatedAt": 1683642142787,
			"bookmarksIds": ["MUSR_IcBosJ3rUWzmkLU"],
			"institutionIds": Null,
			"blockingToken": "",
			"keywordTool": {
				"sentToAdmin": false
			},
			"blocked": false,
			"published": true},
		{
			"id": "rjwQKYgBdHmpxQQKKgSs",
			"title": "favorites",
			"description": "Das ist ein Test!",
			"userId": "fachstelle_museum",
			"publishingName": "xxx",
			"createdAt": 1682070216141,
			"updatedAt": 1683642142482,
			"bookmarksIds": [],
			"institutionIds": none,
			"blockingToken": "Test",
			"keywordTool": {
				"sentToAdmin": false
			},
			"blocked": true,
			"published": true
		}
	]
}

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

Status codes

200 = Folder(s) found
400 = Missing some search params
401 = User not authorized
500 = Internal server error

...

Name	Value	Occurence
folderIds	ID of folder(s)	Multiple

Request payload

Returns User Folder JSON object:

{
    "nickname	"id": "testuser-riSjszo4cBdHmpxQQKUvah",
    "email			// Not used
	"title": "testuser-ri@ddb.defavorites",
    "pswd				// Optional
	"description": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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.

FA12 | Delete folder

...

DELETE

...

/favourites/folders/{id}

Query parameters

...

Das ist ein Test!",		// Optional
	"userId": "fachstelle_museum",			// Not used
	"publishingName": "xxx",			// Optional
	"createdAt": 1682070216141,			// Not used
	"updatedAt": 1683642142482,			// Not used
	"bookmarksIds": [				// Optional
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [				// Optional
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",			// Optional
	"blocked": true,				// Optional
	"published": true,				// Optional
	"keywordTool": {				// Optional
		"sentToAdmin": false
	}
}

Response payload

Returns Folder JSON object:

{
	"id": "Sjszo4cBdHmpxQQKUvah",	
	"title": "favorites",
	"description": "Das ist ein Test!",
	"userId": "fachstelle_museum",
	"publishingName": "xxx",
	"createdAt": 1682070216141,
	"updatedAt": 1683642142482,
	"bookmarksIds": [
		"MESR_IcBosJ3rUWzhkJj",
		"rjzgAIgBdHmpxQQKvQHm"
	],
	"institutionIds": [
		"MESR_IcBosJ3rUWzhkJj"
	],
	"blockingToken": "Test",
	"blocked": true,
	"published": true,
	"keywordTool": {
		"sentToAdmin": false
	}
}

Status codes

200 = Folder updated

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

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 UC09 | Remove Publish or privatize personal list with bookmarks
- The user deletes a personal list with the contained bookmarks.

...

- 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.

...

FA12 | Delete folder

DELETE	/favourites/folders/{id}/bookmarks/{bookmarkId}

Remarks

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.

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

{
    "id": "cb5d9c5810e985e7beda092b22e1e480",
    "nickname": "testuser-ri",
    "status": "CONFIRMED",
    "surName": "surname is unknown",
    "email": "testuser-ri-1@ddb.de",
    "created": "2024-01-31T12:13:30",
    "creatorId": "anonymous",
    "modified": "2024-01-31T12:13:30",
    "modifierId": "anonymous"
}

Status codes

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.

...

FA13 | Delete bookmark from folder

DELETE	/favourites/folders/{id}/bookmarks/{bookmarkId}

Remarks

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
200 = Bookmark in Folder deleted
400 = Bookmark ID not found
401 = User not authorized
404 = Folder ID not found
500 = Internal server error

...

FA13 | Delete bookmark from list
- A bookmark is removed from a personal list.

FA14 | Delete all bookmarks and folders

...

DELETE

...

/favourites/folders

Query parameters

...

Request payload

Returns User JSON object:

{
    "nickname": "testuser-ri",
    "email": "testuser-ri@ddb.de",
    "pswd": "testuser-ri"
}

Response payload

Returns User JSON object:

...

list
- A bookmark is removed from a personal list.

...

FA14 | Delete all bookmarks and folders

DELETE	/favourites/folders

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

...

Page tree

Page History

Versions Compared

Old Version 24

New Version 25

Key

Response payload

Response payload

Status codes

Related Use Case(s)

Example call(s)

FA02 | Retrieve bookmark

Response payload

Status codes

Related Use Case(s)

Example call(s)

FA02 | Retrieve bookmark

FA03 | Retrieve bookmarks

Query parameters

Response payload

Request payload

Response payload

Status codes

Related Use Case(s)

FA03 | Retrieve bookmarks

Query parameters

Status codes

Request payload

Response payload

Status codes

Related Use Case(s)

Request payload

Response payload

Response payload

Status codes

Request payload

Response payload

Status codes

Related Use Case(s)

FA06 | Create folder

Request payload

Status codes

Related Use Case(s)

FA06 | Create folder

Request payload

Response payload

Status codes

Request payload

Response payload

Status codes

Status codes

Related Use Case(s)

FA08 | Retrieve folder

Response payload

Status codes

Related Use Case(s)

FA08 | Retrieve folder

FA09 | Retrieve bookmarks of a folder

Response payload

Request payload

Response payload

Status codes

Related Use Case(s)

FA09 | Retrieve bookmarks of a folder

Request payload

Response payload

Status codes

Related Use Case(s)

FA10 | Retrieve folders

Query parameters

Status codes

Related Use Case(s)

FA10 | Retrieve folders

Query parameters

Response payload

Request payload

Response payload

Status codes

Request payload

Response payload