Mandatory reads

Reference for the mandatory reads endpoints of the Interact REST API.

Note: All endpoints require authentication and an X-Tenant header. See Authentication overview and How to get API information. Paths are relative to your intranet's API base URL. An Access line appears where an endpoint needs more than a signed-in user.

Endpoints on this page

GET /api/mandatoryread
GET /api/mandatoryread/count

GET /api/mandatoryread

Get unread mandatory read documents for the current user.

Parameters

Name	In	Type	Required	Description
`limit`	query	integer (int32)	No
`offset`	query	integer (int32)	No

Responses

Status	Body
200	See below
400

Response body

[
  {
    "PageId": 0,
    "AssetId": 0,
    "Title": "string",
    "Summary": "string",
    "AuthorFullName": "string",
    "AuthorAssetId": 0,
    "AuthorId": 0,
    "DateAddedUtc": "2024-01-01T00:00:00Z",
    "PublisherType": 0,
    "OrganisationName": "string"
  }
]

Field	Type
`PageId`	integer (int32)
`AssetId`	integer (int32)
`Title`	string
`Summary`	string
`AuthorFullName`	string
`AuthorAssetId`	integer (int32)
`AuthorId`	integer (int32)
`DateAddedUtc`	string (date-time)
`PublisherType`	integer (int32)
`OrganisationName`	string

GET /api/mandatoryread/count

Get unread mandatory read documents for the current user.

Responses

Status	Body
200	See below
400

Response body

{
  "Count": 0
}

Field	Type
`Count`	integer (int32)

Section: REST API