Compare commits
2
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5672c93715 | ||
|
|
b4f2d378a2 |
No files matched your search
@@ -264,8 +264,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
|
||||
@@ -410,25 +409,47 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
examples:
|
||||
Create notificationSubscription anonymous:
|
||||
Create notificationSubscription anonymous active:
|
||||
value:
|
||||
{
|
||||
"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:
|
||||
value: { "notificationCategoryId": 2 }
|
||||
value: { "notificationCategoryId": 2, "isActive": True }
|
||||
Create notificationSubscription account inactive:
|
||||
value: { "notificationCategoryId": 2, "isActive": False }
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
examples:
|
||||
Create notificationSubscription anonymous:
|
||||
summary: Return the created notification for an anonymous user inactive by default.
|
||||
Create notificationSubscription anonymous active:
|
||||
summary: Return the created notification for an anonymous user active
|
||||
value:
|
||||
{
|
||||
"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":
|
||||
{
|
||||
"notificationCategoryId": 2,
|
||||
@@ -445,6 +466,15 @@ paths:
|
||||
{ "notificationCategoryId": 2, "name": "Nieuwsbrief aanmelding" },
|
||||
"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":
|
||||
description: Method not allowed, ook als een notificatie aangemaakt wordt voor een account maar op een anonieme manier benadert wordt.
|
||||
content:
|
||||
@@ -469,9 +499,9 @@ paths:
|
||||
patch:
|
||||
tags:
|
||||
- Notification subscriptions
|
||||
summary: Update a notificationSubscription for a customer.
|
||||
summary: Update a notificationSubscription for a customer (account or private).
|
||||
description: |
|
||||
Update a notificationSubscription for a customer.
|
||||
Update a notificationSubscription for a customer (account or private).
|
||||
parameters:
|
||||
- name: X-HTM-JWT-AUTH-HEADER
|
||||
in: header
|
||||
@@ -502,6 +532,14 @@ paths:
|
||||
example: e112f26e-37fa-4bde-8def-9977cd1d50ae
|
||||
required: true
|
||||
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:
|
||||
content:
|
||||
application/json:
|
||||
@@ -542,26 +580,6 @@ paths:
|
||||
},
|
||||
"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:
|
||||
schemas:
|
||||
unavailable:
|
||||
|
||||
@@ -426,18 +426,21 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"code": "STARTDATE_TOO_FAR_IN_FUTURE",
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -688,18 +691,21 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"code": "STARTDATE_TOO_FAR_IN_FUTURE",
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -715,23 +721,17 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.",
|
||||
"detail": "One or more required attributes are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 2,
|
||||
},
|
||||
{
|
||||
"detail": "Combination of product and token type is not valid.",
|
||||
"pointer": "#/1/ovPayTokenId",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 3,
|
||||
"code": "REQUIRED_ATTRIBUTE_MISSING",
|
||||
"detail": "One ore more required attributes are missing.",
|
||||
"pointer": "$.orderLines[0].productId",
|
||||
"parameter": null,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -926,18 +926,21 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"code": "STARTDATE_TOO_FAR_IN_FUTURE",
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -1118,18 +1121,21 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"code": "STARTDATE_TOO_FAR_IN_FUTURE",
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -1248,8 +1254,7 @@ paths:
|
||||
},
|
||||
],
|
||||
"validationResult": null,
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments":
|
||||
@@ -1528,18 +1533,21 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"code": "STARTDATE_TOO_FAR_IN_FUTURE",
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -1555,23 +1563,17 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.",
|
||||
"detail": "One or more required attributes are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 2,
|
||||
},
|
||||
{
|
||||
"detail": "Combination of product and token type is not valid.",
|
||||
"pointer": "#/1/ovPayTokenId",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 3,
|
||||
"code": "REQUIRED_ATTRIBUTE_MISSING",
|
||||
"detail": "One ore more required attributes are missing.",
|
||||
"pointer": "$.orderLines[0].productId",
|
||||
"parameter": null,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -1591,7 +1593,7 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The order can not be deleted.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
@@ -1834,14 +1836,16 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "PRODUCT_CHOICE_REQUIRED",
|
||||
"parameter": "orderline.productId",
|
||||
"detail": "The chosen product is not a leaf node product. Please choose one of its child products.",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].productId",
|
||||
"parameter": null,
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -2008,22 +2012,30 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "PERSONALACCOUNTDATA_BIRTHDATE_REQUIRED",
|
||||
"parameter": "personalaccountdata.birthdate",
|
||||
"detail": "Personal account data birthdate is required for this product.",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].customerTokens[0].personalAccountData.birthdate",
|
||||
"parameter": null,
|
||||
"type": "REMARK",
|
||||
},
|
||||
{
|
||||
"code": "TOKEN_REQUIRED",
|
||||
"detail": "A valid customer token is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "customerToken",
|
||||
"type": "REMARK",
|
||||
},
|
||||
{
|
||||
"code": "VALIDFROM_REQUIRED",
|
||||
"parameter": "orderline.validFrom",
|
||||
"detail": "A valid 'valid from' date is required for this product.",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -2037,23 +2049,17 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.",
|
||||
"detail": "One or more required attributes are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 2,
|
||||
},
|
||||
{
|
||||
"detail": "Combination of product and token type is not valid.",
|
||||
"pointer": "#/1/ovPayTokenId",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 3,
|
||||
"code": "REQUIRED_ATTRIBUTE_MISSING",
|
||||
"detail": "One ore more required attributes are missing.",
|
||||
"pointer": "$.orderLines[0].productId",
|
||||
"parameter": null,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -2176,18 +2182,23 @@ paths:
|
||||
"customerTokens": [],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
{
|
||||
"code": "CUSTOMERTOKEN_REQUIRED",
|
||||
"detail": "A valid customer token is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "customerTokenId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -2201,17 +2212,17 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The start date of the product is not allowed. See errors for more details.",
|
||||
"detail": "One or more required attributes are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"ovPayTokenId": 123,
|
||||
"productId": 2,
|
||||
"code": "REQUIRED_ATTRIBUTE_MISSING",
|
||||
"detail": "One ore more required attributes are missing.",
|
||||
"pointer": "$.orderLines[0].productId",
|
||||
"parameter": null,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -2275,17 +2286,17 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.",
|
||||
"detail": "One or more required attributes are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"detail": "Product requires product with productId=2",
|
||||
"pointer": "#/1/orderLine",
|
||||
"orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d",
|
||||
"productId": 3,
|
||||
"code": "REQUIRED_ATTRIBUTE_MISSING",
|
||||
"detail": "One ore more required attributes are missing.",
|
||||
"pointer": "$.orderLines[0].productId",
|
||||
"parameter": null,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -2506,14 +2517,16 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "PERSONALACCOUNTDATA_BIRTHDATE_REQUIRED",
|
||||
"parameter": "personalaccountdata.birthdate",
|
||||
"detail": "Personal account data birthdate is required for this product.",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].customerTokens[0].personalAccountData.birthdate",
|
||||
"parameter": null,
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -2721,8 +2734,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -2810,14 +2822,16 @@ paths:
|
||||
"customerTokens": [],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "CUSTOMERTOKEN_REQUIRED",
|
||||
"detail": "A valid customer token is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "customerTokenId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -3037,8 +3051,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -3251,12 +3264,14 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "PERSONAL_ACCOUNT_DATA_AGE_PROFILE_MISMATCH",
|
||||
"detail": "Product is for gboAgeProfile 19-65, given gboAgeProfile is 12-19",
|
||||
"pointer": "#/customerTokens/878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e/personalAccountData/birthdate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].customerTokens[?(@.customerTokenId=='878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e')].ovPayToken.personalAccountData.birthdate",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -3436,8 +3451,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -3596,8 +3610,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
{
|
||||
"orderLineId": "2cb04b38-e9a8-465a-a273-261c55a21b71",
|
||||
@@ -3645,8 +3658,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments":
|
||||
@@ -3883,8 +3895,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments":
|
||||
@@ -4080,18 +4091,21 @@ paths:
|
||||
},
|
||||
],
|
||||
"validationResult": "invalid",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors":
|
||||
[
|
||||
{
|
||||
"code": "STARTDATE_TOO_FAR_IN_FUTURE",
|
||||
"detail": "Startdate of this product should be at most 60 days in the future.",
|
||||
"pointer": "#/0/startDate",
|
||||
"path": "$.orders[?(@.orderId=='1e441d7d-50d6-4006-aca7-5e87e2f218df')].orderLines[?(@.orderLineId=='cccada2c-d5ea-48ab-b4be-f590e16b5468')].validFrom",
|
||||
"parameter": null,
|
||||
"type": "ERROR",
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -4415,8 +4429,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -4662,8 +4675,7 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "valid",
|
||||
"additionalRemarks": [],
|
||||
"validationErrors": [],
|
||||
"validations": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -4911,14 +4923,16 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "Direct debit mandate is required for this order.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -5166,14 +5180,16 @@ paths:
|
||||
],
|
||||
"orderAccountingStatuses": [],
|
||||
"validationResult": "preliminary",
|
||||
"additionalRemarks":
|
||||
"validations":
|
||||
[
|
||||
{
|
||||
"code": "MANDATE_REQUIRED",
|
||||
"detail": "A valid mandate is required before purchasing this product.",
|
||||
"path": null,
|
||||
"parameter": "directDebitMandateId",
|
||||
"type": "REMARK",
|
||||
},
|
||||
],
|
||||
"validationErrors": [],
|
||||
},
|
||||
],
|
||||
"payments": [],
|
||||
@@ -5286,17 +5302,17 @@ paths:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"type": "https://htm.nl/api/v1/probs/validationerror",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "The combination of tokens and/or products chosen is not valid. See errors for more details.",
|
||||
"detail": "One or more required attributes are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"detail": "Product requires product with productId=2",
|
||||
"pointer": "#/1/orderLine",
|
||||
"orderLineId": "0574440e-7fa0-401f-b907-539c91633a5d",
|
||||
"productId": 3,
|
||||
"code": "REQUIRED_ATTRIBUTE_MISSING",
|
||||
"detail": "One ore more required attributes are missing.",
|
||||
"pointer": "$.orderLines[0].productId",
|
||||
"parameter": null,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -5410,21 +5426,37 @@ paths:
|
||||
summary: Missing parameter(s)
|
||||
value:
|
||||
{
|
||||
"type": "https://www.htm.nl/api/v1/400Error",
|
||||
"title": "Missing parameter(s)",
|
||||
"detail": "At least one of the following parameters must be present: birthDate, ovPayTokenId, customerTokenId, (serviceReferenceId and amount), (ovpasNumber and verificationCode)",
|
||||
"instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c",
|
||||
"apiErrorCode": "htm.api.err.400.2",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "One or more required parameters are missing or invalid.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"code": "REQUIRED_PARAMETER_MISSING",
|
||||
"detail": "One ore more required parameters are missing.",
|
||||
"pointer": null,
|
||||
"parameter": "birthdate, ovPayTokenId, customerTokenId",
|
||||
},
|
||||
],
|
||||
}
|
||||
Invalid date format:
|
||||
summary: Invalid date format
|
||||
value:
|
||||
{
|
||||
"type": "https://www.htm.nl/api/v1/400Error",
|
||||
"title": "Invalid input",
|
||||
"detail": "The given birthDate is not a valid Date format",
|
||||
"instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c",
|
||||
"apiErrorCode": "htm.api.err.400.3",
|
||||
"type": "https://htm.nl/api/v1/probs/400/badrequest",
|
||||
"title": "Your request is not valid.",
|
||||
"detail": "One or more parameters have an invalid format.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"code": "INVALID_PARAMETER_FORMAT",
|
||||
"detail": "The given birthdate is not a valid Date format.",
|
||||
"pointer": null,
|
||||
"parameter": "birthdate",
|
||||
},
|
||||
],
|
||||
}
|
||||
"404":
|
||||
description: Not found
|
||||
@@ -5437,11 +5469,19 @@ paths:
|
||||
summary: No birthdate present in PAD of OVpay token
|
||||
value:
|
||||
{
|
||||
"type": "https://www.htm.nl/api/v1/404Error",
|
||||
"title": "Missing birthdate in PAD",
|
||||
"detail": "There is no birthdate present in the PAD of the OVpay token, or there is no PAD present at all",
|
||||
"instance": "urn:uuid:13c8416f-7632-4c8b-8a16-2132197be60c",
|
||||
"apiErrorCode": "htm.api.err.404.1",
|
||||
"type": "https://htm.nl/api/v1/probs/404/notfound",
|
||||
"title": "Missing birthdate in PAD.",
|
||||
"detail": "There is no birthdate present in the PAD of the OVpay token, or there is no PAD present at all.",
|
||||
"instance": "urn:uuid:4017fabc-1b28-11e8-accf-0ed5f89f718b",
|
||||
"errors":
|
||||
[
|
||||
{
|
||||
"code": "MISSING_BIRTHDATE_IN_PAD",
|
||||
"detail": "Missing birthdate in PAD.",
|
||||
"pointer": null,
|
||||
"parameter": "birthdate",
|
||||
},
|
||||
],
|
||||
}
|
||||
components:
|
||||
securitySchemes:
|
||||
|
||||
@@ -243,6 +243,143 @@ paths:
|
||||
],
|
||||
"href": null,
|
||||
}
|
||||
post:
|
||||
tags:
|
||||
- Purchased Product
|
||||
summary: Create a new purchased product.
|
||||
description: Create a new purchased product.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
examples:
|
||||
Create Purchased GBO Product:
|
||||
value:
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts":
|
||||
[
|
||||
{
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-04T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"untilInclusive": "2024-10-04T12:34:56.000",
|
||||
"packageTemplateId": "30003",
|
||||
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
|
||||
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
|
||||
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
|
||||
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
|
||||
"ovPayTokenId": 13,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"createdBy": "someuser",
|
||||
"lastUpdatedBy": null,
|
||||
},
|
||||
],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers": [],
|
||||
}
|
||||
Create Purchased TapConnet Ticket:
|
||||
value:
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets":
|
||||
[
|
||||
{
|
||||
"issuedAt": "2024-10-04T12:34:56.000",
|
||||
"activatedAt": "2024-10-04T12:34:56.000",
|
||||
"cancelledAt": null,
|
||||
"ticketReference": "KJj43nejhbTxhr897287",
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"createdBy": "user",
|
||||
"lastUpdatedBy": "user",
|
||||
},
|
||||
],
|
||||
"issuedVouchers": [],
|
||||
}
|
||||
Create Issued Voucher:
|
||||
value:
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers":
|
||||
[
|
||||
{
|
||||
"voucherCode": "VOUCHER123",
|
||||
"voucherStatusInstances":
|
||||
[
|
||||
{
|
||||
"voucherStatusId": 1,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
},
|
||||
],
|
||||
"voucherClaims":
|
||||
[
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 8,
|
||||
"value": "1999-12-31",
|
||||
},
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 4,
|
||||
"value": "vlad.harkonnen@househarkonnen.net",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{ "purchasedProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd" }
|
||||
/purchasedproducts/{purchasedProductId}:
|
||||
parameters:
|
||||
- in: path
|
||||
@@ -1165,439 +1302,6 @@ paths:
|
||||
{ "voucherStatusId": 5, "name": "Expired" },
|
||||
],
|
||||
}
|
||||
/purchasedproducts/bulk:
|
||||
post:
|
||||
tags:
|
||||
- Bulk processing
|
||||
summary: Create one or more purchased product(s) in bulk.
|
||||
description: Create a new purchased product.
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
examples:
|
||||
Create Single Purchased GBO Product:
|
||||
value:
|
||||
{
|
||||
"purchasedProducts":[
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts":
|
||||
[
|
||||
{
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-04T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"untilInclusive": "2024-10-04T12:34:56.000",
|
||||
"packageTemplateId": "30003",
|
||||
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
|
||||
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
|
||||
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
|
||||
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
|
||||
"ovPayTokenId": 13,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"createdBy": "someuser",
|
||||
"lastUpdatedBy": null,
|
||||
},
|
||||
],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers": [],
|
||||
}
|
||||
]
|
||||
}
|
||||
Create Single Purchased TapConnet Ticket:
|
||||
value:
|
||||
{
|
||||
"purchasedProducts":[
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets":
|
||||
[
|
||||
{
|
||||
"issuedAt": "2024-10-04T12:34:56.000",
|
||||
"activatedAt": "2024-10-04T12:34:56.000",
|
||||
"cancelledAt": null,
|
||||
"ticketReference": "KJj43nejhbTxhr897287",
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"createdBy": "user",
|
||||
"lastUpdatedBy": "user",
|
||||
},
|
||||
],
|
||||
"issuedVouchers": [],
|
||||
}
|
||||
]
|
||||
}
|
||||
Create Single Issued Voucher:
|
||||
value:
|
||||
{
|
||||
"purchasedProducts":[
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers":
|
||||
[
|
||||
{
|
||||
"voucherCode": "VOUCHER123",
|
||||
"voucherStatusInstances":
|
||||
[
|
||||
{
|
||||
"voucherStatusId": 1,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
},
|
||||
],
|
||||
"voucherClaims":
|
||||
[
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 8,
|
||||
"value": "1999-12-31",
|
||||
},
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 4,
|
||||
"value": "vlad.harkonnen@househarkonnen.net",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}
|
||||
]
|
||||
}
|
||||
Create Multiple Issued Vouchers:
|
||||
value:
|
||||
{
|
||||
"purchasedProducts":[
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers":
|
||||
[
|
||||
{
|
||||
"voucherCode": "VOUCHER123",
|
||||
"voucherStatusInstances":
|
||||
[
|
||||
{
|
||||
"voucherStatusId": 1,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
},
|
||||
],
|
||||
"voucherClaims":
|
||||
[
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 8,
|
||||
"value": "1999-12-31",
|
||||
},
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 4,
|
||||
"value": "vlad.harkonnen@househarkonnen.net",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "7ce32f9b-52f0-4e80-a527-0c6184b57f52",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "02047745-f03e-4c00-8e1b-8dc5c86a786e",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers":
|
||||
[
|
||||
{
|
||||
"voucherCode": "VOUCHER123",
|
||||
"voucherStatusInstances":
|
||||
[
|
||||
{
|
||||
"voucherStatusId": 1,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
},
|
||||
],
|
||||
"voucherClaims":
|
||||
[
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 8,
|
||||
"value": "1940-01-18",
|
||||
},
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 4,
|
||||
"value": "valdemar.hoskanner@househarkonnen.net",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
"productId": 11,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-04T12:34:56.000",
|
||||
"purchasedProductResources":
|
||||
[
|
||||
{
|
||||
"resourceNameId": 1,
|
||||
"resourceIdentifier": "7c71ec8a-3326-451f-9464-3e36d10260e3",
|
||||
},
|
||||
{
|
||||
"resourceNameId": 2,
|
||||
"resourceIdentifier": "73c7a805-2edf-4616-a04c-267e88e0931c",
|
||||
},
|
||||
],
|
||||
"purchasedGboProducts": [],
|
||||
"purchasedTapconnectTickets": [],
|
||||
"issuedVouchers":
|
||||
[
|
||||
{
|
||||
"voucherCode": "VOUCHER123",
|
||||
"voucherStatusInstances":
|
||||
[
|
||||
{
|
||||
"voucherStatusId": 1,
|
||||
"createdOn": "2024-10-04T12:34:56.000",
|
||||
},
|
||||
],
|
||||
"voucherClaims":
|
||||
[
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 8,
|
||||
"value": "2016-06-08",
|
||||
},
|
||||
{
|
||||
"mandatoryCustomerDataItemId": 4,
|
||||
"value": "alia.artreides@housearteides.net",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
}
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"202":
|
||||
description: Accepted
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BulkResponseBody"
|
||||
examples:
|
||||
Array of purchased products accepted:
|
||||
summary: Array of purchased products accepted
|
||||
description: |
|
||||
The array of purchased products was accepted successfully.
|
||||
The purchased products will be processed asynchronously.
|
||||
In the response body the consumer will find information on how to retrieve the processing status.
|
||||
value:
|
||||
startTime: 2025-02-14T05:32:47.0672237Z
|
||||
status: Running
|
||||
clientTrackingId: 08584620957189579629541919368CU00
|
||||
callbackurl: https://api.integratielaag.nl/purchasedproducts/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
||||
retryAfter: 10
|
||||
summary: null
|
||||
/purchasedproducts/bulk/{clientTrackingId}:
|
||||
get:
|
||||
tags:
|
||||
- Bulk processing
|
||||
summary: Get the status of the purchased products bulk post.
|
||||
description: Get the status of the asynchronous purchased products bulk post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: clientTrackingId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The clientTrackingId of the purchased products bulk post.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BulkResponseBody"
|
||||
examples:
|
||||
Batch successfully processed:
|
||||
summary: Batch successfully processed
|
||||
description: |
|
||||
Body of a batch of purchased products that was successfully created.
|
||||
A number of purchased products were created.
|
||||
value:
|
||||
startTime: "2025-02-14T05:32:47.067Z"
|
||||
status: "Finished"
|
||||
clientTrackingId: "08584620957189579629541919368CU00"
|
||||
callbackurl: https://api.integratielaag.nl/purchasedproducts/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
||||
retryAfter: 0
|
||||
summary:
|
||||
created: 13
|
||||
updated: 0
|
||||
total: 13
|
||||
/voucherstatusinstances/bulk:
|
||||
post:
|
||||
summary: Post voucher status instances in bulk.
|
||||
description: Post voucher status instances in bulk.
|
||||
tags:
|
||||
- Bulk processing
|
||||
requestBody:
|
||||
required: true
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
examples:
|
||||
List of issued vouchers to set status to revoked:
|
||||
summary: List of issued vouchers to set status to revoked
|
||||
description: List of issued vouchers to set status to revoked
|
||||
value:
|
||||
{
|
||||
"voucherStatusInstances":[
|
||||
{
|
||||
"issuedVoucherId": "8a63552f-faf5-43f3-b22d-bebc976a8a5e",
|
||||
"voucherStatusId": 4,
|
||||
"createdOn": "2024-10-04T12:34:56.000"
|
||||
},
|
||||
{
|
||||
"issuedVoucherId": "a9ff40ec-2940-413a-9957-dfd471c4caf3",
|
||||
"voucherStatusId": 4,
|
||||
"createdOn": "2024-10-04T12:34:56.000"
|
||||
},
|
||||
{
|
||||
"issuedVoucherId": "9e7363e6-beaa-4c38-9ed6-c8afed459bd5",
|
||||
"voucherStatusId": 4,
|
||||
"createdOn": "2024-10-04T12:34:56.000"
|
||||
},
|
||||
{
|
||||
"issuedVoucherId": "9d7332d6-1949-4c20-aa99-d87096b035fa",
|
||||
"voucherStatusId": 4,
|
||||
"createdOn": "2024-10-04T12:34:56.000"
|
||||
},
|
||||
{
|
||||
"issuedVoucherId": "43ca757b-8370-4cb0-92b9-717948383d5e",
|
||||
"voucherStatusId": 4,
|
||||
"createdOn": "2024-10-04T12:34:56.000"
|
||||
},
|
||||
]
|
||||
}
|
||||
responses:
|
||||
"202":
|
||||
description: Accepted
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BulkResponseBody"
|
||||
examples:
|
||||
Array of issued vouchers accepted:
|
||||
summary: Array of issued vouchers status instances accepted
|
||||
description: |
|
||||
The array of issued vouchers status instances was accepted successfully.
|
||||
The issued vouchers status instances will be processed asynchronously.
|
||||
In the response body the consumer will find information on how to retrieve the processing status.
|
||||
value:
|
||||
startTime: 2025-02-14T05:32:47.0672237Z
|
||||
status: Running
|
||||
clientTrackingId: 08584620957189579629541919368CU00
|
||||
callbackurl: https://api.integratielaag.nl/voucherstatusinstances/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
||||
retryAfter: 10
|
||||
summary: null
|
||||
/voucherstatusinstances/bulk/responsestatus/{clientTrackingId}:
|
||||
get:
|
||||
tags:
|
||||
- Bulk processing
|
||||
summary: Get the status of the voucher status instances bulk post.
|
||||
description: Get the status of the asynchronous voucher status instances bulk post.
|
||||
parameters:
|
||||
- in: path
|
||||
name: clientTrackingId
|
||||
schema:
|
||||
type: string
|
||||
required: true
|
||||
description: The clientTrackingId of the voucher status instances bulk post.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/BulkResponseBody"
|
||||
examples:
|
||||
Batch successfully processed:
|
||||
summary: Batch successfully processed
|
||||
description: |
|
||||
Body of a batch of voucher status instances that was successfully created.
|
||||
A number of voucher status instances were created.
|
||||
value:
|
||||
startTime: "2025-02-14T05:32:47.067Z"
|
||||
status: "Finished"
|
||||
clientTrackingId: "08584620957189579629541919368CU00"
|
||||
callbackurl: https://api.integratielaag.nl/voucherstatusinstances/bulk/responsestatus/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
||||
retryAfter: 0
|
||||
summary:
|
||||
created: 5
|
||||
updated: 0
|
||||
total: 5
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerToken:
|
||||
@@ -1607,56 +1311,6 @@ components:
|
||||
schemas:
|
||||
unavailable:
|
||||
type: object
|
||||
BulkResponseBody:
|
||||
type: object
|
||||
properties:
|
||||
startTime:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2025-02-14T05:32:47.0672237Z
|
||||
status:
|
||||
type: string
|
||||
example: Running
|
||||
clientTrackingId:
|
||||
type: string
|
||||
example: 08584620957189579629541919368CU00
|
||||
callbackurl:
|
||||
type: string
|
||||
format: uri
|
||||
example: https://services.api.htm.nl/purchasedproducts/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
||||
retryAfter:
|
||||
type: integer
|
||||
example: 10
|
||||
summary:
|
||||
$ref: "#/components/schemas/summaryBody"
|
||||
required:
|
||||
- startTime
|
||||
- status
|
||||
- clientTrackingId
|
||||
- callbackurl
|
||||
- retryAfter
|
||||
- summary
|
||||
summaryBody:
|
||||
type: object
|
||||
properties:
|
||||
summary:
|
||||
type: object
|
||||
properties:
|
||||
created:
|
||||
type: integer
|
||||
example: 15
|
||||
updated:
|
||||
type: integer
|
||||
example: 2
|
||||
total:
|
||||
type: integer
|
||||
example: 17
|
||||
required:
|
||||
- created
|
||||
- total
|
||||
- updated
|
||||
required:
|
||||
- summary
|
||||
rfc9457:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in new issue
Block a user