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

OVPAY-1859 - Updated id's to reflect reality.

Browse Source
This commit is contained in:
Bas Boterman 2025-12-01 13:34:58 +01:00
parent ed40c1d546
commit e0e70af138
2 changed files with 369 additions and 472 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

752
src/openapi/customers/SE-notifications.yaml
View File

@ -9,10 +9,10 @@ servers:
tags: tags:
- name: Notification categories - name: Notification categories
description: >- description: >-
Service Engine APIs for all HTM Notifications metadata. To build content only. Service Engine APIs for all HTM Notifications metadata. To build content only.
- name: Notification subscriptions - name: Notification subscriptions
description: >- description: >-
Service Engine APIs for the HTM Notification subscriptions for a user. Contains the subscriptions on category level Service Engine APIs for the HTM Notification subscriptions for a user. Contains the subscriptions on category level
- name: Notification preferences - name: Notification preferences
description: >- description: >-
//future Service Engine APIs for the HTM Notification preferences for a category for a user. Contains the discrepancies from the default. or //future Service Engine APIs for the HTM Notification preferences for a category for a user. Contains the discrepancies from the default. or
@ -20,319 +20,225 @@ paths:
/notificationcategories: /notificationcategories:
get: get:
tags: tags:
- Notification categories - Notification categories
summary: Get notification categories and optins references for that category that a touchpoint can show. summary: Get notification categories and optins references for that category that a touchpoint can show.
description: | description: |
Get notification categories that a touchpoint can show and optins ( eventTypes) and channels (eventType_channels) for the optin for that category Get notification categories that a touchpoint can show and optins ( eventTypes) and channels (eventType_channels) for the optin for that category
parameters: parameters:
- name: expand - name: expand
in: query in: query
schema: schema:
type: string type: string
enum: [none, eventType, eventTypeChannel] enum: [none, eventType, eventTypeChannel]
default: none default: none
responses: responses:
"200": "200":
description: OK description: OK
content: content:
application/json: application/json:
examples: examples:
getNotifactionCategories?expand=eventTypeChannel:
summary: Return all the notification categories with their nested attributes
value:
{
"notificationCategories":[
{
"notificationCategoryId": 1,
"name": "Nieuwsbrief",
"eventTypes": [
{
"eventTypeId": 1,
"eventOrigin": {
"eventOriginId": 6,
"name": "Maileon"
},
"name": "HTM nieuwsbrief",
"subName": "",
"prettyName": "HTM nieuwsbrief",
"optinRequired": False,
"eventTypeChannels":[
{
"eventTypeChannelId": "447a1116-6cd7-4645-8c3d-43237b6186cd",
"channel":{
"channelId": 2,
"name": "email"
},
"isDefault": True,
"isMandatory": False
}
]
}
]
},
{
"notificationCategoryId": 2,
"name": "Mijn Reizen",
"eventTypes": [
{
"eventTypeId": 2,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, TRAVEL_SCHEME",
"subName": "CI",
"prettyName": "Check In",
"optinRequired": False,
"eventTypeChannels":[
{
"eventTypeChannelId": "ccc8c025-06b5-4928-a632-23e1c55cd173",
"channel":{
"channelId": 1,
"name": "push"
},
"isDefault": True,
"isMandatory": False
},
{
"eventTypeChannelId": "da2deb4c-ce77-4b5f-aecc-ddebfd14349d",
"channel":{
"channelId": 2,
"name": "email"
},
"isDefault": False,
"isMandatory": False
}
]
},
{
"eventTypeId": 3,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, PAD",
"subName": null,
"prettyName": "Profielgegevens op de pas",
"optinRequired": False,
"eventTypeChannels":[
{
"eventTypeChannelId": "8e7df8f1-7e50-482f-8301-d399e75fd432",
"channel":{
"channelId": 1,
"name": "push"
},
"isDefault": True,
"isMandatory": False
},
{
"eventTypeChannelId": "72960a92-1855-469f-9cfd-5d72f57106f2",
"channel":{
"channelId": 2,
"name": "email"
},
"isDefault": False,
"isMandatory": False
}
]
}
]
},
{
"notificationCategoryId": 3,
"name": "Mijn Passen",
"eventTypes": [
{
"eventTypeId": 4,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, CARD",
"subName": null,
"prettyName": "Mijn passen",
"optinRequired": False,
"eventTypeChannels":[
{
"eventTypeChannelId": "be07c7bb-714b-4637-acf5-a67025ad8e60",
"channel":{
"channelId": 1,
"name": "push"
},
"isDefault": True,
"isMandatory": False
},
{
"eventTypeChannelId": "0c797b5a-ed34-494b-8c64-0a832830d392",
"channel":{
"channelId": 2,
"name": "email"
},
"isDefault": False,
"isMandatory": False
}
]
},
{
"eventTypeId": 5,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, PAD",
"subName": null,
"prettyName": "Profielgegevens op de pas",
"optinRequired": False,
"eventTypeChannels":[
{
"eventTypeChannelId": "b910368f-c045-4e8e-b01d-bcbc78708bac",
"channel":{
"channelId": 1,
"name": "push"
},
"isDefault": True,
"isMandatory": False
},
{
"eventTypeChannelId": "93e773da-ba3b-48da-9a0e-ee478eaa752f",
"channel":{
"channelId": 2,
"name": "email"
},
"isDefault": False,
"isMandatory": False
}
]
}
]
}
]
}
getNotifactionCategories?expand=eventType:
summary: Return all the notification categories with nested eventTypes
value:
{
"notificationCategories":[
{
"notificationCategoryId": 1,
"name": "Nieuwsbrief",
"eventTypes": [
{
"eventTypeId": 1,
"eventOrigin": {
"eventOriginId": 6,
"name": "Maileon"
},
"name": "HTM nieuwsbrief",
"subName": "",
"prettyName": "HTM nieuwsbrief",
"optinRequired": False
}
]
},
{
"notificationCategoryId": 2,
"name": "Mijn Reizen",
"eventTypes": [
{
"eventTypeId": 2,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, TRAVEL_SCHEME",
"subName": "CI",
"prettyName": "Check In",
"optinRequired": False
},
{
"eventTypeId": 3,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, PAD",
"subName": null,
"prettyName": "Profielgegevens op de pas",
"optinRequired": False
}
]
},
{
"notificationCategoryId": 3,
"name": "Mijn Passen",
"eventTypes": [
{
"eventTypeId": 4,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, CARD",
"subName": null,
"prettyName": "Mijn passen",
"optinRequired": False
},
{
"eventTypeId": 5,
"eventOrigin": {
"eventOriginId": 1,
"name": "GBO"
},
"name": "ALERTS, PAD",
"subName": null,
"prettyName": "Profielgegevens op de pas",
"optinRequired": False
}
]
}
]
}
getNotifactionCategories?expand=none: getNotifactionCategories?expand=none:
summary: Return all the notification categories summary: Return all the notification categories without nested attributes (expand=none)
value: value:
{ notificationCategories:
"notificationCategories":[ - notificationCategoryId: 1
{ name: Mijn Reizen
"notificationCategoryId": 1, - notificationCategoryId: 2
"name": "Nieuwsbrief" name: Nieuwsbrief aanmelding
}, - notificationCategoryId: 3
{ name: Mijn Passen
"notificationCategoryId": 2, getNotifactionCategories?expand=eventType:
"name": "Mijn Reizen" summary: Return all the notification categories with nested event types (expand=eventType)
}, value:
{ notificationCategories:
"notificationCategoryId": 3, - notificationCategoryId: 1
"name": "Mijn Passen" name: Mijn Reizen
} eventTypes:
] - eventTypeId: 2
} eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, TRAVEL_SCHEME
subName: CI
prettyName: Check In
optinRequired: false
- eventTypeId: 3
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, PAD
subName: null
prettyName: Profielgegevens op de pas
optinRequired: false
- notificationCategoryId: 2
name: Nieuwsbrief aanmelding
eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: newsletter
subName: null
prettyName: HTM nieuwsbrief
optinRequired: false
- notificationCategoryId: 3
name: Mijn Passen
eventTypes:
- eventTypeId: 4
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, CARD
subName: null
prettyName: Mijn passen
optinRequired: false
- eventTypeId: 5
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, PAD
subName: null
prettyName: Profielgegevens op de pas
optinRequired: false
getNotifactionCategories?expand=eventTypeChannel:
summary: Return all the notification categories with all nested attributes (expand=eventTypeChannel)
value:
notificationCategories:
- notificationCategoryId: 1
name: Mijn Reizen
eventTypes:
- eventTypeId: 2
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, TRAVEL_SCHEME
subName: CI
prettyName: Check In
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: ccc8c025-06b5-4928-a632-23e1c55cd173
channel:
channelId: 1
name: push
isDefault: true
isMandatory: false
- eventTypeChannelId: da2deb4c-ce77-4b5f-aecc-ddebfd14349d
channel:
channelId: 2
name: email
isDefault: false
isMandatory: false
- eventTypeId: 3
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, PAD
subName: null
prettyName: Profielgegevens op de pas
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: 8e7df8f1-7e50-482f-8301-d399e75fd432
channel:
channelId: 1
name: push
isDefault: true
isMandatory: false
- eventTypeChannelId: 72960a92-1855-469f-9cfd-5d72f57106f2
channel:
channelId: 2
name: email
isDefault: false
isMandatory: false
- notificationCategoryId: 2
name: Nieuwsbrief aanmelding
eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: newsletter
subName: null
prettyName: HTM nieuwsbrief
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: 447a1116-6cd7-4645-8c3d-43237b6186cd
channel:
channelId: 2
name: email
isDefault: true
isMandatory: false
- notificationCategoryId: 3
name: Mijn Passen
eventTypes:
- eventTypeId: 4
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, CARD
subName: null
prettyName: Mijn passen
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: be07c7bb-714b-4637-acf5-a67025ad8e60
channel:
channelId: 1
name: push
isDefault: true
isMandatory: false
- eventTypeChannelId: 0c797b5a-ed34-494b-8c64-0a832830d392
channel:
channelId: 2
name: email
isDefault: false
isMandatory: false
- eventTypeId: 5
eventOrigin:
eventOriginId: 1
name: GBO
name: ALERTS, PAD
subName: null
prettyName: Profielgegevens op de pas
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: b910368f-c045-4e8e-b01d-bcbc78708bac
channel:
channelId: 1
name: push
isDefault: true
isMandatory: false
- eventTypeChannelId: 93e773da-ba3b-48da-9a0e-ee478eaa752f
channel:
channelId: 2
name: email
isDefault: false
isMandatory: false
"404": "404":
description: No notification category found description: No notification category found
content: content:
application/json: application/json:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"title": "Niet gevonden", "title": "Niet gevonden",
"detail": "Notificatiecategorie niet gevonden", "detail": "Notificatiecategorie niet gevonden",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [ "errors":
{ [
"code": "404", {
"detail": null, "code": "404",
"path": null, "detail": null,
"parameter": null "path": null,
} "parameter": null,
], },
],
} }
/notificationsubscriptions: /notificationsubscriptions:
get: get:
tags: tags:
- Notification subscriptions - Notification subscriptions
summary: Get all possible notificationSubscriptions for a customer (account or private). summary: Get all possible notificationSubscriptions for a customer (account or private).
description: | description: |
Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it. Get all possible notificationSubscriptions for a customer (account or private), including if they have opted-in for it.
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: X-HTM-JWT-AUTH-HEADER
in: header in: header
@ -359,68 +265,75 @@ paths:
in: query in: query
schema: schema:
type: integer type: integer
example: john.doe@mymailprovider.com example: john.doe@mymailprovider.com
required: false required: false
description: The emailadress of the customer in the case of anonymous opt-ins description: The emailadress of the customer in the case of anonymous opt-ins
responses: responses:
"200": "200":
description: OK description: OK
content: content:
application/json: application/json:
examples: examples:
getNotifactionSubscriptionsAll: getNotifactionSubscriptionsAll:
summary: Return all the notification subscriptions where for each category the client has actively opted in or out - All summary: Return all the notification subscriptions where for each category the client has actively opted in or out - All
value: value:
{ {
"notificationSubscriptions":[ "notificationSubscriptions":
{ [
"notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903", {
"notificationCategory": { "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903",
"notificationCategoryId": 1, "notificationCategory":
"name": "HTM nieuwbrief" {
"notificationCategoryId": 1,
"name": "Mijn reizen",
},
"isActive": true,
}, },
"isActive": true {
}, "notificationSubscriptionId": "571388cd-8903-40d5-89e6-9191cb8d656e",
{ "notificationCategory":
"notificationSubscriptionId": "571388cd-8903-40d5-89e6-9191cb8d656e", {
"notificationCategory": { "notificationCategoryId": 2,
"notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding",
"name": "Mijn reizen" },
"isActive": true,
}, },
"isActive": true {
}, "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b",
{ "notificationCategory":
"notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b", {
"notificationCategory": { "notificationCategoryId": 3,
"notificationCategoryId": 3, "name": "Mijn contracten",
"name": "Mijn contracten" },
"isActive": false,
}, },
"isActive": false ],
}
]
} }
getNotifactionSubscriptionsSome: getNotifactionSubscriptionsSome:
summary: Return all the notification subscriptions where for each category the client has actively opted in or out - Some summary: Return all the notification subscriptions where for each category the client has actively opted in or out - Some
value: value:
{ {
"notificationSubscriptions": [ "notificationSubscriptions":
{ [
"notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903", {
"notificationCategory": { "notificationSubscriptionId": "64047471-e0c3-4abc-b4eb-83a12a6de903",
"notificationCategoryId": 1, "notificationCategory":
"name": "HTM nieuwbrief" {
"notificationCategoryId": 1,
"name": "Mijn reizen",
},
"isActive": true,
}, },
"isActive": true {
}, "notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b",
{ "notificationCategory":
"notificationSubscriptionId": "cf736ff2-2f8f-434e-a3c7-a14064b73c9b", {
"notificationCategory": { "notificationCategoryId": 2,
"notificationCategoryId": 3, "name": "Nieuwsbrief aanmelding",
"name": "Mijn contracten" },
"isActive": false,
}, },
"isActive": false ],
}
]
} }
"403": "403":
description: Forbidden // Als geverifieerd profiel gevonden wordt, maar niet op een geverifieerde manier benaderd wordt description: Forbidden // Als geverifieerd profiel gevonden wordt, maar niet op een geverifieerde manier benaderd wordt
@ -428,18 +341,19 @@ paths:
application/json: application/json:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"title": "Verboden", "title": "Verboden",
"detail": "Niet toegestaan", "detail": "Niet toegestaan",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [ "errors":
{ [
"code": "403", {
"detail": null, "code": "403",
"path": null, "detail": null,
"parameter": null "path": null,
} "parameter": null,
], },
],
} }
"404": "404":
description: No notification subscriptions found description: No notification subscriptions found
@ -447,25 +361,26 @@ paths:
application/json: application/json:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"title": "Niet gevonden", "title": "Niet gevonden",
"detail": "Notificatie niet gevonden", "detail": "Notificatie niet gevonden",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [ "errors":
{ [
"code": "404", {
"detail": null, "code": "404",
"path": null, "detail": null,
"parameter": null "path": null,
} "parameter": null,
], },
],
} }
post: post:
tags: tags:
- Notification subscriptions - Notification subscriptions
summary: Create a new notificationSubscription for a customer (account or private). summary: Create a new notificationSubscription for a customer (account or private).
description: | description: |
Create a notificationSubscriptions for a customer (account or private), including if they have opted-in for it. Create a notificationSubscriptions for a customer (account or private), including if they have opted-in for it.
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: X-HTM-JWT-AUTH-HEADER
in: header in: header
@ -499,103 +414,94 @@ paths:
{ {
"emailAddress": "anonymous@mymailprovider.com", "emailAddress": "anonymous@mymailprovider.com",
"notificationCategoryId": 1, "notificationCategoryId": 1,
"isActive": True "isActive": True,
} }
Create notificationSubscription anonymous inactive: Create notificationSubscription anonymous inactive:
value: value:
{ {
"emailAddress": "anonymous@mymailprovider.com", "emailAddress": "anonymous@mymailprovider.com",
"notificationCategoryId": 1, "notificationCategoryId": 1,
"isActive": False "isActive": False,
} }
Create notificationSubscription account active: Create notificationSubscription account active:
value: value: { "notificationCategoryId": 2, "isActive": True }
{
"notificationCategoryId": 2,
"isActive": True
}
Create notificationSubscription account inactive: Create notificationSubscription account inactive:
value: value: { "notificationCategoryId": 2, "isActive": False }
{
"notificationCategoryId": 2,
"isActive": False
}
responses: responses:
"201": "201":
description: Created description: Created
content: content:
application/json: application/json:
examples: examples:
Create notificationSubscription anonymous active: Create notificationSubscription anonymous active:
summary: Return the created notification for an anonymous user active summary: Return the created notification for an anonymous user active
value: value:
{ {
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae", "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
"notificationCategory": { "notificationCategory":
"notificationCategoryId": 1, {
"name": "HTM nieuwbrief" "notificationCategoryId": 2,
}, "name": "Nieuwsbrief aanmelding",
"isActive": True },
} "isActive": True,
}
Create notificationSubscription anonymous inactive: Create notificationSubscription anonymous inactive:
summary: Return the created notification for an anonymous user inactive summary: Return the created notification for an anonymous user inactive
value: value:
{ {
"notificationSubscriptionId": "d51081fd-c48d-4111-8de4-ac5db7d47ecb", "notificationSubscriptionId": "d51081fd-c48d-4111-8de4-ac5db7d47ecb",
"notificationCategory": { "notificationCategory":
"notificationCategoryId": 1, {
"name": "HTM nieuwbrief" "notificationCategoryId": 2,
}, "name": "Nieuwsbrief aanmelding",
"isActive": False },
} "isActive": False,
}
Create notificationSubscription account active: Create notificationSubscription account active:
summary: Return the created notification for an anonymous user active summary: Return the created notification for an anonymous user active
value: value:
{ {
"notificationSubscriptionId": "6b88eba1-af1f-42fc-82d3-d7202d5f1afe", "notificationSubscriptionId": "6b88eba1-af1f-42fc-82d3-d7202d5f1afe",
"notificationCategory": { "notificationCategory":
"notificationCategoryId": 2, { "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
"name": "Mijn reizen" "isActive": True,
}, }
"isActive": True
}
Create notificationSubscription account inactive: Create notificationSubscription account inactive:
summary: Return the created notification for an anonymous user inactive summary: Return the created notification for an anonymous user inactive
value: value:
{ {
"notificationSubscriptionId": "0dfc0ac9-c221-4493-8828-9dfa79ad9061", "notificationSubscriptionId": "0dfc0ac9-c221-4493-8828-9dfa79ad9061",
"notificationCategory": { "notificationCategory":
"notificationCategoryId": 2, { "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
"name": "Mijn reizen" "isActive": False,
},
"isActive": False
} }
"405": "405":
description: Method not allowed, ook als een notificatie aangemaakt wordt voor een account maar op een anonieme manier benadert wordt. description: Method not allowed, ook als een notificatie aangemaakt wordt voor een account maar op een anonieme manier benadert wordt.
content: content:
application/json: application/json:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"title": "Methode niet toegestaan", "title": "Methode niet toegestaan",
"detail": "", "detail": "",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [ "errors":
{ [
"code": "405", {
"detail": null, "code": "405",
"path": null, "detail": null,
"parameter": null "path": null,
} "parameter": null,
], },
],
} }
/notificationsubscriptions/{notificationSubscriptionId}: /notificationsubscriptions/{notificationSubscriptionId}:
patch: patch:
tags: tags:
- Notification subscriptions - Notification subscriptions
summary: Update a notificationSubscription for a customer (account or private). summary: Update a notificationSubscription for a customer (account or private).
description: | description: |
Update a notificationSubscription for a customer (account or private). Update a notificationSubscription for a customer (account or private).
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: X-HTM-JWT-AUTH-HEADER
in: header in: header
@ -631,9 +537,9 @@ paths:
schema: schema:
type: string type: string
format: email format: email
example: john.doe@mymailprovider.com example: john.doe@mymailprovider.com
required: false required: false
description: The emailadress of the customer in the case of anonymous opt-ins description: The emailadress of the customer in the case of anonymous opt-ins
requestBody: requestBody:
content: content:
application/json: application/json:
@ -641,43 +547,39 @@ paths:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
Update a notificationSubscription to inactive: Update a notificationSubscription to inactive:
value: value: { "isActive": False }
{
"isActive": False
}
Update a notificationSubscription to active: Update a notificationSubscription to active:
value: value: { "isActive": True }
{
"isActive": True
}
responses: responses:
"200": "200":
description: OK description: OK
content: content:
application/json: application/json:
examples: examples:
Update a notificationSubscription to inactive: Update a notificationSubscription to inactive:
summary: Return the updated inactive notification summary: Return the updated inactive notification
value: value:
{ {
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae", "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
"notificationCategory": { "notificationCategory":
"notificationCategoryId": 1, {
"name": "HTM nieuwbrief" "notificationCategoryId": 2,
}, "name": "Nieuwsbrief aanmelding",
"isActive": False },
} "isActive": False,
}
Update a notificationSubscription to active: Update a notificationSubscription to active:
summary: Return the updated active notification summary: Return the updated active notification
value: value:
{ {
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae", "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
"notificationCategory": { "notificationCategory":
"notificationCategoryId": 1, {
"name": "HTM nieuwbrief" "notificationCategoryId": 2,
}, "name": "Nieuwsbrief aanmelding",
"isActive": True },
} "isActive": True,
}
components: components:
schemas: schemas:
unavailable: unavailable:

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

