LOloket
Custom notification

Add a custom notification for an employment

Activity name : <a href="https://developer.loket.nl/Activities/PostCustomNotificationByEmploymentId" target="_blank">PostCustomNotificationByEmploymentId</a>

Metadata: Possible options for fields of the type 'metadata' can be acquired(GET)by adding /metadata to the POST URL.

Defaults: Default values for a new object can be acquired by adding `/defaults' to the POST URL.

post/v2/providers/employers/employees/employments/{employmentId}/customnotifications

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/employees/employments/{employmentId}/customnotifications
  • Auth
    none required

Path parameters

employmentIdstring uuid required

The unique identifier of the employment

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

Request body

idstring uuid

The unique identifier of an object (GUID/UUID)

notificationDatestring date

The date on which the first notification occurs.

expirationDatestring date nullable

The date on which the Notification will expire.

notificationTextstring

The description of the signal

Example request

{
  "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
  "notificationDate": "2021-01-01",
  "expirationDate": "2021-01-23",
  "notificationText": "Signal renew document",
  "recurrencePattern": {
    "recurrenceNumber": 2,
    "recurrencePeriod": {
      "key": 2,
      "value": "Weeks"
    },
    "numberOfRepetitionsAfterFirstNotification": 4
  }
}

Response

Created

Example response

{
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "content": {
    "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
    "notificationDate": "2021-01-01",
    "expirationDate": "2021-01-23",
    "notificationText": "Signal renew document",
    "recurrencePattern": {
      "recurrenceNumber": 2,
      "recurrencePeriod": {
        "key": 2,
        "value": "Weeks"
      },
      "numberOfRepetitionsAfterFirstNotification": 4
    }
  }
}

Changes

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