invantive documentation
Invantive Support ForumsLog In / Sign Up

NotificationsByEmployerId: Loket.nl REST itgen_loketnl_notificationsbyemployerid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: Notification
  • Label: itgen_loketnl_notificationsbyemployerid_plural

Get a list of notifications for an employer. Activity name : GetNotificationsByEmployerId

Get a list of unread notifications for an employer

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/{employerId}/notifications
  • Operation: get /providers/employers/{employerId}/notifications

Parameters

Name Data Type Required Default Documentation
employerId `` The unique identifier of the employer

Table Columns

The columns of the table NotificationsByEmployerId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
appliesToEmployee_dateOfBirth datetime itgen_loketnl_appliestoemployee_dateofbirth The date of birth
appliesToEmployee_employeeNumber int32 itgen_loketnl_appliestoemployee_employeenumber The employee number to uniquely identify a employee within a employer.
appliesToEmployee_firstName varchar2(28) itgen_loketnl_appliestoemployee_firstname The first name of the employee
appliesToEmployee_formattedName varchar2(82) itgen_loketnl_appliestoemployee_formattedname Formatted name of the employee based on the value of howToFormatLastName
appliesToEmployee_id guid itgen_loketnl_appliestoemployee_id The unique identifier of an object (GUID/UUID)
appliesToEmployee_initials varchar2(6) itgen_loketnl_appliestoemployee_initials The initials of the employee
appliesToEmployee_lastName varchar2(25) itgen_loketnl_appliestoemployee_lastname The last name of the employee
appliesToEmployee_lastNamePartner varchar2(25) itgen_loketnl_appliestoemployee_lastnamepartner The last name of the partner of the employee
appliesToEmployee_photo varchar2 itgen_loketnl_appliestoemployee_photo A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output.
appliesToEmployee_prefix varchar2(10) itgen_loketnl_appliestoemployee_prefix The prefix of the employee
appliesToEmployee_prefixPartner varchar2(10) itgen_loketnl_appliestoemployee_prefixpartner The prefix of the partner of the employee
id guid ID The unique identifier of an object (GUID/UUID)
isRead char Has been Read Indicates whether the notification has been read
markedAsReadBy_formattedName varchar2 itgen_loketnl_markedasreadby_formattedname preformatted user name for displaying. <lastname>", "<initials>" "<prefix>
markedAsReadBy_id guid itgen_loketnl_markedasreadby_id The unique identifier of an object (GUID/UUID)
markedAsReadBy_initials varchar2(6) itgen_loketnl_markedasreadby_initials The initials of the user
markedAsReadBy_lastName varchar2(25) itgen_loketnl_markedasreadby_lastname The last name of the user
markedAsReadBy_prefix varchar2(10) itgen_loketnl_markedasreadby_prefix The prefix of the user
markedAsReadOn datetime itgen_loketnl_markedasreadon The time at which the notificiation was marked as read.
notificationDate datetime Notification Date The date on which the event of the notificationType (e.g. birthday or anniversary) will occure
notificationType_key int32 Notification Type Key
notificationType_value varchar2 Notification Type Value
notificationTypeClarification varchar2(150) itgen_loketnl_notificationtypeclarification Optional text

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: