HTM/ovpay
4
0
Fork 0
Code Issues Pull Requests 2 Actions Packages Projects Releases 1 Wiki Activity

OVPAY-2387 - Updated examples for GET /notificationcategories.

Browse Source
This commit is contained in:
Bas Boterman 2026-03-11 15:44:16 +01:00
parent 2b02e52c22
commit 8b148b22ac
1 changed files with 331 additions and 51 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

382
src/openapi/customers/notifications-crud.yaml
View File

@ -78,7 +78,7 @@ paths:
notificationCategory: notificationCategory:
notificationCategoryId: 1 notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
customerProfileId: 1337 customerProfileId: 1337
ovPayTokenId: 42 ovPayTokenId: 42
subscriptionActivities: subscriptionActivities:
@ -115,7 +115,7 @@ paths:
notificationCategory: notificationCategory:
notificationCategoryId: 1 notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
customerProfileId: 1337 customerProfileId: 1337
ovPayTokenId: 42 ovPayTokenId: 42
subscriptionActivities: subscriptionActivities:
@ -160,7 +160,7 @@ paths:
notificationCategory: notificationCategory:
notificationCategoryId: 1 notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
customerProfileId: 1337 customerProfileId: 1337
ovPayTokenId: 42 ovPayTokenId: 42
subscriptionActivities: subscriptionActivities:
@ -677,22 +677,28 @@ paths:
notificationCategories: notificationCategories:
- notificationCategoryId: 1 - notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
- notificationCategoryId: 2 - notificationCategoryId: 2
name: Nieuwsbrief aanmelding name: Nieuwsbrief aanmelding
groupName: Marketing groupName: Marketing
- notificationCategoryId: 3 - notificationCategoryId: 3
name: Serviceberichten name: Serviceberichten
groupName: Mijn Passen groupName: Onderweg
- notificationCategoryId: 4
name: Producten
groupName: Onderweg
- notificationCategoryId: 5
name: Dragers
groupName: Onderweg
getNotifactionCategories?expand=eventType: getNotifactionCategories?expand=eventType:
summary: Return all the notification categories with nested event types (expand=eventType) summary: Return all the notification categories with nested event types (expand=eventType)
value: value:
notificationCategories: notificationCategories:
- notificationCategoryId: 1 - notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
eventTypes: eventTypes:
- eventTypeId: 2 - eventTypeId: 1
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
@ -704,23 +710,47 @@ paths:
originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_TRIPS name: GBO_TRIPS
externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210 externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
- eventTypeId: 2
eventOrigin:
eventOriginId: 1
name: GBO
name: TRIPS
subName: CKO
prettyName: Normal Check-out
optinRequired: false
originSubscription:
originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_TRIPS
externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
- eventTypeId: 3 - eventTypeId: 3
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
name: PAD name: TRIPS
subName: AMEND subName: MISSING_CKI
prettyName: PAD Wijzigen/Aanvullen prettyName: Missing Check-in
optinRequired: false optinRequired: false
originSubscription: originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_PAD name: GBO_TRIPS
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
- eventTypeId: 4
eventOrigin:
eventOriginId: 1
name: GBO
name: TRIPS
subName: MISSING_CKO
prettyName: Missing Check-out
optinRequired: false
originSubscription:
originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_TRIPS
externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
- notificationCategoryId: 2 - notificationCategoryId: 2
name: Nieuwsbrief aanmelding name: Nieuwsbrief aanmelding
groupName: Marketing groupName: Marketing
eventTypes: eventTypes:
- eventTypeId: 1 - eventTypeId: 5
eventOrigin: eventOrigin:
eventOriginId: 6 eventOriginId: 6
name: Maileon name: Maileon
@ -731,9 +761,37 @@ paths:
originSubscription: null originSubscription: null
- notificationCategoryId: 3 - notificationCategoryId: 3
name: Serviceberichten name: Serviceberichten
groupName: Mijn Passen groupName: Onderweg
eventTypes: eventTypes:
- eventTypeId: 4 - eventTypeId: 6
eventOrigin:
eventOriginId: 1
name: GBO
name: ACCOUNT
subName: MARKED
prettyName: PAD Markering
optinRequired: false
originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc
name: GBO_ACCOUNT
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f
- eventTypeId: 7
eventOrigin:
eventOriginId: 1
name: GBO
name: ACCOUNT
subName: AMEND
prettyName: PAD Aanvullen
optinRequired: false
originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc
name: GBO_ACCOUNT
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f
- notificationCategoryId: 4
name: Producten
groupName: Onderweg
eventTypes:
- eventTypeId: 8
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
@ -745,27 +803,55 @@ paths:
originSubscriptionId: f1a2b3c4-d5e6-4789-abcd-3456789012de originSubscriptionId: f1a2b3c4-d5e6-4789-abcd-3456789012de
name: GBO_PRODUCT name: GBO_PRODUCT
externalSubscriptionId: 12345678-90ab-cdef-1234-567890abcdef externalSubscriptionId: 12345678-90ab-cdef-1234-567890abcdef
- eventTypeId: 5 - eventTypeId: 9
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
name: PAD name: PRODUCT
subName: MARK subName: REFUND
prettyName: PAD Markering prettyName: Product Beeindigd
optinRequired: false optinRequired: false
originSubscription: originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc originSubscriptionId: f1a2b3c4-d5e6-4789-abcd-3456789012de
name: GBO_PAD name: GBO_PRODUCT
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f externalSubscriptionId: 12345678-90ab-cdef-1234-567890abcdef
- notificationCategoryId: 5
name: Dragers
groupName: Onderweg
eventTypes:
- eventTypeId: 10
eventOrigin:
eventOriginId: 1
name: GBO
name: CARD
subName: EXPIRED
prettyName: Drager Verlopen
optinRequired: false
originSubscription:
originSubscriptionId: c3d4e5f6-a789-4bcd-ef01-4567890123de
name: GBO_CARD
externalSubscriptionId: 23456789-0abc-def1-2345-67890abcdef1
- eventTypeId: 11
eventOrigin:
eventOriginId: 1
name: GBO
name: CARD
subName: SUSPENDED
prettyName: Drager staat op de denylist
optinRequired: false
originSubscription:
originSubscriptionId: c3d4e5f6-a789-4bcd-ef01-4567890123de
name: GBO_CARD
externalSubscriptionId: 23456789-0abc-def1-2345-67890abcdef1
getNotifactionCategories?expand=eventTypeChannel: getNotifactionCategories?expand=eventTypeChannel:
summary: Return all the notification categories with all nested attributes (expand=eventTypeChannel) summary: Return all the notification categories with all nested attributes (expand=eventTypeChannel)
value: value:
notificationCategories: notificationCategories:
- notificationCategoryId: 1 - notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
eventTypes: eventTypes:
- eventTypeId: 2 - eventTypeId: 1
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
@ -796,20 +882,20 @@ paths:
name: customers name: customers
isDefault: false isDefault: false
isMandatory: false isMandatory: false
- eventTypeId: 3 - eventTypeId: 2
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
name: PAD name: TRIPS
subName: AMEND subName: CKO
prettyName: PAD Wijzigen/Aanvullen prettyName: Normal Check-out
optinRequired: false optinRequired: false
originSubscription: originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_PAD name: GBO_TRIPS
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
eventTypeChannels: eventTypeChannels:
- eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432 - eventTypeChannelId: ccc8c025-06b5-4928-a632-23e1c55cd173
channel: channel:
channelId: 1 channelId: 1
name: push name: push
@ -818,7 +904,69 @@ paths:
name: devices name: devices
isDefault: true isDefault: true
isMandatory: false isMandatory: false
- eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2 - eventTypeChannelId: da2deb4c-ce77-4b5f-aecc-ddebfd14349d
channel:
channelId: 2
name: email
resourceName:
resourceNameId: 4
name: customers
isDefault: false
isMandatory: false
- eventTypeId: 3
eventOrigin:
eventOriginId: 1
name: GBO
name: TRIPS
subName: MISSING_CKI
prettyName: Missing Check-in
optinRequired: false
originSubscription:
originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_TRIPS
externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
eventTypeChannels:
- eventTypeChannelId: ccc8c025-06b5-4928-a632-23e1c55cd173
channel:
channelId: 1
name: push
resourceName:
resourceNameId: 8
name: devices
isDefault: true
isMandatory: false
- eventTypeChannelId: da2deb4c-ce77-4b5f-aecc-ddebfd14349d
channel:
channelId: 2
name: email
resourceName:
resourceNameId: 4
name: customers
isDefault: false
isMandatory: false
- eventTypeId: 4
eventOrigin:
eventOriginId: 1
name: GBO
name: TRIPS
subName: MISSING_CKO
prettyName: Missing Check-out
optinRequired: false
originSubscription:
originSubscriptionId: a1b2c3d4-e5f6-4789-abcd-1234567890ab
name: GBO_TRIPS
externalSubscriptionId: fedcba98-7654-3210-fedc-ba9876543210
eventTypeChannels:
- eventTypeChannelId: ccc8c025-06b5-4928-a632-23e1c55cd173
channel:
channelId: 1
name: push
resourceName:
resourceNameId: 8
name: devices
isDefault: true
isMandatory: false
- eventTypeChannelId: da2deb4c-ce77-4b5f-aecc-ddebfd14349d
channel: channel:
channelId: 2 channelId: 2
name: email name: email
@ -831,7 +979,7 @@ paths:
name: Nieuwsbrief aanmelding name: Nieuwsbrief aanmelding
groupName: Marketing groupName: Marketing
eventTypes: eventTypes:
- eventTypeId: 1 - eventTypeId: 5
eventOrigin: eventOrigin:
eventOriginId: 6 eventOriginId: 6
name: Maileon name: Maileon
@ -852,9 +1000,75 @@ paths:
isMandatory: false isMandatory: false
- notificationCategoryId: 3 - notificationCategoryId: 3
name: Serviceberichten name: Serviceberichten
groupName: Mijn Passen groupName: Onderweg
eventTypes: eventTypes:
- eventTypeId: 4 - eventTypeId: 6
eventOrigin:
eventOriginId: 1
name: GBO
name: ACCOUNT
subName: MARKED
prettyName: PAD Markering
optinRequired: false
originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc
name: GBO_ACCOUNT
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f
eventTypeChannels:
- eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel:
channelId: 1
name: push
resourceName:
resourceNameId: 8
name: devices
isDefault: true
isMandatory: false
- eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel:
channelId: 2
name: email
resourceName:
resourceNameId: 4
name: customers
isDefault: false
isMandatory: false
- eventTypeId: 7
eventOrigin:
eventOriginId: 1
name: GBO
name: ACCOUNT
subName: AMEND
prettyName: PAD Aanvullen
optinRequired: false
originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc
name: GBO_ACCOUNT
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f
eventTypeChannels:
- eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel:
channelId: 1
name: push
resourceName:
resourceNameId: 8
name: devices
isDefault: true
isMandatory: false
- eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel:
channelId: 2
name: email
resourceName:
resourceNameId: 4
name: customers
isDefault: false
isMandatory: false
- notificationCategoryId: 4
name: Producten
groupName: Onderweg
eventTypes:
- eventTypeId: 8
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
@ -867,7 +1081,7 @@ paths:
name: GBO_PRODUCT name: GBO_PRODUCT
externalSubscriptionId: 12345678-90ab-cdef-1234-567890abcdef externalSubscriptionId: 12345678-90ab-cdef-1234-567890abcdef
eventTypeChannels: eventTypeChannels:
- eventTypeChannelId: be07c7bb-714b-4637-acf5-a67025ad8e60 - eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel: channel:
channelId: 1 channelId: 1
name: push name: push
@ -876,7 +1090,7 @@ paths:
name: devices name: devices
isDefault: true isDefault: true
isMandatory: false isMandatory: false
- eventTypeChannelId: 0c797b5a-ed34-494b-8c64-0a832830d392 - eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel: channel:
channelId: 2 channelId: 2
name: email name: email
@ -885,20 +1099,20 @@ paths:
name: customers name: customers
isDefault: false isDefault: false
isMandatory: false isMandatory: false
- eventTypeId: 5 - eventTypeId: 9
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
name: PAD name: PRODUCT
subName: MARK subName: REFUND
prettyName: PAD Markering prettyName: Product Beeindigd
optinRequired: false optinRequired: false
originSubscription: originSubscription:
originSubscriptionId: b2c3d4e5-f678-49ab-bcde-2345678901bc originSubscriptionId: f1a2b3c4-d5e6-4789-abcd-3456789012de
name: GBO_PAD name: GBO_PRODUCT
externalSubscriptionId: edcba987-6543-210f-edcb-a9876543210f externalSubscriptionId: 12345678-90ab-cdef-1234-567890abcdef
eventTypeChannels: eventTypeChannels:
- eventTypeChannelId: b910368f-c045-4e8e-b01d-bcbc78708bac - eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel: channel:
channelId: 1 channelId: 1
name: push name: push
@ -907,7 +1121,73 @@ paths:
name: devices name: devices
isDefault: true isDefault: true
isMandatory: false isMandatory: false
- eventTypeChannelId: 93e773da-ba3b-48da-9a0e-ee478eaa752f - eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel:
channelId: 2
name: email
resourceName:
resourceNameId: 4
name: customers
isDefault: false
isMandatory: false
- notificationCategoryId: 5
name: Dragers
groupName: Onderweg
eventTypes:
- eventTypeId: 10
eventOrigin:
eventOriginId: 1
name: GBO
name: CARD
subName: EXPIRED
prettyName: Drager Verlopen
optinRequired: false
originSubscription:
originSubscriptionId: c3d4e5f6-a789-4bcd-ef01-4567890123de
name: GBO_CARD
externalSubscriptionId: 23456789-0abc-def1-2345-67890abcdef1
eventTypeChannels:
- eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel:
channelId: 1
name: push
resourceName:
resourceNameId: 8
name: devices
isDefault: true
isMandatory: false
- eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel:
channelId: 2
name: email
resourceName:
resourceNameId: 4
name: customers
isDefault: false
isMandatory: false
- eventTypeId: 11
eventOrigin:
eventOriginId: 1
name: GBO
name: CARD
subName: SUSPENDED
prettyName: Drager staat op de denylist
optinRequired: false
originSubscription:
originSubscriptionId: c3d4e5f6-a789-4bcd-ef01-4567890123de
name: GBO_CARD
externalSubscriptionId: 23456789-0abc-def1-2345-67890abcdef1
eventTypeChannels:
- eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel:
channelId: 1
name: push
resourceName:
resourceNameId: 8
name: devices
isDefault: true
isMandatory: false
- eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel: channel:
channelId: 2 channelId: 2
name: email name: email
@ -1200,7 +1480,7 @@ paths:
notificationCategory: notificationCategory:
notificationCategoryId: 1 notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
- eventType: - eventType:
eventTypeId: 16 eventTypeId: 16
eventOrigin: eventOrigin:
@ -1213,7 +1493,7 @@ paths:
notificationCategory: notificationCategory:
notificationCategoryId: 1 notificationCategoryId: 1
name: Mijn Reizen name: Mijn Reizen
groupName: Mijn Passen groupName: Onderweg
"400": "400":
description: Bad request description: Bad request
content: content:
@ -1660,7 +1940,7 @@ components:
example: Mijn Reizen example: Mijn Reizen
groupName: groupName:
type: string type: string
example: Mijn Passen example: Onderweg
eventTypes: eventTypes:
type: array type: array
items: items: