LOloket-acc
Event notification configuration

The event notification configuration for a provider

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

Get a list of the notification configurations for certain events for a provider. Currently its only possible to configure email recipients for an event notification.

Note: Event notifications can be configured on payroll administration and provider level. This endpoint returns the provider level value or no value if none is registred at providerlevel.

get/v2/providers/{providerId}/eventnotificationconfigurations

Request

Path parameters

providerIdstring uuid required

The unique identifier of a provider

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

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

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "type": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "description": "Verlofaanvraag behandeld (voor de indiener)",
        "sortOrder": 210
      },
      "category": {
        "key": 3,
        "value": "Verlof"
      },
      "dependsOnModule": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "description": "Verlof"
      },
      "definedAtLevel": "Provider",
      "emailAddress": "info@loket.nl"
    }
  ]
}

Changes

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