NotificationData

Provides information about notification (outstanding invoice or questionnaire, etc.).

Properties

Key	string	Key of the notification.
Type	int	The type of the notification: 1 = Appointment coming up soon 2 = Outstanding questionnaire 4 = Outstanding invoice 8 = Outstanding messages 16 = Action required 32 = Referral notification
Message	string	Message of the notification.
ObjectKey	string	Key of the related object to this notification according to the Type of the notification (e.g. notification of type 2 ‘Outstanding questionnaire’ relates to the questionnaire so the object key means the questionnaire key. By the Type the ObjectKey means: 1 = appointment key 2 = questionnaire key 4 = invoice key 8 = feed key 16 = ‘SetContactOptions’ to force patient to set their contact options. ‘AcceptTermsAndConditions’ to force patient to re-accept the Terms and conditions. 32 = referral key The client can use this key to redirect/show more details about related objects.

JSON Example

{
    "Key": "2-1568",
    "Type": 1,
    "Message": "You need to complete pre-medical questionnaire.",
    "ObjectKey": "1568"
}