GetNotifications

Returns notifications about appointments, invoices, questionnaires etc.

JavaScript library method

patientportal.notification.getNotifications({type: <type>});

HTTP Method

Verb URL
GET /patientportalapi/notification/notifications

URL Parameters

type

int (optional)

The type of the notification the client requests:

  • 1 = Appointments that coming up soon
  • 2 = Outstanding questionnaires
  • 4 = Outstanding invoices
  • 8 = Outstanding messages
  • 16 = Action required
  • 32 = Referral notification
  • 64 = Membership payment required

Note: The client can use a combination (sum) of several types. For example 1+4=5 returns notifications about appointments that coming up soon and outstanding invoices.

Default value is 95 (all but referral notifications)

Returns

NotificationData[]