develop #38

Merged
bboterm merged 451 commits from develop into main 2025-11-19 14:28:14 +00:00
2 changed files with 91 additions and 52 deletions
Showing only changes of commit b5131629a9 - Show all commits

View File

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

View File

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