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

added bulk endpoints to purchased product CRUD #42

Merged
MirjamHTM merged 3 commits from features/OVPAY2294-vouchers into develop 2025-12-08 09:35:27 +00:00
Conversation 1 Commits 3 Files Changed 1 +295 -114
1 changed files with 295 additions and 114 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files
Showing only changes of commit b898288632 - Show all commits

407
src/openapi/products/purchased_products-crud.yaml
View File

@ -246,7 +246,7 @@ paths:
post: post:
tags: tags:
- Purchased Product - Purchased Product
summary: Create a new purchased product. summary: Create one or more purchased product(s) in bulk.
description: Create a new purchased product. description: Create a new purchased product.
requestBody: requestBody:
required: true required: true
@ -255,131 +255,286 @@ paths:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/unavailable"
examples: examples:
Create Purchased GBO Product: Create Single Purchased GBO Product:
value: value:
{ {
"productId": 11, "purchasedProducts":[
"createdOn": "2024-10-04T12:34:56.000", {
"lastUpdatedOn": "2024-10-04T12:34:56.000", "productId": 11,
"purchasedProductResources": "createdOn": "2024-10-04T12:34:56.000",
[ "lastUpdatedOn": "2024-10-04T12:34:56.000",
{ "purchasedProductResources":
"resourceNameId": 1, [
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", {
}, "resourceNameId": 1,
{ "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
"resourceNameId": 2, },
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", {
}, "resourceNameId": 2,
], "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
"purchasedGboProducts": },
[ ],
{ "purchasedGboProducts":
"salesTimestamp": "2024-10-04T12:34:56.000", [
"refundTimestamp": "2024-10-04T12:34:56.000", {
"fromInclusive": "2024-10-04T12:34:56.000", "salesTimestamp": "2024-10-04T12:34:56.000",
"untilInclusive": "2024-10-04T12:34:56.000", "refundTimestamp": "2024-10-04T12:34:56.000",
"packageTemplateId": "30003", "fromInclusive": "2024-10-04T12:34:56.000",
"xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b", "untilInclusive": "2024-10-04T12:34:56.000",
"xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8", "packageTemplateId": "30003",
"xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b", "xBot": "f15efe6f-7353-4968-b134-60ba6fc2da8b",
"customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f", "xTat": "42efebf7-132e-4ee0-9cbb-4037a9a54ad8",
"ovPayTokenId": 13, "xSpit": "d67b2f72-918a-4e6c-957d-a39ed9c9e16b",
"createdOn": "2024-10-04T12:34:56.000", "customerTokenId": "b6492322-c458-4857-9ac3-a109c1887b9f",
"lastUpdatedOn": "2024-10-04T12:34:56.000", "ovPayTokenId": 13,
"createdBy": "someuser", "createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedBy": null, "lastUpdatedOn": "2024-10-04T12:34:56.000",
}, "createdBy": "someuser",
], "lastUpdatedBy": null,
"purchasedTapconnectTickets": [], },
"issuedVouchers": [], ],
"purchasedTapconnectTickets": [],
"issuedVouchers": [],
}
]
} }
Create Purchased TapConnet Ticket: Create Single Purchased TapConnet Ticket:
value: value:
{ {
"productId": 11, "purchasedProducts":[
"createdOn": "2024-10-04T12:34:56.000", {
"lastUpdatedOn": "2024-10-04T12:34:56.000", "productId": 11,
"purchasedProductResources": "createdOn": "2024-10-04T12:34:56.000",
[ "lastUpdatedOn": "2024-10-04T12:34:56.000",
{ "purchasedProductResources":
"resourceNameId": 1, [
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", {
}, "resourceNameId": 1,
{ "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
"resourceNameId": 2, },
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", {
}, "resourceNameId": 2,
], "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
"purchasedGboProducts": [], },
"purchasedTapconnectTickets": ],
[ "purchasedGboProducts": [],
{ "purchasedTapconnectTickets":
"issuedAt": "2024-10-04T12:34:56.000", [
"activatedAt": "2024-10-04T12:34:56.000", {
"cancelledAt": null, "issuedAt": "2024-10-04T12:34:56.000",
"ticketReference": "KJj43nejhbTxhr897287", "activatedAt": "2024-10-04T12:34:56.000",
"createdOn": "2024-10-04T12:34:56.000", "cancelledAt": null,
"lastUpdatedOn": "2024-10-04T12:34:56.000", "ticketReference": "KJj43nejhbTxhr897287",
"createdBy": "user", "createdOn": "2024-10-04T12:34:56.000",
"lastUpdatedBy": "user", "lastUpdatedOn": "2024-10-04T12:34:56.000",
}, "createdBy": "user",
], "lastUpdatedBy": "user",
"issuedVouchers": [], },
],
"issuedVouchers": [],
}
]
} }
Create Issued Voucher: Create Single Issued Voucher:
value: value:
{ {
"productId": 11, "purchasedProducts":[
"createdOn": "2024-10-04T12:34:56.000", {
"lastUpdatedOn": "2024-10-04T12:34:56.000", "productId": 11,
"purchasedProductResources": "createdOn": "2024-10-04T12:34:56.000",
[ "lastUpdatedOn": "2024-10-04T12:34:56.000",
{ "purchasedProductResources":
"resourceNameId": 1, [
"resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7", {
}, "resourceNameId": 1,
{ "resourceIdentifier": "408eefa9-b393-4bb3-8439-b2e51833abc7",
"resourceNameId": 2, },
"resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e", {
}, "resourceNameId": 2,
], "resourceIdentifier": "f809a6e1-1c8d-4f8e-8a6e-0d0b1e1e1e1e",
"purchasedGboProducts": [], },
"purchasedTapconnectTickets": [], ],
"issuedVouchers": "purchasedGboProducts": [],
[ "purchasedTapconnectTickets": [],
{ "issuedVouchers":
"voucherCode": "VOUCHER123", [
"voucherStatusInstances": {
[ "voucherCode": "VOUCHER123",
{ "voucherStatusInstances":
"voucherStatusId": 1, [
"createdOn": "2024-10-04T12:34:56.000", {
}, "voucherStatusId": 1,
], "createdOn": "2024-10-04T12:34:56.000",
"voucherClaims": },
[ ],
{ "voucherClaims":
"mandatoryCustomerDataItemId": 8, [
"value": "1999-12-31", {
}, "mandatoryCustomerDataItemId": 8,
{ "value": "1999-12-31",
"mandatoryCustomerDataItemId": 4, },
"value": "vlad.harkonnen@househarkonnen.net", {
}, "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: responses:
"201": "202":
description: Created description: Accepted
content: content:
application/json: application/json:
schema: schema:
$ref: "#/components/schemas/unavailable" $ref: "#/components/schemas/BulkResponseBody"
example: examples:
{ "purchasedProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd" } 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
/purchasedproducts/{purchasedProductId}: /purchasedproducts/{purchasedProductId}:
parameters: parameters:
- in: path - in: path
@ -1311,6 +1466,32 @@ components:
schemas: schemas:
unavailable: unavailable:
type: object 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
required:
- startTime
- status
- clientTrackingId
- callbackurl
- retryAfter
rfc9457: rfc9457:
type: object type: object
properties: properties: