Skip to main content

Get medical settings notifications consent

Deprecated

This route is deprecated. Use GET /v1/me/consent/medical instead. The replacement returns the consent with its id and acceptance time, and a newly published version does not turn it off there.

MethodPath
GET/v1/slim/user/medical-settings-notifications-consent

Authentication · Access policies

Returns whether the signed-in practitioner has given the medical settings notifications consent.

Auth: Bearer token for a practitioner session (the profile must be a Practitioner). The caller's access policy must grant Consent:read and Consent:search (project admins skip this check). Scope: The caller's practitioner profile in the caller's project (from the token).

Request​

No parameters.

Behaviour​

  • medicalSettingsNotificationsConsent is true only when a consent is on file and either matches the currently published version of this consent or no version has been published yet.
  • Publishing a new version turns it false for everyone until they give the consent again. GET /v1/me/consent/medical does not do this: only withdrawing ends the consent there.
  • The published version is the one of the root project of your project tree: a child project follows its parent's version. Without one, the platform-wide version applies.
  • A practitioner with no consent on file reads false.
  • GET /v1/slim/user/consents returns the same value together with the terms consent.

Example​

curl -X GET 'https://api.sandbox.ovok.com/v1/slim/user/medical-settings-notifications-consent' \
-H "Authorization: Bearer ${OVOK_TOKEN}"

Successful response​

200 — Medical settings notifications consent status retrieved successfully.

{
"medicalSettingsNotificationsConsent": true
}
FieldTypeDescription
medicalSettingsNotificationsConsentbooleanWhether the practitioner has given the consent on the current version.

Errors​

StatusMeaning
401The bearer token is missing or invalid.
403The session is not a practitioner session, has no project, or its access policy lacks Consent:read or Consent:search.
429Too many requests.
503Your access policy could not be read, or the service is temporarily over capacity. Retry shortly, and honour Retry-After when it is present.