Privacy Notice Endpoint
The Privacy Notice endpoint provides REST API access to Privacy & Security Notice functionality for Angular frontend applications. This endpoint allows applications to retrieve current privacy notices, check user acceptance status, and record user acceptance.
Privacy Notice endpoints have special security considerations:
/admin-json/privacy-notice
and /admin-json/privacy-notice/status
) are exempt from the Privacy & Security Notice filter to prevent infinite redirect loopsACCESS_ADMIN_JSON
permission is required to access these endpointsRetrieves the current privacy notice content and metadata.
URL: GET /admin-json/privacy-notice
Required Permissions: ACCESS_ADMIN_JSON
Response:
{
"content": "This is the privacy notice content...",
"version": "2025.01.15",
"isActive": true,
"expiryDays": 90
}
Response Fields:
content
(string): The privacy notice text contentversion
(string): The current version identifier of the privacy noticeisActive
(boolean): Whether the privacy notice is active (has both content and version)expiryDays
(integer): Number of days after which acceptance expiresChecks the current user's privacy notice acceptance status.
URL: GET /admin-json/privacy-notice/status
Required Permissions: ACCESS_ADMIN_JSON
Response:
{
"isRequired": true,
"currentVersion": "2025.01.15"
}
Response Fields:
isRequired
(boolean): Whether the user needs to accept the current privacy noticecurrentVersion
(string): The current version of the privacy noticeRecords the user's acceptance of the current privacy notice version.
URL: POST /admin-json/privacy-notice/accept
Required Permissions: ACCESS_ADMIN_JSON
Request Body:
{
"version": "2025.01.15"
}
Request Fields:
version
(string): The version of the privacy notice being accepted (must match current version)Response:
{
"success": true,
"acceptedDate": "2025-01-15T10:30:00Z"
}
Response Fields:
success
(boolean): Whether the acceptance was successfully recordedacceptedDate
(string): ISO-8601 timestamp when the acceptance was recordedWhen attempting to accept a privacy notice version that doesn't match the current version:
{
"error": "Version mismatch: attempted to accept version '2025.01.10' but current version is '2025.01.15'"
}
When authentication is missing or invalid:
{
"error": "Authentication is required"
}
When the service encounters an unexpected error:
{
"error": "Failed to retrieve privacy notice: [error details]"
}
These endpoints are designed to support front-end web applications that need to:
The endpoints integrate with the existing Privacy & Security Notice infrastructure in Smile CDR, including:
privacy_security_notice
configuration categoryYou are about to leave the Smile Digital Health documentation and navigate to the Open Source HAPI-FHIR Documentation.