docs.jsonld
type: ApiDocumentation
title: Richtlijnendatabase API
description: This API discloses the common entities in Richtlijnendatabase.nl oAuth2 This API uses standard oAuth2 for authentication, with the client credentials flow. Endpoints Endpoint URL Token https://auth.richtlijnendatabase.nl/token REST API https://api.richtlijnendatabase.nl GraphQL API https://api.richtlijnendatabase.nl/graphql The token endpoint should be used to obtain an access token which in turn can be used to authenticate to the API. Obtain access token: $ curl --request POST --url 'https://auth.richtlijnendatabase.nl/token' --data 'grant_type=client_credentials&client_id=YOUR_CLIENT_ID&client_secret=YOUR_CLIENT_SECRET' Access the API with obtained access token: $ curl --request GET --url https://api.richtlijnendatabase.nl/guidelines --header 'Authorization: Bearer YOUR_ACCESS_TOKEN' Rate Limiting The API applies rate limiting and informs the client through the 'X-Ratelimit-Limit', 'X-Ratelimit-Remaining' and 'X-Ratelimit-Reset' response headers. It is advised to use a client that supports rate limiting (or avoid sending too many requests). Available formats The following formats are supported by the API: jsonld (application/ld+json) jsonhal (application/hal+json) jsonapi (application/vnd.api+json) json (application/json) jsonld (application/ld+json) graphql (application/graphql) You can differ between the desired formats by specifying the Content-Type (i.e. application/hal+json) in the Accept header of the request. GraphQL API GraphQL is supported, however it is limited when it comes to accessing properties of nested objects. For example: you can access some of the Module properties through GuidelineNavigations, but not the HTML and relationship fields (which is also the case through the regular REST API). You would have to access these through Module. GraphQL has its own endpoint. Primary entities The primary entities are Guideline, GuidelineNavigation and Module. A Guideline consists mostly of metadata and has multiple GuidelineNavigation objects related to it.…
entrypoint: /
supported class: User
supported class: Specialism
supported class: Module
supported class: ModuleReference
supported class: ModuleFile
supported class: ModuleHyperlink
supported class: ModuleAttachment
supported class: ModuleSearchResult
supported class: SuggestionSearch
supported class: GuidelineSearchResult
supported class: NewsItem
supported class: GuidelineNavigation
supported class: Guideline
supported class: Organisation
supported class: Favourite
supported class: Subscription
supported class: UserNotification
supported class: ContentViewLog
supported class: RecentSearch
supported class: Entrypoint
supported class: ConstraintViolation
supported class: ConstraintViolationList

User
type: Class
title: User
supported property: SupportedProperty
  property: roles
  title: roles
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: password
  title: password
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: email
  title: email
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: name
  title: name
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: assetsHash
  title: assetsHash
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: hasAvatar
  title: hasAvatar
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: about
  title: about
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: big_nr
  title: big_nr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: accessLevel
  title: accessLevel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: verifiedAccount
  title: verifiedAccount
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: linkedin
  title: linkedin
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: facebook
  title: facebook
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: twitter
  title: twitter
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: last_activity_app
  title: last_activity_app
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: fab_user_id
  title: fab_user_id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: organisations
  title: organisations
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: favourites
  title: favourites
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: notifications
  title: notifications
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: subscriptions
  title: subscriptions
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: contentViewLogs
  title: contentViewLogs
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: specialism
  title: specialism
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: recentSearches
  title: recentSearches
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: salt
  title: salt
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: userIdentifier
  title: userIdentifier
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: username
  title: username
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: bigNr
  title: bigNr
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: fabUserId
  title: fabUserId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves User resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves User resource.
  returns: User
description: This endpoint is personalised based on the current JWT.

roles
type: Property
domain: User

password
type: Property
domain: User
range: string

email
type: Property
domain: User
range: string

name
type: Property
domain: User
range: string

assetsHash
type: Property
domain: User
range: string

hasAvatar
type: Property
domain: User
range: boolean

about
type: Property
domain: User
range: string

big_nr
type: Property
domain: User
range: string

accessLevel
type: Property
domain: User
range: string

verifiedAccount
type: Property
domain: User
range: boolean

linkedin
type: Property
domain: User
range: string

facebook
type: Property
domain: User
range: string

twitter
type: Property
domain: User
range: string

created
type: Property
domain: User
range: dateTime

last_activity_app
type: Property
domain: User
range: dateTime

fab_user_id
type: Property
domain: User
range: integer

organisations
type: Link
domain: User
range: Organisation

favourites
type: Link
domain: User
range: Favourite

notifications
type: Link
domain: User
range: UserNotification

subscriptions
type: Link
domain: User
range: Subscription

contentViewLogs
type: Link
domain: User
range: ContentViewLog

specialism
type: Link
domain: User
max cardinality: 1
range: Specialism

recentSearches
type: Link
domain: User
range: RecentSearch

salt
type: Property
domain: User

userIdentifier
type: Property
domain: User
range: string

username
type: Property
domain: User
range: string

bigNr
type: Property
domain: User
range: string

fabUserId
type: Property
domain: User
range: integer

Specialism
type: Class
title: Specialism
supported property: SupportedProperty
  property: label
  title: label
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: big_label
  title: big_label
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: big_id
  title: big_id
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: bigLabel
  title: bigLabel
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: bigId
  title: bigId
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Specialism resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Specialism resource.
  returns: Specialism

label
type: Property
domain: Specialism
range: string

big_label
type: Property
domain: Specialism
range: string

big_id
type: Property
domain: Specialism
range: integer

bigLabel
type: Property
domain: Specialism
range: string

bigId
type: Property
domain: Specialism
range: integer

Module
type: Class
title: Module
supported property: SupportedProperty
  property: groupId
  title: groupId
  required: false
  readable: true
  writeable: false
  description: Version ID of the Module, in case a newer version of this Module is published its ID changes, but its groupId does not.
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: fullTitle
  title: fullTitle
  required: false
  readable: true
  writeable: false
  description: TODO: this item is currently not visible in website, but is in PDF (mistake?)
supported property: SupportedProperty
  property: inDevelopment
  title: inDevelopment
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: inReview
  title: inReview
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isTableOfContents
  title: isTableOfContents
  required: false
  readable: true
  writeable: false
  description: Module is a 'Table of Contents' (Startpage) type of module
supported property: SupportedProperty
  property: navigation
  title: navigation
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: authorisationDate
  title: authorisationDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: assessmentDate
  title: assessmentDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publishDate
  title: publishDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: type
  title: type
  required: false
  readable: false
  writeable: false
  description: Module type, 0 = standard module, 1 = Table of Contents module
supported property: SupportedProperty
  property: clinicalQuestion
  title: clinicalQuestion
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: preface
  title: preface
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: recommendations
  title: recommendations
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: searchSelect
  title: searchSelect
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: conclusions
  title: conclusions
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: evidenceTables
  title: evidenceTables
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: considerations
  title: considerations
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: membersGuidelinePanel
  title: membersGuidelinePanel
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: scopeTargetGroup
  title: scopeTargetGroup
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: implementation
  title: implementation
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: declarationInterest
  title: declarationInterest
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: literatureSummary
  title: literatureSummary
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: patientInvolvement
  title: patientInvolvement
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: methodsProcess
  title: methodsProcess
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: validity
  title: validity
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: searchAnswerability
  title: searchAnswerability
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: general
  title: general
  required: false
  readable: true
  writeable: false
  description: Html
supported property: SupportedProperty
  property: initiators
  title: initiators
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: authorisedOrganisations
  title: authorisedOrganisations
  required: false
  readable: true
  writeable: false
supported operation: Retrieves Module resource.

groupId
type: Property
domain: Module
range: string

title
type: Property
domain: Module
range: string

fullTitle
type: Property
domain: Module
range: string

inDevelopment
type: Property
domain: Module
range: boolean

inReview
type: Property
domain: Module
range: boolean

isTableOfContents
type: Property
domain: Module
range: boolean

navigation
type: Property
domain: Module
range: GuidelineNavigation

authorisationDate
type: Property
domain: Module
range: dateTime

assessmentDate
type: Property
domain: Module
range: dateTime

publishDate
type: Property
domain: Module
range: dateTime

type
type: Property
domain: Module
range: integer

clinicalQuestion
type: Property
domain: Module
range: string

preface
type: Property
domain: Module
range: string

recommendations
type: Property
domain: Module
range: string

searchSelect
type: Property
domain: Module
range: string

conclusions
type: Property
domain: Module
range: string

evidenceTables
type: Property
domain: Module
range: string

considerations
type: Property
domain: Module
range: string

membersGuidelinePanel
type: Property
domain: Module
range: string

scopeTargetGroup
type: Property
domain: Module
range: string

implementation
type: Property
domain: Module
range: string

declarationInterest
type: Property
domain: Module
range: string

literatureSummary
type: Property
domain: Module
range: string

patientInvolvement
type: Property
domain: Module
range: string

methodsProcess
type: Property
domain: Module
range: string

validity
type: Property
domain: Module
range: string

searchAnswerability
type: Property
domain: Module
range: string

general
type: Property
domain: Module
range: string

initiators
type: Link
domain: Module
range: Organisation

authorisedOrganisations
type: Link
domain: Module
range: Organisation

attachments
type: Link
domain: Module
range: ModuleAttachment
type: Property

hyperlinks
type: Link
domain: Module
range: ModuleHyperlink
type: Property

files
type: Link
domain: Module
range: ModuleFile

references
type: Link
domain: Module
range: ModuleReference
type: Property

referenceStyleId
type: Property
domain: Module
range: integer

statusId
type: Property
domain: Module
range: integer

editorialStatusId
type: Property
domain: Module
range: integer

contentViewLogs
type: Link
domain: Module
range: ContentViewLog

ModuleReference
type: Class
title: ModuleReference
supported property: SupportedProperty
  property: nr
  title: nr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: content
  title: content
  required: false
  readable: true
  writeable: false
  description: Fully parsed reference content.
supported property: SupportedProperty
  property: fullHtml
  title: fullHtml
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publishYear
  title: publishYear
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: author
  title: author
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: authors
  title: authors
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publishedIn
  title: publishedIn
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: volumeNr
  title: volumeNr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: issueNr
  title: issueNr
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pageBegin
  title: pageBegin
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: pageEnd
  title: pageEnd
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isParsable
  title: isParsable
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: statusId
  title: statusId
  required: false
  readable: false
  writeable: false
  description: Required to be able to filter on status
supported property: SupportedProperty
  property: parsable
  title: parsable
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: online
  title: online
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ModuleReference resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ModuleReference resource.
  returns: ModuleReference

nr
type: Property
domain: ModuleReference
range: integer

content
type: Property
domain: ModuleReference
range: string

fullHtml
type: Property
domain: ModuleReference
range: string

module
type: Link
domain: ModuleReference
max cardinality: 1
range: Module

title
type: Property
domain: ModuleReference
range: string

publishYear
type: Property
domain: ModuleReference
range: string

author
type: Property
domain: ModuleReference
range: string

authors
type: Property
domain: ModuleReference
range: string

publishedIn
type: Property
domain: ModuleReference
range: string

volumeNr
type: Property
domain: ModuleReference
range: string

issueNr
type: Property
domain: ModuleReference
range: string

pageBegin
type: Property
domain: ModuleReference
range: string

pageEnd
type: Property
domain: ModuleReference
range: string

url
type: Property
domain: ModuleReference
range: string

isParsable
type: Property
domain: ModuleReference
range: integer

statusId
type: Property
domain: ModuleReference
range: integer

parsable
type: Property
domain: ModuleReference
range: boolean

online
type: Property
domain: ModuleReference
range: boolean

ModuleFile
type: Class
title: ModuleFile
supported property: SupportedProperty
  property: fileName
  title: fileName
  required: false
  readable: true
  writeable: false
  description: Filename
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
  description: Title for this document
supported property: SupportedProperty
  property: kast
  title: kast
  required: false
  readable: false
  writeable: false
  description: Cabinet name
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: filterId
  title: filterId
  required: false
  readable: true
  writeable: false
  description: Filter for this record
supported property: SupportedProperty
  property: order
  title: order
  required: false
  readable: true
  writeable: false
  description: Prio
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: cabinetDocumentType
  title: cabinetDocumentType
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: productCategory
  title: productCategory
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: category
  title: category
  required: false
  readable: true
  writeable: false
  description: The label of the ProductCategory this item belongs to
supported operation: Retrieves ModuleFile resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ModuleFile resource.
  returns: ModuleFile

fileName
type: Property
domain: ModuleFile
range: string

title
type: Property
domain: ModuleFile
range: string

kast
type: Property
domain: ModuleFile
range: string

url
type: Property
domain: ModuleFile
range: string

filterId
type: Property
domain: ModuleFile
range: integer

order
type: Property
domain: ModuleFile
range: integer

module
type: Link
domain: ModuleFile
max cardinality: 1
range: Module

cabinetDocumentType
type: Property
domain: ModuleFile

productCategory
type: Property
domain: ModuleFile

category
type: Property
domain: ModuleFile
range: string

ModuleHyperlink
type: Class
title: ModuleHyperlink
supported property: SupportedProperty
  property: order
  title: order
  required: false
  readable: true
  writeable: false
  description: Prio
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
  description: Actual hyperlink
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: hyperlink
  title: hyperlink
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: productCategory
  title: productCategory
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: category
  title: category
  required: false
  readable: true
  writeable: false
  description: The label of the ProductCategory this item belongs to
supported property: SupportedProperty
  property: online
  title: online
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ModuleHyperlink resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ModuleHyperlink resource.
  returns: ModuleHyperlink

order
type: Property
domain: ModuleHyperlink
range: integer

title
type: Property
domain: ModuleHyperlink
range: string

url
type: Property
domain: ModuleHyperlink
range: string

module
type: Link
domain: ModuleHyperlink
max cardinality: 1
range: Module

hyperlink
type: Property
domain: ModuleHyperlink

productCategory
type: Property
domain: ModuleHyperlink

category
type: Property
domain: ModuleHyperlink
range: string

online
type: Property
domain: ModuleHyperlink
range: boolean

ModuleAttachment
type: Class
title: ModuleAttachment
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
  description: Title for this link
supported property: SupportedProperty
  property: content
  title: content
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: order
  title: order
  required: false
  readable: true
  writeable: false
  description: Prio
supported property: SupportedProperty
  property: nr
  title: nr
  required: false
  readable: true
  writeable: false
  description: Unique nr per module
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: productCategory
  title: productCategory
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: statusId
  title: statusId
  required: false
  readable: false
  writeable: false
  description: Required to be able to filter on status
supported property: SupportedProperty
  property: category
  title: category
  required: false
  readable: true
  writeable: false
  description: The label of the ProductCategory this item belongs to
supported property: SupportedProperty
  property: online
  title: online
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ModuleAttachment resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ModuleAttachment resource.
  returns: ModuleAttachment

title
type: Property
domain: ModuleAttachment
range: string

content
type: Property
domain: ModuleAttachment
range: string

order
type: Property
domain: ModuleAttachment
range: integer

nr
type: Property
domain: ModuleAttachment
range: integer

module
type: Link
domain: ModuleAttachment
max cardinality: 1
range: Module

productCategory
type: Property
domain: ModuleAttachment

statusId
type: Property
domain: ModuleAttachment
range: integer

category
type: Property
domain: ModuleAttachment
range: string

online
type: Property
domain: ModuleAttachment
range: boolean

ModuleSearchResult
type: Class
title: ModuleSearchResult
supported property: SupportedProperty
  property: suggestedQuery
  title: suggestedQuery
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sort
  title: sort
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: page
  title: page
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: pageSize
  title: pageSize
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: nestedDocuments
  title: nestedDocuments
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: mappedDocuments
  title: mappedDocuments
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: moduleResults
  title: moduleResults
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: documentIds
  title: documentIds
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: iterator
  title: iterator
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: documents
  title: documents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastPage
  title: lastPage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: totalItems
  title: totalItems
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currentPage
  title: currentPage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: itemsPerPage
  title: itemsPerPage
  required: false
  readable: true
  writeable: false
supported operation: Retrieves ModuleSearchResult resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ModuleSearchResult resource.
  returns: ModuleSearchResult

suggestedQuery
type: Property
domain: ModuleSearchResult
range: string

sort
type: Property
domain: ModuleSearchResult
range: string

page
type: Property
domain: ModuleSearchResult
range: integer

pageSize
type: Property
domain: ModuleSearchResult
range: integer

nestedDocuments
type: Property
domain: ModuleSearchResult

mappedDocuments
type: Property
domain: ModuleSearchResult

moduleResults
type: Property
domain: ModuleSearchResult

documentIds
type: Property
domain: ModuleSearchResult

iterator
type: Property
domain: ModuleSearchResult

documents
type: Property
domain: ModuleSearchResult

lastPage
type: Property
domain: ModuleSearchResult
range: decimal

totalItems
type: Property
domain: ModuleSearchResult
range: decimal

currentPage
type: Property
domain: ModuleSearchResult
range: decimal

itemsPerPage
type: Property
domain: ModuleSearchResult
range: decimal

SuggestionSearch
type: Class
title: SuggestionSearch
supported property: SupportedProperty
  property: query
  title: query
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: results
  title: results
  required: false
  readable: true
  writeable: true
supported operation: Retrieves SuggestionSearch resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves SuggestionSearch resource.
  returns: SuggestionSearch

query
type: Property
domain: SuggestionSearch
range: string

results
type: Property
domain: SuggestionSearch

GuidelineSearchResult
type: Class
title: GuidelineSearchResult
supported property: SupportedProperty
  property: suggestedQuery
  title: suggestedQuery
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: sort
  title: sort
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: page
  title: page
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: pageSize
  title: pageSize
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: nestedDocuments
  title: nestedDocuments
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: mappedDocuments
  title: mappedDocuments
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: guidelineResults
  title: guidelineResults
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: moduleResults
  title: moduleResults
  required: false
  readable: false
  writeable: true
supported property: SupportedProperty
  property: documentIds
  title: documentIds
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: iterator
  title: iterator
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: documents
  title: documents
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lastPage
  title: lastPage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: totalItems
  title: totalItems
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: currentPage
  title: currentPage
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: itemsPerPage
  title: itemsPerPage
  required: false
  readable: true
  writeable: false
supported operation: Retrieves GuidelineSearchResult resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GuidelineSearchResult resource.
  returns: GuidelineSearchResult

suggestedQuery
type: Property
domain: GuidelineSearchResult
range: string

sort
type: Property
domain: GuidelineSearchResult
range: string

page
type: Property
domain: GuidelineSearchResult
range: integer

pageSize
type: Property
domain: GuidelineSearchResult
range: integer

nestedDocuments
type: Property
domain: GuidelineSearchResult

mappedDocuments
type: Property
domain: GuidelineSearchResult

guidelineResults
type: Property
domain: GuidelineSearchResult

moduleResults
type: Property
domain: GuidelineSearchResult

documentIds
type: Property
domain: GuidelineSearchResult

iterator
type: Property
domain: GuidelineSearchResult

documents
type: Property
domain: GuidelineSearchResult

lastPage
type: Property
domain: GuidelineSearchResult
range: decimal

totalItems
type: Property
domain: GuidelineSearchResult
range: decimal

currentPage
type: Property
domain: GuidelineSearchResult
range: decimal

itemsPerPage
type: Property
domain: GuidelineSearchResult
range: decimal

NewsItem
type: Class
title: NewsItem
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: lead
  title: lead
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: content
  title: content
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: publishedDate
  title: publishedDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: statusId
  title: statusId
  required: false
  readable: true
  writeable: false
  description: Required to be able to filter on status
supported property: SupportedProperty
  property: specialisms
  title: specialisms
  required: false
  readable: true
  writeable: false
supported operation: Retrieves NewsItem resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves NewsItem resource.
  returns: NewsItem

title
type: Property
domain: NewsItem
range: string

lead
type: Property
domain: NewsItem
range: string

content
type: Property
domain: NewsItem
range: string

publishedDate
type: Property
domain: NewsItem
range: dateTime

statusId
type: Property
domain: NewsItem
range: integer

specialisms
type: Link
domain: NewsItem
range: Specialism

GuidelineNavigation
type: Class
title: GuidelineNavigation
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: url
  title: url
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: order
  title: order
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: guideline
  title: guideline
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: module
  title: module
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: parent
  title: parent
  required: false
  readable: true
  writeable: false
supported operation: Retrieves GuidelineNavigation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves GuidelineNavigation resource.
  returns: GuidelineNavigation

title
type: Property
domain: GuidelineNavigation
range: string

url
type: Property
domain: GuidelineNavigation
range: string

order
type: Property
domain: GuidelineNavigation
range: integer

guideline
type: Link
domain: GuidelineNavigation
max cardinality: 1
range: Guideline

module
type: Link
domain: GuidelineNavigation
max cardinality: 1
range: Module

parent
type: Link
domain: GuidelineNavigation
max cardinality: 1
range: GuidelineNavigation

Guideline
type: Class
title: Guideline
supported property: SupportedProperty
  property: groupId
  title: groupId
  required: false
  readable: true
  writeable: false
  description: Version ID of the Guideline, in case a newer version of this Guideline is published its ID changes, but its groupId does not.
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: false
  description: Guideline title
supported property: SupportedProperty
  property: editorialStatusId
  title: editorialStatusId
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: inDevelopment
  title: inDevelopment
  required: false
  readable: true
  writeable: false
  description: If in development, a newer version is being worked on
supported property: SupportedProperty
  property: authorisationDate
  title: authorisationDate
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: assessmentDate
  title: assessmentDate
  required: false
  readable: true
  writeable: false
  description: On what date the Guideline was last checked
supported property: SupportedProperty
  property: initiators
  title: initiators
  required: false
  readable: true
  writeable: false
  description: Organisations that initiated the Guideline
supported property: SupportedProperty
  property: guidelineNavigation
  title: guidelineNavigation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: firstGuidelineNavigation
  title: firstGuidelineNavigation
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: statusId
  title: statusId
  required: false
  readable: false
  writeable: false
  description: Required to be able to filter on status
supported property: SupportedProperty
  property: contentViewLogs
  title: contentViewLogs
  required: false
  readable: true
  writeable: true
supported operation: Retrieves Guideline resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Guideline resource.
  returns: Guideline

groupId
type: Property
domain: Guideline
range: integer

title
type: Property
domain: Guideline
range: string

editorialStatusId
type: Property
domain: Guideline
range: integer

inDevelopment
type: Property
domain: Guideline
range: boolean

authorisationDate
type: Property
domain: Guideline
range: dateTime

assessmentDate
type: Property
domain: Guideline
range: dateTime

initiators
type: Link
domain: Guideline
range: Organisation

guidelineNavigation
type: Link
domain: Guideline
range: GuidelineNavigation

firstGuidelineNavigation
type: Link
domain: Guideline
max cardinality: 1
range: GuidelineNavigation

statusId
type: Property
domain: Guideline
range: integer

contentViewLogs
type: Link
domain: Guideline
range: ContentViewLog

Organisation
type: Class
title: Organisation
supported property: SupportedProperty
  property: fullName
  title: fullName
  required: false
  readable: true
  writeable: false
  description: Full name
supported property: SupportedProperty
  property: shortName
  title: shortName
  required: false
  readable: true
  writeable: false
  description: Abbreviated name
supported property: SupportedProperty
  property: website
  title: website
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: authorizedModules
  title: authorizedModules
  required: false
  readable: false
  writeable: false
supported property: SupportedProperty
  property: initiatedModules
  title: initiatedModules
  required: false
  readable: false
  writeable: false
supported operation: Retrieves Organisation resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Organisation resource.
  returns: Organisation

fullName
type: Property
domain: Organisation
range: string

shortName
type: Property
domain: Organisation
range: string

website
type: Property
domain: Organisation
range: string

authorizedModules
type: Property
domain: Organisation
range: Module

initiatedModules
type: Property
domain: Organisation
range: Module

Favourite
type: Class
title: Favourite
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: moduleGroupId
  title: moduleGroupId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: guidelineGroupId
  title: guidelineGroupId
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: moduleGuidelineStatusId
  title: moduleGuidelineStatusId
  required: false
  readable: false
  writeable: false
supported operation: Retrieves Favourite resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Favourite resource.
  returns: Favourite
supported operation: Deletes the Favourite resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Favourite resource.
  returns: Nothing
description: This endpoint is personalised based on the current JWT.

user
type: Link
domain: Favourite
max cardinality: 1
range: User

created
type: Property
domain: Favourite
range: dateTime

title
type: Property
domain: Favourite
range: string

moduleGroupId
type: Property
domain: Favourite
range: integer

guidelineGroupId
type: Property
domain: Favourite
range: integer

moduleGuidelineStatusId
type: Property
domain: Favourite
range: integer

Subscription
type: Class
title: Subscription
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: created
  title: created
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: moduleGroupId
  title: moduleGroupId
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: guidelineGroupId
  title: guidelineGroupId
  required: true
  readable: true
  writeable: true
supported operation: Retrieves Subscription resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves Subscription resource.
  returns: Subscription
supported operation: Deletes the Subscription resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the Subscription resource.
  returns: Nothing
description: This endpoint is personalised based on the current JWT.

user
type: Link
domain: Subscription
max cardinality: 1
range: User

created
type: Property
domain: Subscription
range: dateTime

moduleGroupId
type: Property
domain: Subscription
range: integer

guidelineGroupId
type: Property
domain: Subscription
range: integer

UserNotification
type: Class
title: UserNotification
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timestamp
  title: timestamp
  required: false
  readable: true
  writeable: false
supported property: SupportedProperty
  property: isRead
  title: isRead
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: title
  title: title
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: payload
  title: payload
  required: false
  readable: true
  writeable: true
supported operation: Retrieves UserNotification resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves UserNotification resource.
  returns: UserNotification
supported operation: Deletes the UserNotification resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the UserNotification resource.
  returns: Nothing
supported operation: Updates the UserNotification resource.
  type: Operation
  expects: UserNotification
  method: PATCH
  title: Updates the UserNotification resource.
  returns: UserNotification
description: This endpoint is personalised based on the current JWT.

user
type: Link
domain: UserNotification
max cardinality: 1
range: User

timestamp
type: Property
domain: UserNotification
range: dateTime

isRead
type: Property
domain: UserNotification
range: boolean

title
type: Property
domain: UserNotification
range: string

payload
type: Property
domain: UserNotification

ContentViewLog
type: Class
title: ContentViewLog
supported property: SupportedProperty
  property: module
  title: module
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: guideline
  title: guideline
  required: true
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timestamp
  title: timestamp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported operation: Retrieves ContentViewLog resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves ContentViewLog resource.
  returns: ContentViewLog
description: This endpoint is personalised based on the current JWT.

module
type: Link
domain: ContentViewLog
max cardinality: 1
range: Module

guideline
type: Link
domain: ContentViewLog
max cardinality: 1
range: Guideline

timestamp
type: Property
domain: ContentViewLog
range: dateTime

user
type: Link
domain: ContentViewLog
max cardinality: 1
range: User

RecentSearch
type: Class
title: RecentSearch
supported property: SupportedProperty
  property: user
  title: user
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: timestamp
  title: timestamp
  required: false
  readable: true
  writeable: true
supported property: SupportedProperty
  property: query
  title: query
  required: false
  readable: true
  writeable: true
supported operation: Retrieves RecentSearch resource.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves RecentSearch resource.
  returns: RecentSearch
supported operation: Deletes the RecentSearch resource.
  type: Operation
  type: DeleteAction
  method: DELETE
  title: Deletes the RecentSearch resource.
  returns: Nothing
supported operation: Updates the RecentSearch resource.
  type: Operation
  expects: RecentSearch
  method: PATCH
  title: Updates the RecentSearch resource.
  returns: RecentSearch
description: This endpoint is personalised based on the current JWT.

user
type: Link
domain: RecentSearch
max cardinality: 1
range: User

timestamp
type: Property
domain: RecentSearch
range: dateTime

query
type: Property
domain: RecentSearch
range: string

Entrypoint
type: Class
title: The API entrypoint
supported property: SupportedProperty
  property: The collection of User resources
  title: The collection of User resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Specialism resources
  title: The collection of Specialism resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Module resources
  title: The collection of Module resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ModuleReference resources
  title: The collection of ModuleReference resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ModuleFile resources
  title: The collection of ModuleFile resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ModuleHyperlink resources
  title: The collection of ModuleHyperlink resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ModuleAttachment resources
  title: The collection of ModuleAttachment resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ModuleSearchResult resources
  title: The collection of ModuleSearchResult resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of SuggestionSearch resources
  title: The collection of SuggestionSearch resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GuidelineSearchResult resources
  title: The collection of GuidelineSearchResult resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of NewsItem resources
  title: The collection of NewsItem resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of GuidelineNavigation resources
  title: The collection of GuidelineNavigation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Guideline resources
  title: The collection of Guideline resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Organisation resources
  title: The collection of Organisation resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Favourite resources
  title: The collection of Favourite resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of Subscription resources
  title: The collection of Subscription resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of UserNotification resources
  title: The collection of UserNotification resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of ContentViewLog resources
  title: The collection of ContentViewLog resources
  readable: true
  writeable: false
supported property: SupportedProperty
  property: The collection of RecentSearch resources
  title: The collection of RecentSearch resources
  readable: true
  writeable: false
supported operation: The API entrypoint.
  type: Operation
  method: GET
  returns: EntryPoint

The collection of User resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: User
supported operation: Retrieves the collection of User resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of User resources.
  returns: Collection

The collection of Specialism resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Specialism
supported operation: Retrieves the collection of Specialism resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Specialism resources.
  returns: Collection

The collection of Module resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Module
supported operation: Retrieves the collection of Module resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Module resources.
  returns: Collection

The collection of ModuleReference resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ModuleReference
supported operation: Retrieves the collection of ModuleReference resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ModuleReference resources.
  returns: Collection

The collection of ModuleFile resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ModuleFile
supported operation: Retrieves the collection of ModuleFile resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ModuleFile resources.
  returns: Collection

The collection of ModuleHyperlink resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ModuleHyperlink
supported operation: Retrieves the collection of ModuleHyperlink resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ModuleHyperlink resources.
  returns: Collection

The collection of ModuleAttachment resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ModuleAttachment
supported operation: Retrieves the collection of ModuleAttachment resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ModuleAttachment resources.
  returns: Collection

The collection of ModuleSearchResult resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ModuleSearchResult
supported operation: Retrieves the collection of ModuleSearchResult resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ModuleSearchResult resources.
  returns: Collection

