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

Merge pull request 'features/Edit-TP-notification' (#44) from features/Edit-TP-notification into develop

Browse Source 
Reviewed-on: #44
This commit is contained in:
Mirjam Herald 2025-12-11 13:51:28 +00:00
commit 3e1f23afe3
1 changed files with 27 additions and 46 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -410,47 +410,25 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
Create notificationSubscription anonymous active: Create notificationSubscription anonymous:
value: value:
{ {
"emailAddress": "anonymous@mymailprovider.com", "emailAddress": "anonymous@mymailprovider.com",
"notificationCategoryId": 1, "notificationCategoryId": 1
"isActive": True,
}
Create notificationSubscription anonymous inactive:
value:
{
"emailAddress": "anonymous@mymailprovider.com",
"notificationCategoryId": 1,
"isActive": False,
} }
Create notificationSubscription account active: Create notificationSubscription account active:
value: { "notificationCategoryId": 2, "isActive": True } value: { "notificationCategoryId": 2 }
Create notificationSubscription account inactive:
value: { "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:
summary: Return the created notification for an anonymous user active summary: Return the created notification for an anonymous user inactive by default.
value: value:
{ {
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae", "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
"notificationCategory":
{
"notificationCategoryId": 2,
"name": "Nieuwsbrief aanmelding",
},
"isActive": True,
}
Create notificationSubscription anonymous inactive:
summary: Return the created notification for an anonymous user inactive
value:
{
"notificationSubscriptionId": "d51081fd-c48d-4111-8de4-ac5db7d47ecb",
"notificationCategory": "notificationCategory":
{ {
"notificationCategoryId": 2, "notificationCategoryId": 2,
@ -467,15 +445,6 @@ paths:
{ "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" }, { "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
"isActive": True, "isActive": True,
} }
Create notificationSubscription account inactive:
summary: Return the created notification for an anonymous user inactive
value:
{
"notificationSubscriptionId": "0dfc0ac9-c221-4493-8828-9dfa79ad9061",
"notificationCategory":
{ "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
"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:
@ -500,9 +469,9 @@ paths:
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.
description: | description: |
Update a notificationSubscription for a customer (account or private). Update a notificationSubscription for a customer.
parameters: parameters:
- name: X-HTM-JWT-AUTH-HEADER - name: X-HTM-JWT-AUTH-HEADER
in: header in: header
@ -533,14 +502,6 @@ paths:
example: e112f26e-37fa-4bde-8def-9977cd1d50ae example: e112f26e-37fa-4bde-8def-9977cd1d50ae
required: true required: true
description: The id of the notificationSubscription you want to update description: The id of the notificationSubscription you want to update
- name: emailAddress
in: query
schema:
type: string
format: email
example: john.doe@mymailprovider.com
required: false
description: The emailadress of the customer in the case of anonymous opt-ins
requestBody: requestBody:
content: content:
application/json: application/json:
@ -581,6 +542,26 @@ paths:
}, },
"isActive": True, "isActive": True,
} }
"405":
description: Method not allowed,wanneer het account emailadres niet geverifieerd is.
content:
application/json:
example:
{
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"title": "Methode niet toegestaan",
"detail": "",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors":
[
{
"code": "405",
"detail": null,
"path": null,
"parameter": null,
},
],
}
components: components:
schemas: schemas:
unavailable: unavailable: