Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

API endpoints

Create bookmark

POST

/favourites/bookmarks

User permission required

Remarks

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

Status codes

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

Response payload

Returns list of Privilege JSON objects:


{
	"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": true
	}
}


Example call(s)

Example call(s)


...

x

Endpoints and Use Cases

View file
nameFavourite API, Endpoints and Use Cases, 5.9.2023.pdf
height250

...