The collection of SuggestionSearch resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: SuggestionSearch
supported operation: Retrieves the collection of SuggestionSearch resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of SuggestionSearch resources.
  returns: Collection

The collection of GuidelineSearchResult resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GuidelineSearchResult
supported operation: Retrieves the collection of GuidelineSearchResult resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GuidelineSearchResult resources.
  returns: Collection

The collection of NewsItem resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: NewsItem
supported operation: Retrieves the collection of NewsItem resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of NewsItem resources.
  returns: Collection

The collection of GuidelineNavigation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: GuidelineNavigation
supported operation: Retrieves the collection of GuidelineNavigation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of GuidelineNavigation resources.
  returns: Collection

The collection of Guideline resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Guideline
supported operation: Retrieves the collection of Guideline resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Guideline resources.
  returns: Collection

The collection of Organisation resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Organisation
supported operation: Retrieves the collection of Organisation resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Organisation resources.
  returns: Collection

The collection of Favourite resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Favourite
supported operation: Retrieves the collection of Favourite resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Favourite resources.
  returns: Collection
supported operation: Creates a Favourite resource.
  type: Operation
  type: CreateAction
  expects: Favourite
  method: POST
  title: Creates a Favourite resource.
  returns: Favourite

The collection of Subscription resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: Subscription
supported operation: Retrieves the collection of Subscription resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of Subscription resources.
  returns: Collection
supported operation: Creates a Subscription resource.
  type: Operation
  type: CreateAction
  expects: Subscription
  method: POST
  title: Creates a Subscription resource.
  returns: Subscription

The collection of UserNotification resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: UserNotification
supported operation: Retrieves the collection of UserNotification resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of UserNotification resources.
  returns: Collection

The collection of ContentViewLog resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: ContentViewLog
supported operation: Retrieves the collection of ContentViewLog resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of ContentViewLog resources.
  returns: Collection
supported operation: Creates a ContentViewLog resource.
  type: Operation
  type: CreateAction
  expects: ContentViewLog
  method: POST
  title: Creates a ContentViewLog resource.
  returns: ContentViewLog

The collection of RecentSearch resources
type: Link
domain: Entrypoint
range: Collection
range:
  equivalent class:
    on property: member
    all values from: RecentSearch
supported operation: Retrieves the collection of RecentSearch resources.
  type: Operation
  type: FindAction
  method: GET
  title: Retrieves the collection of RecentSearch resources.
  returns: Collection
supported operation: Creates a RecentSearch resource.
  type: Operation
  type: CreateAction
  expects: RecentSearch
  method: POST
  title: Creates a RecentSearch resource.
  returns: RecentSearch

ConstraintViolation
type: Class
title: A constraint violation
supported property: SupportedProperty
  property: propertyPath
  title: propertyPath
  description: The property path of the violation
  readable: true
  writeable: false
supported property: SupportedProperty
  property: message
  title: message
  description: The message associated with the violation
  readable: true
  writeable: false

propertyPath
type: Property
domain: ConstraintViolation
range: string

message
type: Property
domain: ConstraintViolation
range: string

ConstraintViolationList
type: Class
subclass of: Error
title: A constraint violation list
supported property: SupportedProperty
  property: violations
  title: violations
  description: The violations
  readable: true
  writeable: false

violations
type: Property
domain: ConstraintViolationList
range: ConstraintViolation

SupportedProperty
property: attachments
title: attachments
required: false
readable: true
writeable: false

SupportedProperty
property: hyperlinks
title: hyperlinks
required: false
readable: true
writeable: false

SupportedProperty
property: files
title: files
required: false
readable: true
writeable: false

SupportedProperty
property: references
title: references
required: false
readable: true
writeable: false

SupportedProperty
property: referenceStyleId
title: referenceStyleId
required: false
readable: true
writeable: false

SupportedProperty
property: statusId
title: statusId
required: false
readable: false
writeable: false
description: Required to be able to filter on status

SupportedProperty
property: editorialStatusId
title: editorialStatusId
required: false
readable: false
writeable: false

SupportedProperty
property: contentViewLogs
title: contentViewLogs
required: false
readable: true
writeable: true

SupportedProperty
property: attachments
title: attachments
required: false
readable: true
writeable: false

SupportedProperty
property: hyperlinks
title: hyperlinks
required: false
readable: true
writeable: false

SupportedProperty
property: references
title: references
required: false
readable: true
writeable: false

Retrieves Module resource.
type: Operation
type: FindAction
method: GET
title: Retrieves Module resource.
returns: Module