Api Documentation

Read status

Read status belonging to the logged in user. For privacy reasons, user authentication is always required for this endpoint.
Retrieves a collection of read status
Retrieves a single read status
Json
XML
POST https://api.bundeling.com/V2/read_status

Parameters

Body

NameDescriptionTypeNillableRequired
modelThe type of object this read status is for
Accepted values: bulletin_board_items, event, news_item, match, poll
stringfalsetrue
object_uuidA unique identifier used to identify the objectstringtruefalse
impressionBoolean to indicate user has seen the objectbooleanfalsefalse
all_of_typeSet all items of this model as readbooleanfalsefalse

Example request

Headers

Content-Type:application/json
Api-Key:RAegSX8yZfEbqSPM

Body

{
    "model": "news_item",
    "object_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "impression": true,
    "all_of_type": false
}

Example response

{
    "uuid": "eeb763c41c054dcc8f6d9362f24ee9b2",
    "model": "event",
    "object_uuid": "d7743aaf53224e279853c7d0c1dbfb3a",
    "impression": true,
    "creationdate": "2024-01-20T00:00:00+0100",
    "lastupdate": "2024-01-20T00:00:00+0100"
}