This web service lists all bookmarks that were previously added to the My Library account of the selected user.
Method | Endpoint |
---|---|
GET |
/api/users/{userId}/bookmarks |
Path parameter | Type | Description |
---|---|---|
{userId} |
String | The user's identifier. |
Response body
The following lines show an example of a JSON response body:
[
{
"id": "u563cb2q-8d2f-4ppr-a8fc-388e154b4nvu",
"title": "Bookmark number one",
"color": "red",
"creationDate": "2022-10-22T15:10:07.126+00:00",
"lastUpdate": "2022-10-24T09:15:33.102+00:00",
"mapId": "o5iqLaaKrcCSU8JbU7Z7bw",
"tocId": "26m0szaAbT8XFuOWKs8aXQ",
"readerUrl": "https://fluid-topics/r/User-Guide/Fluid-Topics-Header",
"mapTitle": "User Guide",
"breadcrumb": [
"Introduction",
"User Account",
"User Interface"
]
}
]
Field | Type | Description |
---|---|---|
id |
String | The bookmark's identifier. |
title |
String | The bookmark's name. |
color |
String | The color of the bookmark's tag. |
creationDate |
String | The date and time at which the bookmark was created. |
lastUpdate |
String | The date and time at which the bookmark was last updated. |
mapId |
String | The map's identifier. |
tocId |
String | The topic's identifier based on its position in the table of contents. |
readerUrl |
String | The pretty URL of the bookmarked topic. Selecting this URL opens the topic in the Reader page. |
mapTitle |
String | The title of the document to which the bookmarked topic belongs. |
breadcrumb |
Array | The breadcrumb indicating the path to the topic in the document's hierarchy. |
Return code | Description |
---|---|
200 OK |
The request is valid and data is returned. |
401 UNAUTHORIZED |
The authorization header was not provided or is invalid. |
403 FORBIDDEN |
The user or API key does not have the ADMIN or USERS_ADMIN role, or is not requesting their own assets. |
404 NOT FOUND |
No user exists with this ID. |
For a comprehensive list of all possible return codes, see Return codes.