@ -76,7 +76,7 @@ paths:
- notificationSubscriptionId: 39e8d8e6-5c85-49b6-ba4b-62e47fa4f7fd - notificationSubscriptionId: 39e8d8e6-5c85-49b6-ba4b-62e47fa4f7fd
notificationCategory: notificationCategory:
notificationCategoryId: 2 notificationCategoryId: 2
name: Mijn Passen name: Nieuwsbrief aanmelding
customerProfileId: 1338 customerProfileId: 1338
subscriptionActivities: subscriptionActivities:
- subscriptionActivityId: 7fae0d2c-1e20-4f3e-b25d-fd8505a381c4 - subscriptionActivityId: 7fae0d2c-1e20-4f3e-b25d-fd8505a381c4
@ -308,9 +308,9 @@ paths:
value: value:
notificationCategories: notificationCategories:
- notificationCategoryId: 1 - notificationCategoryId: 1
name: Nieuwsbrief
- notificationCategoryId: 2
name: Mijn Reizen name: Mijn Reizen
- notificationCategoryId: 2
name: Nieuwsbrief aanmelding
- notificationCategoryId: 3 - notificationCategoryId: 3
name: Mijn Passen name: Mijn Passen
getNotifactionCategories?expand=eventType: getNotifactionCategories?expand=eventType:
@ -318,17 +318,6 @@ paths:
value: value:
notificationCategories: notificationCategories:
- notificationCategoryId: 1 - notificationCategoryId: 1
name: Nieuwsbrief
eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: HTM nieuwsbrief
subName: ""
prettyName: HTM nieuwsbrief
optinRequired: false
- notificationCategoryId: 2
name: Mijn Reizen name: Mijn Reizen
eventTypes: eventTypes:
- eventTypeId: 2 - eventTypeId: 2
@ -347,6 +336,17 @@ paths:
subName: null subName: null
prettyName: Profielgegevens op de pas prettyName: Profielgegevens op de pas
optinRequired: false optinRequired: false
- notificationCategoryId: 2
name: Nieuwsbrief aanmelding
eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: newsletter
subName: null
prettyName: HTM nieuwsbrief
optinRequired: false
- notificationCategoryId: 3 - notificationCategoryId: 3
name: Mijn Passen name: Mijn Passen
eventTypes: eventTypes:
@ -371,24 +371,6 @@ paths:
value: value:
notificationCategories: notificationCategories:
- notificationCategoryId: 1 - notificationCategoryId: 1
name: Nieuwsbrief
eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: HTM nieuwsbrief
subName: ""
prettyName: HTM nieuwsbrief
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: 447a1116-6cd7-4645-8c3d-43237b6186cd
channel:
channelId: 2
name: email
isDefault: true
isMandatory: false
- notificationCategoryId: 2
name: Mijn Reizen name: Mijn Reizen
eventTypes: eventTypes:
- eventTypeId: 2 - eventTypeId: 2
@ -433,6 +415,24 @@ paths:
name: email name: email
isDefault: false isDefault: false
isMandatory: false isMandatory: false
- notificationCategoryId: 2
name: Nieuwsbrief aanmelding
eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: newsletter
subName: null
prettyName: HTM nieuwsbrief
optinRequired: false
eventTypeChannels:
- eventTypeChannelId: 447a1116-6cd7-4645-8c3d-43237b6186cd
channel:
channelId: 2
name: email
isDefault: true
isMandatory: false
- notificationCategoryId: 3 - notificationCategoryId: 3
name: Mijn Passen name: Mijn Passen
eventTypes: eventTypes:
@ -532,19 +532,16 @@ paths:
eventOrigins: eventOrigins:
- eventOriginId: 1 - eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
- eventOriginId: 2 - eventOriginId: 2
name: Website name: Website
description: Events originated at the website
- eventOriginId: 3 - eventOriginId: 3
name: Payt name: Payt
description: Events originated at Payt
- eventOriginId: 4 - eventOriginId: 4
name: Twikey name: Twikey
description: Events originated at Twikey
- eventOriginId: 5 - eventOriginId: 5
name: TapConnect name: TapConnect
description: Events originated at TapConnect - eventOriginId: 6
name: Maileon
"400": "400":
description: Bad request description: Bad request
content: content:
@ -657,11 +654,18 @@ paths:
eventTypesResponse: eventTypesResponse:
value: value:
eventTypes: eventTypes:
- eventTypeId: 1
eventOrigin:
eventOriginId: 6
name: Maileon
name: newsletter
subname: null
prettyName: HTM nieuwsbrief
optInRequired: false
- eventTypeId: 15 - eventTypeId: 15
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
name: Travel name: Travel
subname: Missing CKO subname: Missing CKO
prettyName: Checkout gemist prettyName: Checkout gemist
@ -670,7 +674,6 @@ paths:
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
name: Travel name: Travel
subname: Missing CKI subname: Missing CKI
prettyName: Checkin gemist prettyName: Checkin gemist
@ -679,7 +682,6 @@ paths:
eventOrigin: eventOrigin:
eventOriginId: 3 eventOriginId: 3
name: Payt name: Payt
description: Events originated at Payt
name: Payment name: Payment
subname: Failed Payment subname: Failed Payment
prettyName: Betaling mislukt prettyName: Betaling mislukt
@ -741,7 +743,6 @@ paths:
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
name: Travel name: Travel
subname: Missing CKO subname: Missing CKO
prettyName: Checkout gemist prettyName: Checkout gemist
@ -754,7 +755,6 @@ paths:
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
name: Travel name: Travel
subname: Missing CKI subname: Missing CKI
prettyName: Checkin gemist prettyName: Checkin gemist
@ -820,7 +820,6 @@ paths:
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
name: Travel name: Travel
subname: Missing CKO subname: Missing CKO
prettyName: Checkout gemist prettyName: Checkout gemist
@ -836,7 +835,6 @@ paths:
eventOrigin: eventOrigin:
eventOriginId: 1 eventOriginId: 1
name: GBO name: GBO
description: Events originated at GBO
name: Travel name: Travel
subname: Missing CKI subname: Missing CKI
prettyName: Checkin gemist prettyName: Checkin gemist
@ -1097,9 +1095,6 @@ components:
name: name:
type: string type: string
example: GBO example: GBO
description:
type: string
example: Events originated at GBO
required: required:
- eventOriginId - eventOriginId
- name - name