LOloket
Notification

Get notification by ID.

Activity name : <a href="https://developer.loket.nl/Activities/GetNotificationByNotificationId" target="_blank">GetNotificationByNotificationId</a> Retrieve a specific notification by its unique identifier. The notification is returned with the employer and employee information.

get/v2/providers/employers/notifications/{notificationId}

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/notifications/{notificationId}
  • Auth
    none required

Path parameters

notificationIdstring uuid required

The unique identifier of an object (GUID/UUID)

Example:b14acd0d-75d7-4fc8-8b22-4a3924585cab

The unique identifier of a notification

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK

idstring uuid

The unique identifier of an object (GUID/UUID)

employerIdstring uuid

The unique identifier of an object (GUID/UUID)

employerNamestring

Name of the administration

employerLogostring url nullable

The location of the logo of the employer. 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.

notificationTypeClarificationstring nullable

Optional text

isReadboolean

Indicates whether the notification has been read

notificationDatestring date

The date on which the event of the notificationType (e.g. birthday or anniversary) will occure

markedAsReadBystring

preformatted user name for displaying. <lastname>", "<initials>" "<prefix>

markedAsReadOnstring date-time nullable

The time at which the notificiation was marked as read.

Example response

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "employerId": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "employerName": "VST Consultancy",
  "employerLogo": "https://api.loket.nl/v2/v2/providers/employers/{guid}/logo/{version}",
  "employer": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "companyName": "Voorbeeld B.V.",
    "employerNumber": 20720,
    "administrationNumber": "SR2",
    "groupCode": 40
  },
  "payrollAdministration": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "name": "Voorbeeld B.V. - Payroll",
    "shortName": "ABC adm",
    "administrationNumber": "SR2",
    "clientNumber": 1234,
    "groupCode": 40,
    "groupClassification": {
      "key": 3,
      "value": "South"
    },
    "payrollPeriodType": {
      "key": 2,
      "value": "month"
    },
    "cla": {
      "key": 184,
      "value": "Agriculture"
    },
    "wagemodel": {
      "key": 184,
      "value": "Foresting monthly payrolling"
    }
  },
  "nonPayrollAdministration": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "name": "Voorbeeld B.V. - Non payroll"
  },
  "notificationType": {
    "key": 1,
    "value": "Verjaardag"
  },
  "notificationTypeClarification": "30 Jaar",
  "notificationDate": "2018-02-05",
  "markedAsReadBy": "Jong, I",
  "markedAsReadOn": "2018-02-05T12:29:44+02:00",
  "appliesToEmployee": {
    "formattedName": "Jong, I",
    "employeeNumber": 156
  }
}

Changes

No recorded changes to this operation across all 6 revisions of this API.