GET api/consumer/v1/users/bookmarks/{entityType}/{entityId}

Get a bookmark

Request Information

URI Parameters

NameDescriptionTypeAdditional information
entityType

ID of entity type

VisibilityEntityType

Required

entityId

ID of the entity

integer

Required

Body Parameters

None

Response Information

Resource Description

The bookmark

BookmarkDto
NameDescriptionTypeAdditional information
EntityId

Id of the entity

integer

None

EntityType

Type of the entity

VisibilityEntityType

None

LastRead

Last read for the current user

date

None

User

Owner of the bookmark

UserMinDto

None

Id

Unique ID

integer

None

Response Formats

application/json, text/json

Sample:
{
  "EntityId": 1,
  "EntityType": 100,
  "LastRead": "2024-11-01T16:00:08.2574003+01:00",
  "User": {
    "Login": "sample string 1",
    "FullName": "sample string 2",
    "Avatar": "sample string 3",
    "Id": 4
  },
  "Id": 2
}

application/xml, text/xml

Sample:
<BookmarkDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Oryx.Web.Api.Models">
  <Id>2</Id>
  <EntityId>1</EntityId>
  <EntityType>BusinessUnit</EntityType>
  <LastRead>2024-11-01T16:00:08.2574003+01:00</LastRead>
  <User>
    <Id>4</Id>
    <Avatar>sample string 3</Avatar>
    <FullName>sample string 2</FullName>
    <Login>sample string 1</Login>
  </User>
</BookmarkDto>