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

review comments

Browse Source
This commit is contained in:
Mirjam Herald 2025-11-05 15:28:30 +01:00
parent 3d42458d12
commit b5131629a9
2 changed files with 91 additions and 52 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -28,17 +28,16 @@ paths:
- name: expand - name: expand
in: query in: query
schema: schema:
type: array
items:
type: string type: string
description: Choose the records related to the category nested, options are eventType, evenTypeChannel enum: [none, eventType, eventTypeChannel]
default: none
responses: responses:
"200": "200":
description: OK description: OK
content: content:
application/json: application/json:
examples: examples:
getNotifactionCategories?Expand=eventType, evenTypeChannel, channel: getNotifactionCategories?expand=eventTypeChannel:
summary: Return all the notification categories with their nested attributes summary: Return all the notification categories with their nested attributes
value: value:
{ {
@ -209,7 +208,7 @@ paths:
} }
] ]
} }
getNotifactionCategories?Expand=eventType: getNotifactionCategories?expand=eventType:
summary: Return all the notification categories with nested eventTypes summary: Return all the notification categories with nested eventTypes
value: value:
{ {
@ -289,7 +288,7 @@ paths:
} }
] ]
} }
getNotifactionCategories: getNotifactionCategories?expand=none:
summary: Return all the notification categories summary: Return all the notification categories
value: value:
{ {
@ -313,13 +312,19 @@ paths:
content: content:
application/json: application/json:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"apiErrorCode": "400.1",
"title": "Niet gevonden", "title": "Niet gevonden",
"detail": "Notificatiecategorie niet gevonden", "detail": "Notificatiecategory niet gevonden",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [{ "subApiErrorCode": "0017" }], "errors": [
{
"code": "404",
"detail": null,
"path": null,
"parameter": null
}
],
} }
/notificationsubscriptions: /notificationsubscriptions:
get: get:
@ -353,8 +358,7 @@ paths:
- name: emailAddress - name: emailAddress
in: query in: query
schema: schema:
type: string type: integer
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
@ -425,11 +429,17 @@ paths:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"apiErrorCode": "403",
"title": "Verboden", "title": "Verboden",
"detail": "", "detail": "Niet toegestaan",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [], "errors": [
{
"code": "403",
"detail": null,
"path": null,
"parameter": null
}
],
} }
"404": "404":
description: No notification subscriptions found description: No notification subscriptions found
@ -438,11 +448,17 @@ paths:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"apiErrorCode": "404",
"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": [{ "subApiErrorCode": "0017" }], "errors": [
{
"code": "404",
"detail": null,
"path": null,
"parameter": null
}
],
} }
post: post:
tags: tags:
@ -555,17 +571,23 @@ paths:
"isActive": False "isActive": False
} }
"405": "405":
description: Method not allowed 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",
"apiErrorCode": "405", "title": "Methode niet toegestaan",
"title": "Methode ", "detail": "",
"detail": "Notificatie niet gevonden",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [{ "subApiErrorCode": "0017" }], "errors": [
{
"code": "405",
"detail": null,
"path": null,
"parameter": null
}
],
} }
/notificationsubscriptions/{notificationSubscriptionId}: /notificationsubscriptions/{notificationSubscriptionId}:
patch: patch:
@ -635,7 +657,7 @@ paths:
application/json: application/json:
examples: examples:
Update a notificationSubscription to inactive: Update a notificationSubscription to inactive:
summary: Return the updated notification summary: Return the updated inactive notification
value: value:
{ {
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae", "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",
@ -646,7 +668,7 @@ paths:
"isActive": False "isActive": False
} }
Update a notificationSubscription to active: Update a notificationSubscription to active:
summary: Return the updated notification summary: Return the updated active notification
value: value:
{ {
"notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae", "notificationSubscriptionId": "e112f26e-37fa-4bde-8def-9977cd1d50ae",

61
src/openapi/customers/se-maileon.yaml
View File

@ -38,7 +38,7 @@ paths:
required: true required: true
description: The emailadress of the customer description: The emailadress of the customer
summary: Update a customer profile summary: Update a customer profile
description: Update a customer profile based on the customerProfileId description: Update a customer profile based on the customerProfileId and emailAddress
requestBody: requestBody:
content: content:
application/json: application/json:
@ -53,7 +53,7 @@ paths:
} }
} }
responses: responses:
"200": "202":
description: OK description: OK
/notificationcategories: /notificationcategories:
get: get:
@ -66,17 +66,16 @@ paths:
- name: expand - name: expand
in: query in: query
schema: schema:
type: array
items:
type: string type: string
description: Choose the records related to the category nested, options are eventType, evenTypeChannel enum: [none, eventType, eventTypeChannel]
default: none
responses: responses:
"200": "200":
description: OK description: OK
content: content:
application/json: application/json:
examples: examples:
getNotifactionCategories?Expand=eventType, evenTypeChannel, channel: getNotifactionCategories?expand=evenTypeChannel:
summary: Return all the notification categories with their nested attributes summary: Return all the notification categories with their nested attributes
value: value:
{ {
@ -247,7 +246,7 @@ paths:
} }
] ]
} }
getNotifactionCategories?Expand=eventType: getNotifactionCategories?expand=eventType:
summary: Return all the notification categories with nested eventTypes summary: Return all the notification categories with nested eventTypes
value: value:
{ {
@ -327,7 +326,7 @@ paths:
} }
] ]
} }
getNotifactionCategories: getNotifactionCategories?expand=none:
summary: Return all the notification categories summary: Return all the notification categories
value: value:
{ {
@ -352,12 +351,18 @@ paths:
application/json: application/json:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/1.0/customers", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"apiErrorCode": "400.1",
"title": "Niet gevonden", "title": "Niet gevonden",
"detail": "Notificatiecategorie niet gevonden", "detail": "Notificatiecategory niet gevonden",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [{ "subApiErrorCode": "0017" }], "errors": [
{
"code": "404",
"detail": null,
"path": null,
"parameter": null
}
],
} }
/notificationsubscriptions: /notificationsubscriptions:
get: get:
@ -370,9 +375,9 @@ paths:
- name: customerProfileId - name: customerProfileId
in: header in: header
schema: schema:
type: string type: integer
example: feaaef83-a551-4283-8419-340b1ada3b55 example: 12361
required: false required: true
description: The customerProfileId of a customer description: The customerProfileId of a customer
responses: responses:
"200": "200":
@ -426,24 +431,36 @@ paths:
example: example:
{ {
"type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications", "type": "https://api.integratielaag.nl/abt/touchpoint/2.0/notifications",
"apiErrorCode": "403",
"title": "Verboden", "title": "Verboden",
"detail": "", "detail": "Niet toegestaan",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [], "errors": [
{
"code": "403",
"detail": null,
"path": null,
"parameter": null
}
],
} }
"404": "404":
description: No notification subscriptions found description: No notification subscriptions 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",
"apiErrorCode": "404",
"title": "Niet gevonden", "title": "Niet gevonden",
"detail": "Notificatie niet gevonden", "detail": "Notificaties niet gevonden",
"instance": "555d00b5-bc3f-4591-949b-479e76d49ea7", "instance": "555d00b5-bc3f-4591-949b-479e76d49ea7",
"errors": [{ "subApiErrorCode": "0017" }], "errors": [
{
"code": "404",
"detail": null,
"path": null,
"parameter": null
}
],
} }
components: components:
schemas: schemas: