Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
013553fba2 | ||
|
|
9cde41bfc3 | ||
|
|
98babaeb91 | ||
|
|
bfea9a5967 | ||
|
|
9e5e782192 | ||
|
|
2e0df0f57c | ||
|
|
8e2ad79b53 | ||
|
|
f065cb8072 | ||
|
|
3b390e0c6e | ||
|
|
889eeeb130 | ||
|
|
6d9712cdeb | ||
|
|
5306f34daf | ||
|
|
1f9e9c83ac | ||
|
|
0dabe48807 | ||
|
|
f7a56f3e62 | ||
|
|
330c7d1e2b | ||
|
|
3b12204566 | ||
|
|
e534d7161b | ||
|
|
b020a02c82 |
No files matched your search
@@ -27,7 +27,7 @@ paths:
|
||||
type: integer
|
||||
example: 1
|
||||
required: false
|
||||
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated.
|
||||
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated, 6 = pending cancellation, 7 = pending termination.
|
||||
responses:
|
||||
"200":
|
||||
description: OK
|
||||
@@ -53,7 +53,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"created": "2024-08-01 15:01:00.000",
|
||||
},
|
||||
{
|
||||
@@ -70,7 +69,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"created": "2024-08-01 15:01:00.000",
|
||||
},
|
||||
],
|
||||
@@ -98,7 +96,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 0,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"contractVersions":
|
||||
[
|
||||
{
|
||||
@@ -152,7 +149,7 @@ paths:
|
||||
type: integer
|
||||
explode: false
|
||||
required: false
|
||||
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated.
|
||||
description: Filter on possible contract status. 1 = new, 2 = active, 3 = suspended, 4 = cancelled, 5 = terminated, 6 = pending cancellation, 7 = pending termination.
|
||||
- in: query
|
||||
name: billingDay
|
||||
schema:
|
||||
@@ -206,7 +203,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"contractInvoices":
|
||||
[
|
||||
{
|
||||
@@ -265,7 +261,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"contractInvoices":
|
||||
[
|
||||
{
|
||||
@@ -351,7 +346,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"contractVersions":
|
||||
[
|
||||
{
|
||||
@@ -429,7 +423,6 @@ paths:
|
||||
"productName": "HTM 20% korting 2024",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 2,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
},
|
||||
}
|
||||
responses:
|
||||
@@ -878,6 +871,8 @@ paths:
|
||||
{ "contractStatusId": 3, "name": "suspended" },
|
||||
{ "contractStatusId": 4, "name": "cancelled" },
|
||||
{ "contractStatusId": 5, "name": "terminated" },
|
||||
{ "contractStatusId": 6, "name": "pending cancellation" },
|
||||
{ "contractStatusId": 7, "name": "pending termination" },
|
||||
],
|
||||
}
|
||||
/actiontypes:
|
||||
@@ -892,7 +887,7 @@ paths:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/ContractStatus"
|
||||
$ref: "#/components/schemas/ActionType"
|
||||
example:
|
||||
{
|
||||
"actionTypes":
|
||||
@@ -957,10 +952,6 @@ components:
|
||||
highestInvoiceTerm:
|
||||
type: integer
|
||||
example: 1
|
||||
xSpit:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 1c345237-4d84-47f0-93c2-7b94338e3355
|
||||
contractVersions:
|
||||
type: array
|
||||
items:
|
||||
@@ -1077,7 +1068,7 @@ components:
|
||||
example: 2
|
||||
name:
|
||||
type: string
|
||||
enum: [new, active, suspended, cancelled, terminated]
|
||||
enum: [new, active, suspended, cancelled, terminated, pending cancellation, pending termination]
|
||||
example: active
|
||||
ActionType:
|
||||
type: object
|
||||
|
||||
@@ -43,7 +43,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"created": "2024-08-01 15:01:00.000",
|
||||
},
|
||||
{
|
||||
@@ -59,7 +58,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"created": "2024-08-01 15:01:00.000",
|
||||
},
|
||||
]
|
||||
@@ -128,7 +126,6 @@ paths:
|
||||
"termDuration": "P0Y1M0D",
|
||||
"billingDay": 15,
|
||||
"highestInvoiceTerm": 1,
|
||||
"xSpit": "1c345237-4d84-47f0-93c2-7b94338e3355",
|
||||
"contractVersions":
|
||||
[
|
||||
{
|
||||
|
||||
@@ -0,0 +1,285 @@
|
||||
openapi: "3.0.3"
|
||||
info:
|
||||
title: ABT Customers CRUD APIs v2
|
||||
version: "1.0"
|
||||
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
|
||||
servers:
|
||||
- url: https://api.integratielaag.nl/v1
|
||||
paths:
|
||||
/ovpaytokens:
|
||||
get:
|
||||
tags:
|
||||
- Token
|
||||
summary: Find OVpay tokens.
|
||||
description: Find OVpay tokens.
|
||||
parameters:
|
||||
- in: query
|
||||
name: ovPayTokenId
|
||||
schema:
|
||||
type: integer
|
||||
example: 71
|
||||
required: false
|
||||
description: The id of the token.
|
||||
- in: query
|
||||
name: customerProfileId
|
||||
schema:
|
||||
type: integer
|
||||
example: 12
|
||||
required: false
|
||||
description: The id of the customer profile.
|
||||
- in: query
|
||||
name: tokenTypeId
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
example: [1, 2]
|
||||
explode: false
|
||||
required: false
|
||||
description: Filter on possible token types. 1 = EMV, 2 = OV-pas physical, 3 = OV-pas digital.
|
||||
- in: query
|
||||
name: xTat
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 700b0516-bf8b-4e6e-bf16-13bfeb078e23
|
||||
explode: false
|
||||
required: false
|
||||
description: The XTAT of the token.
|
||||
- in: query
|
||||
name: xBot
|
||||
schema:
|
||||
type: string
|
||||
format: uuid
|
||||
example: de1a9a7a-a777-4473-889c-44a3bb07daae
|
||||
explode: false
|
||||
required: false
|
||||
description: The XBOT of the token.
|
||||
- in: query
|
||||
name: alias
|
||||
schema:
|
||||
type: string
|
||||
example: Mijn OV-pas
|
||||
required: false
|
||||
description: The alias of the token.
|
||||
- in: query
|
||||
name: lastDigits
|
||||
schema:
|
||||
type: integer
|
||||
example: 3301
|
||||
required: false
|
||||
description: The last digits of the token.
|
||||
- in: query
|
||||
name: ovpasNumber
|
||||
schema:
|
||||
type: string
|
||||
example: 63AW974
|
||||
required: false
|
||||
description: Number of the OVpas.
|
||||
- in: query
|
||||
name: tokenStatusId
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
example: [1, 2]
|
||||
explode: false
|
||||
required: false
|
||||
description: Filter on possible token statuses. 1 = expired, 2 = active, 3 = replaced, 4 = inactive, 5 = suspended, 6 = removed by customer.
|
||||
- in: query
|
||||
name: expirationDate
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2029-03-22T09:00:00
|
||||
required: false
|
||||
description: The expiration date of the token.
|
||||
- in: query
|
||||
name: replacedByTokenId
|
||||
schema:
|
||||
type: integer
|
||||
example: 12
|
||||
required: false
|
||||
description: The id of the token that replaced this token.
|
||||
responses:
|
||||
200:
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"ovPayTokens":
|
||||
[
|
||||
{
|
||||
"ovPayTokenId": 71,
|
||||
"customerProfileId": 12,
|
||||
"tokenType":
|
||||
{ "tokenTypeId": 2, "name": "OV-pas physical" },
|
||||
"xTat": "700b0516-bf8b-4e6e-bf16-13bfeb078e23",
|
||||
"xBot": "de1a9a7a-a777-4473-889c-44a3bb07daae",
|
||||
"alias": "Mijn OV-pas",
|
||||
"lastDigits": 3301,
|
||||
"ovpasNumber": "63AW974",
|
||||
"tokenStatus": { "tokenStatusId": 2, "name": "Active" },
|
||||
"expirationDate": "2029-03-22T09:00:00",
|
||||
"replacedByTokenId": 12,
|
||||
},
|
||||
],
|
||||
"href": null,
|
||||
}
|
||||
/directdebitmandates:
|
||||
get:
|
||||
tags:
|
||||
- Mandates
|
||||
summary: Find direct debit mandates.
|
||||
description: Find direct debit mandates.
|
||||
parameters:
|
||||
- in: query
|
||||
name: directDebitMandateId
|
||||
schema:
|
||||
type: integer
|
||||
example: 71
|
||||
required: false
|
||||
description: The id of the direct debit mandate.
|
||||
- in: query
|
||||
name: customerProfileId
|
||||
schema:
|
||||
type: integer
|
||||
example: 12
|
||||
required: false
|
||||
description: The id of the customer related to the mandate.
|
||||
- in: query
|
||||
name: billingInformationId
|
||||
schema:
|
||||
type: integer
|
||||
example: 51
|
||||
required: false
|
||||
description: The id of the billing information related to the mandate.
|
||||
- in: query
|
||||
name: directDebitMandateTypeId
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: integer
|
||||
example: [1, 2]
|
||||
explode: false
|
||||
required: false
|
||||
description: The id of the direct debit mandate type. 1 = Paper contract, 2 = PIN transaction, 3 = SEPA eMandate, 4 = Digital signature, 5 = iDEAL transaction.
|
||||
- in: query
|
||||
name: mandateAddressId
|
||||
schema:
|
||||
type: integer
|
||||
example: 21
|
||||
required: false
|
||||
description: The id of the address related to the mandate.
|
||||
- in: query
|
||||
name: createdBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2020-12-31T23:59:59
|
||||
required: false
|
||||
description: Filter on created before.
|
||||
- in: query
|
||||
name: createdAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2020-01-01T00:00:00
|
||||
required: false
|
||||
description: Filter on created after.
|
||||
- in: query
|
||||
name: mandateReference
|
||||
schema:
|
||||
type: string
|
||||
example: CORE01
|
||||
required: false
|
||||
description: Filter on mandate reference.
|
||||
- in: query
|
||||
name: mandateState
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example: [SIGNED, PREPARED]
|
||||
explode: false
|
||||
required: false
|
||||
description: Filter on possible states of the mandate. SIGNED = signed, PREPARED = prepared, CANCELLED = cancelled.
|
||||
- in: query
|
||||
name: updatedBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2020-12-31T23:59:59
|
||||
required: false
|
||||
description: Filter on updated before.
|
||||
- in: query
|
||||
name: updatedAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2020-01-01T00:00:00
|
||||
required: false
|
||||
description: Filter on updated after.
|
||||
responses:
|
||||
200:
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
[
|
||||
{
|
||||
"directDebitMandateId": 71,
|
||||
"customerProfileId": 12,
|
||||
"billingInformationId": 51,
|
||||
"directDebitMandateType": {
|
||||
"directDebitMandateTypeId": 1,
|
||||
"name": "import",
|
||||
"description": "import"
|
||||
},
|
||||
"mandateAddressId": 21,
|
||||
"created": "2024-03-22T08:55:00",
|
||||
"mandateReference": "CORE01",
|
||||
"mandateState": "SINGED",
|
||||
"updateTimestamp": "2024-03-22T08:55:00"
|
||||
},
|
||||
]
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerToken:
|
||||
type: http
|
||||
scheme: bearer
|
||||
bearerFormat: JWT
|
||||
schemas:
|
||||
unavailable:
|
||||
type: object
|
||||
rfc9457:
|
||||
type: object
|
||||
properties:
|
||||
type:
|
||||
type: string
|
||||
format: url
|
||||
example: https://example.com/probs/out-of-credit
|
||||
title:
|
||||
type: string
|
||||
example: You do not have enough credit.
|
||||
detail:
|
||||
type: string
|
||||
example: Your current balance is 30, but that costs 50.
|
||||
instance:
|
||||
type: string
|
||||
example: /account/12345/msgs/abc
|
||||
balance:
|
||||
type: string
|
||||
example: 30
|
||||
accounts:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
example:
|
||||
- /account/12345
|
||||
- /account/67890
|
||||
File diff suppressed because it is too large.
Load diff
File diff suppressed because it is too large.
Load diff
@@ -9,23 +9,60 @@ paths:
|
||||
/orders/validation:
|
||||
post:
|
||||
tags:
|
||||
- Order Validation v2
|
||||
- Order Validation v1 & v2
|
||||
summary: Validate order.
|
||||
description: Validate order.
|
||||
parameters:
|
||||
- in: header
|
||||
name: X-HTM-JWT-AUTH-HEADER
|
||||
required: true
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
- in: header
|
||||
name: Accept-version
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: "2.0"
|
||||
description: The version of the API.
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
examples:
|
||||
v1:
|
||||
summary: Order validation v1
|
||||
description: Order validation v1
|
||||
value:
|
||||
[
|
||||
{
|
||||
"ovPayTokenId": 2,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"productId": 2,
|
||||
"startDate": "2024-03-22T09:00:00z",
|
||||
"quantity": 1,
|
||||
},
|
||||
{
|
||||
"ovPayTokenId": 3,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 89,
|
||||
"ovpasNumber": "OV34567",
|
||||
"productId": 4,
|
||||
"startDate": "2024-03-22T09:00:00z",
|
||||
"quantity": 4,
|
||||
},
|
||||
]
|
||||
v2:
|
||||
summary: Order validation v2
|
||||
description: Order validation v2
|
||||
value:
|
||||
{
|
||||
"purchaseDate": "2024-03-22",
|
||||
"customerProfileId": 1337,
|
||||
@@ -89,13 +126,50 @@ paths:
|
||||
},
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
"200":
|
||||
description: OK
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
examples:
|
||||
v1:
|
||||
summary: Order validation v1
|
||||
description: Order validation v1
|
||||
value:
|
||||
{
|
||||
"validContents": true,
|
||||
"amountExclTax": 0,
|
||||
"taxPercentage": 0,
|
||||
"amountInclTax": 0,
|
||||
"contents":
|
||||
[
|
||||
{
|
||||
"ovPayTokenId": 0,
|
||||
"serviceReferenceId": "string",
|
||||
"ovpasNumber": "string",
|
||||
"productId": 0,
|
||||
"quantity": 0,
|
||||
"amountExclTax": 0,
|
||||
"taxPercentage": 0,
|
||||
"amountInclTax": 0,
|
||||
"startDate": "string",
|
||||
"endDate": "string",
|
||||
"isRenewable": true,
|
||||
"nextDebitDate": "string",
|
||||
"termAmountExclTax": 0,
|
||||
"termAmountInclTax": 0,
|
||||
"additionalRemarks":
|
||||
[{ "code": "string", "parameter": "string" }],
|
||||
"validationErrors":
|
||||
[{ "detail": "string", "pointer": "string" }],
|
||||
},
|
||||
],
|
||||
}
|
||||
v2:
|
||||
summary: Order validation v2
|
||||
description: Order validation v2
|
||||
value:
|
||||
{
|
||||
"validContents": true,
|
||||
"purchaseDate": "2024-03-22",
|
||||
@@ -213,13 +287,13 @@ paths:
|
||||
/orders/{orderId}/fulfillment:
|
||||
post:
|
||||
tags:
|
||||
- Order Fulfillment v2
|
||||
- Order Fulfillment v1 & v2
|
||||
summary: Fulfill an order.
|
||||
description: Fulfill an order.
|
||||
parameters:
|
||||
- in: header
|
||||
name: X-HTM-JWT-AUTH-HEADER
|
||||
required: true
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
@@ -233,12 +307,64 @@ paths:
|
||||
type: string
|
||||
format: uuid
|
||||
example: a0ef57fa-395c-4a03-96e9-234c26dccea9
|
||||
- in: header
|
||||
name: Accept-version
|
||||
required: false
|
||||
style: simple
|
||||
explode: false
|
||||
schema:
|
||||
type: string
|
||||
example: "2.0"
|
||||
description: The version of the API.
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
examples:
|
||||
v1:
|
||||
summary: Order fulfillment v1
|
||||
description: Order fulfillment v1
|
||||
value:
|
||||
{
|
||||
"customerProfileID": 123415,
|
||||
"customerProfileData": { "dateOfBirth": "09-03-1989" },
|
||||
"personalAccountData": { "birthdate": "09-03-1989" },
|
||||
"directDebitMandate":
|
||||
{
|
||||
"consumerName": "J. de Tèster",
|
||||
"consumerBic": "RABONL2U",
|
||||
"consumerIban": "NL44RABO0123456789",
|
||||
},
|
||||
"orderContents":
|
||||
[
|
||||
{
|
||||
"ovPayTokenId": 123,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 450,
|
||||
"ovpasNumber": "63AW974",
|
||||
"productId": 2,
|
||||
"startDate": "2024-03-22T09:00:00Z",
|
||||
"quantity": 1,
|
||||
"orderlineId": "2d7fadc9-b64b-4516-9a7d-cf550f201372",
|
||||
},
|
||||
{
|
||||
"ovPayTokenId": 123,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 450,
|
||||
"ovpasNumber": "63AW974",
|
||||
"productId": 3,
|
||||
"startDate": "2024-03-16T09:00:00Z",
|
||||
"quantity": 1,
|
||||
"orderlineId": "9d7fadc9-b64b-4516-9a7d-cf550f201378",
|
||||
},
|
||||
],
|
||||
"orderStatus": "succeededPayment",
|
||||
}
|
||||
v2:
|
||||
summary: Order fulfillment v2
|
||||
description: Order fulfillment v2
|
||||
value:
|
||||
{
|
||||
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
|
||||
"customerProfileId": 1337,
|
||||
@@ -350,7 +476,15 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
examples:
|
||||
v1:
|
||||
summary: Order fulfillment v1
|
||||
description: Order fulfillment v1
|
||||
value: {}
|
||||
v2:
|
||||
summary: Order fulfillment v2
|
||||
description: Order fulfillment v2
|
||||
value:
|
||||
{
|
||||
"orderId": "a0ef57fa-395c-4a03-96e9-234c26dccea9",
|
||||
"orderNumber": "123456",
|
||||
@@ -485,6 +619,8 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"orders":
|
||||
[
|
||||
{
|
||||
"orderId": "afce35b2-1dff-4ace-98d0-4b9ac405c87d",
|
||||
@@ -492,7 +628,13 @@ paths:
|
||||
"orderNumber": "123456",
|
||||
"customerProfileId": 42,
|
||||
"totalAmount": 121,
|
||||
"touchPointId": 1,
|
||||
"touchPoint":
|
||||
{
|
||||
"salesTouchpointId": 3,
|
||||
"name": "Website (Perplex)",
|
||||
"isActive": true,
|
||||
"retailerId": 1001,
|
||||
},
|
||||
"language":
|
||||
{
|
||||
"languageId": 1,
|
||||
@@ -505,103 +647,19 @@ paths:
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"lastUpdatedOn": "2024-03-22T09:00:00",
|
||||
"order_OrderStatus":
|
||||
[
|
||||
{
|
||||
"order_orderStatusId": "f1d0e1a7-a3cf-4876-b8f2-073add10667f",
|
||||
"orderStatus": { "orderStatusId": 4, "name": "paid" },
|
||||
"orderStatus":
|
||||
{ "orderStatusId": 4, "name": "paid" },
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"description": "Order succesvol betaald",
|
||||
},
|
||||
{
|
||||
"order_orderStatusId": "2b9b7943-3a74-4f2e-ad65-012b62c80821",
|
||||
"orderStatus":
|
||||
{ "orderStatusId": 3, "name": "pendingPayment" },
|
||||
"createdOn": "2024-03-22T08:55:00",
|
||||
"description": "Betaling in behandeling",
|
||||
},
|
||||
],
|
||||
"orderLines":
|
||||
[
|
||||
{
|
||||
"orderLineId": "7a7a9d1a-3fc8-4058-a28b-082860aaa311",
|
||||
"externalOrderLineId": "f5fddff0-7fbd-4285-bccb-e584f431ea69",
|
||||
"productId": 1,
|
||||
"productName": "HTM Maandkorting 20%",
|
||||
"productCode": "HTM-MND-20",
|
||||
"productDescription": "HTM Maandkorting 20%",
|
||||
"taxAmount": 21,
|
||||
"taxMetadata":
|
||||
{
|
||||
"taxMetadataId": "06270769-a263-4325-82d6-f49396f39d03",
|
||||
"taxCode": "V21",
|
||||
"taxPercentageAmount": 21,
|
||||
"description": "21% BTW",
|
||||
},
|
||||
"amountExclTax": 100,
|
||||
"amountInclTax": 121,
|
||||
"quantity": 1,
|
||||
"orderLineTerms":
|
||||
[
|
||||
{
|
||||
"orderLineTermsId": "fe354db7-12ad-4fc1-bc63-a704c4e0d91e",
|
||||
"termsUrl": "generalTermsAndConditions.pdf",
|
||||
},
|
||||
],
|
||||
"validFrom": "2024-03-22T09:00:00",
|
||||
"validUntil": "2025-03-22T09:00:00",
|
||||
"orderLineStatus":
|
||||
{ "orderLineStatusId": 4, "name": "delivered" },
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"lastUpdatedOn": "2024-03-22T09:00:00",
|
||||
"customerTokens":
|
||||
[
|
||||
{
|
||||
"customerTokenId": "878ad7c1-cd8f-4bcf-a983-1bd8c6e6975e",
|
||||
"tokenType":
|
||||
{ "tokenTypeId": 1, "name": "EMV" },
|
||||
|
||||
"ovPayTokenId": 1,
|
||||
"serviceReferenceId": "NLOV1234567ABCDEFG",
|
||||
"amount": 34,
|
||||
"ovpasNumber": "OV34567",
|
||||
"verificationCode": "A7H6",
|
||||
"personalAccountData":
|
||||
{
|
||||
"personalAccountDataId": "47db8a40-3238-4bf5-9284-759e3888bd47",
|
||||
"name": "Jan de Vries",
|
||||
"dateOfBirth": "01-01-1970",
|
||||
"photoReference": "DSC_0502.JPG",
|
||||
"fileType": "image/jpg",
|
||||
"challengeType":
|
||||
{ "challengeTypeId": 1, "name": "email" },
|
||||
"oneTimePassword": "H5Iiz3JTaQeIV8p",
|
||||
},
|
||||
},
|
||||
],
|
||||
"orderAccountingStatuses":
|
||||
[
|
||||
{
|
||||
"orderAccountingStatusId": "7c5118d0-8535-4464-9239-83a7ba8fd2db",
|
||||
"accountingStatus":
|
||||
{ "accountingStatusId": 1, "name": "open" },
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"description": "Financiele transactie voor de FIKO.",
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
"payments":
|
||||
[
|
||||
{
|
||||
"paymentId": "3ba4a3c7-0803-4214-800b-365851b8903d",
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"amountDebit": 121,
|
||||
"paymentMethod":
|
||||
{
|
||||
"paymentMethodId": 1,
|
||||
"name": "ideal",
|
||||
"provider": "Buckaroo",
|
||||
},
|
||||
"touchPointId": 1,
|
||||
"isRefund": false,
|
||||
"htmPaymentReference": "HTM-1234",
|
||||
@@ -609,7 +667,6 @@ paths:
|
||||
"paymentStatuses":
|
||||
[
|
||||
{
|
||||
"paymentStatusId": 1,
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"statusCode": "190",
|
||||
"statusDescription": "Success",
|
||||
@@ -618,13 +675,8 @@ paths:
|
||||
},
|
||||
],
|
||||
"mandateInput":
|
||||
{
|
||||
"mandateInputId": "0a875e67-dc9f-4825-a030-d732a2adbfbc",
|
||||
"directDebitMandateType":
|
||||
{
|
||||
"directDebitMandateTypeId": 1,
|
||||
"name": "import",
|
||||
},
|
||||
"createdOn": "2024-03-22T09:00:00",
|
||||
"bic": "RABONL2U",
|
||||
"iban": "NL44RABO0123456789",
|
||||
@@ -633,31 +685,28 @@ paths:
|
||||
},
|
||||
},
|
||||
],
|
||||
"orderCustomer":
|
||||
"_links":
|
||||
{
|
||||
"orderCustomerId": "19ef6882-8eda-43bf-b48e-9b4ff8745a50",
|
||||
"birthname": "Jan",
|
||||
"surname": "Vries",
|
||||
"prefix": "de",
|
||||
"emailAddress": "jandevries@outlook.com",
|
||||
"dateOfBirth": "1970-01-01",
|
||||
"orderCustomerAddresses":
|
||||
[
|
||||
"self":
|
||||
{
|
||||
"orderCustomerAddressId": "aa50047c-58ac-4f15-9448-ee000dfc6893",
|
||||
"addressType":
|
||||
{ "addressTypeId": 1, "name": "Billing" },
|
||||
"street": "Kon. Julianaplein",
|
||||
"houseNumber": 10,
|
||||
"houseNumberSuffix": "a",
|
||||
"postalCode": "2595 AA",
|
||||
"city": "Den Haag",
|
||||
"country": "NL",
|
||||
"href": "https://api.example.com/items/1",
|
||||
"method": "GET",
|
||||
"templated": true,
|
||||
},
|
||||
},
|
||||
},
|
||||
],
|
||||
"_links":
|
||||
{
|
||||
"self":
|
||||
{
|
||||
"href": "https://api.example.com/items",
|
||||
"method": "GET",
|
||||
"templated": true,
|
||||
},
|
||||
},
|
||||
]
|
||||
"href": "string",
|
||||
}
|
||||
/orders:
|
||||
parameters:
|
||||
- in: header
|
||||
@@ -681,7 +730,13 @@ paths:
|
||||
"externalOrderId": null,
|
||||
"customerProfileId": 1337,
|
||||
"totalAmount": 121,
|
||||
"touchPointId": 1,
|
||||
"touchPoint":
|
||||
{
|
||||
"salesTouchpointId": 3,
|
||||
"name": "Website (Perplex)",
|
||||
"isActive": true,
|
||||
"retailerId": 1001,
|
||||
},
|
||||
"languageId": 1,
|
||||
"billingAddressId": 1,
|
||||
"shippingAddressId": 1,
|
||||
@@ -1036,7 +1091,7 @@ paths:
|
||||
example:
|
||||
{
|
||||
"orderId": "1e441d7d-50d6-4006-aca7-5e87e2f218df",
|
||||
"orderNumber": "ORD-123456"
|
||||
"orderNumber": "ORD-123456",
|
||||
}
|
||||
delete:
|
||||
tags:
|
||||
|
||||
@@ -59,6 +59,12 @@ paths:
|
||||
"isTravelProduct": true,
|
||||
"name": "Kortingsabonnement"
|
||||
},
|
||||
"tokenTypes": [
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"name": "EMV"
|
||||
}
|
||||
],
|
||||
"sellableTouchPointIds": null,
|
||||
"amountInclTax": null,
|
||||
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
|
||||
@@ -83,6 +89,7 @@ paths:
|
||||
"isTravelProduct": false,
|
||||
"name": "Barcode"
|
||||
},
|
||||
"tokenTypes": null,
|
||||
"sellableTouchPointIds": [
|
||||
1,
|
||||
2,
|
||||
@@ -112,6 +119,7 @@ paths:
|
||||
"isTravelProduct": false,
|
||||
"name": "Barcode"
|
||||
},
|
||||
"tokenTypes": null,
|
||||
"sellableTouchPointIds": [
|
||||
3,
|
||||
4
|
||||
@@ -139,6 +147,12 @@ paths:
|
||||
"isTravelProduct": true,
|
||||
"name": "Kortingsabonnement"
|
||||
},
|
||||
"tokenTypes": [
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"name": "EMV"
|
||||
}
|
||||
],
|
||||
"sellableTouchPointIds": null,
|
||||
"amountInclTax": null,
|
||||
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
|
||||
@@ -154,6 +168,7 @@ paths:
|
||||
"isTravelProduct": false,
|
||||
"name": "Barcode"
|
||||
},
|
||||
"tokenTypes": null,
|
||||
"sellableTouchPointIds": [
|
||||
1,
|
||||
2,
|
||||
@@ -174,6 +189,12 @@ paths:
|
||||
"isTravelProduct": true,
|
||||
"name": "Kortingsabonnement"
|
||||
},
|
||||
"tokenTypes": [
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"name": "EMV"
|
||||
}
|
||||
],
|
||||
"sellableTouchPointIds": [
|
||||
1,
|
||||
2
|
||||
@@ -192,6 +213,12 @@ paths:
|
||||
"isTravelProduct": true,
|
||||
"name": "Kortingsabonnement"
|
||||
},
|
||||
"tokenTypes": [
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"name": "EMV"
|
||||
}
|
||||
],
|
||||
"sellableTouchPointIds": [
|
||||
3,
|
||||
4
|
||||
@@ -219,6 +246,7 @@ paths:
|
||||
"isTravelProduct": false,
|
||||
"name": "Barcode"
|
||||
},
|
||||
"tokenTypes": null,
|
||||
"sellableTouchPointIds": [
|
||||
3,
|
||||
4
|
||||
@@ -237,6 +265,12 @@ paths:
|
||||
"isTravelProduct": true,
|
||||
"name": "Kortingsabonnement"
|
||||
},
|
||||
"tokenTypes": [
|
||||
{
|
||||
"tokenTypeId": 1,
|
||||
"name": "EMV"
|
||||
}
|
||||
],
|
||||
"sellableTouchPointIds": [
|
||||
3,
|
||||
4
|
||||
@@ -2074,6 +2108,20 @@ components:
|
||||
name:
|
||||
type: string
|
||||
example: Kortingsabonnement
|
||||
tokenTypes:
|
||||
type: array
|
||||
items:
|
||||
type: object
|
||||
required:
|
||||
- tokenTypeId
|
||||
- name
|
||||
properties:
|
||||
tokenTypeId:
|
||||
type: integer
|
||||
example: 1
|
||||
name:
|
||||
type: string
|
||||
example: EMV
|
||||
sellableTouchPointIds:
|
||||
type: array
|
||||
items:
|
||||
|
||||
@@ -21,7 +21,7 @@ paths:
|
||||
required: false
|
||||
description: The technical id of the product.
|
||||
- in: query
|
||||
name: createdOnBefore
|
||||
name: createdBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -29,7 +29,7 @@ paths:
|
||||
required: false
|
||||
description: The purchased product should be created before this timestamp.
|
||||
- in: query
|
||||
name: createdOnAfter
|
||||
name: createdAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -37,7 +37,7 @@ paths:
|
||||
required: false
|
||||
description: The purchased product should be created after this timestamp.
|
||||
- in: query
|
||||
name: lastUpdatedOnBefore
|
||||
name: lastUpdatedBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -45,7 +45,7 @@ paths:
|
||||
required: false
|
||||
description: The purchased product should be last updated before this timestamp.
|
||||
- in: query
|
||||
name: lastUpdatedOnAfter
|
||||
name: lastUpdatedAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
@@ -101,18 +101,12 @@ paths:
|
||||
"purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-04T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"unitilInclusive": "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,
|
||||
},
|
||||
],
|
||||
},
|
||||
@@ -150,18 +144,12 @@ paths:
|
||||
{
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-04T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"unitilInclusive": "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,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -220,18 +208,12 @@ paths:
|
||||
{
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-04T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"unitilInclusive": "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,
|
||||
},
|
||||
],
|
||||
}
|
||||
@@ -318,18 +300,12 @@ paths:
|
||||
{
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-04T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"unitilInclusive": "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,
|
||||
}
|
||||
responses:
|
||||
"201":
|
||||
@@ -391,34 +367,6 @@ paths:
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be refunded after this timestamp.
|
||||
- in: query
|
||||
name: fromInclusiveBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be valid before this timestamp.
|
||||
- in: query
|
||||
name: fromInclusiveAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be valid after this timestamp.
|
||||
- in: query
|
||||
name: unitilInclusiveBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be valid before this timestamp.
|
||||
- in: query
|
||||
name: unitilInclusiveAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be valid after this timestamp.
|
||||
- in: query
|
||||
name: packageTemplateId
|
||||
schema:
|
||||
@@ -460,46 +408,6 @@ paths:
|
||||
type: integer
|
||||
example: 13
|
||||
description: The id of the ov pay token.
|
||||
- in: query
|
||||
name: createdOnBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be created before this timestamp.
|
||||
- in: query
|
||||
name: createdOnAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be created after this timestamp.
|
||||
- in: query
|
||||
name: lastUpdatedOnBefore
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be updated before this timestamp.
|
||||
- in: query
|
||||
name: lastUpdatedOnAfter
|
||||
schema:
|
||||
type: string
|
||||
format: date-time
|
||||
example: 2024-10-04T12:34:56.000
|
||||
description: The purchased GBO product should be updated after this timestamp.
|
||||
- in: query
|
||||
name: createdBy
|
||||
schema:
|
||||
type: string
|
||||
example: someuser
|
||||
description: The user that created the purchased GBO product.
|
||||
- in: query
|
||||
name: lastUpdatedBy
|
||||
schema:
|
||||
type: string
|
||||
example: someuser
|
||||
description: The user that last updated the purchased GBO product.
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@@ -514,36 +422,24 @@ paths:
|
||||
"purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
|
||||
"salesTimestamp": "2024-10-04T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-05T12:34:56.000",
|
||||
"fromInclusive": "2024-10-04T12:34:56.000",
|
||||
"unitilInclusive": "2024-10-05T12: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,
|
||||
},
|
||||
{
|
||||
"purchasedGboProductId": 431e481f-4330-4ad4-be47-393db38cfe38,
|
||||
"purchasedProductId": "9e166bb3-806a-4f43-a7a2-0d5b1e90e0c3",
|
||||
"salesTimestamp": "2024-10-05T12:34:56.000",
|
||||
"refundTimestamp": "2024-10-06T12:34:56.000",
|
||||
"fromInclusive": "2024-10-05T12:34:56.000",
|
||||
"unitilInclusive": "2024-10-06T12:34:56.000",
|
||||
"packageTemplateId": "30003",
|
||||
"xBot": "f8f13d64-fd07-44e8-9c85-968857da5d68",
|
||||
"xTat": "01a82ebe-5d07-45d8-a897-66152e8954dd",
|
||||
"xSpit": "c3868858-b250-4480-9cb4-725d2e9198f3",
|
||||
"customerTokenId": "6c7a6d4b-7e6c-4f6a-9b1e-0a9b1e6c7a6d",
|
||||
"ovPayTokenId": 14,
|
||||
"createdOn": "2024-10-05T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-05T12:34:56.000",
|
||||
"createdBy": "someuser",
|
||||
"lastUpdatedBy": null,
|
||||
},
|
||||
]
|
||||
/purchasedgboproducts/{purchasedGboProductId}:
|
||||
@@ -567,12 +463,7 @@ paths:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"refundTimestamp": "2024-10-05T12:34:56.000",
|
||||
"lastUpdatedOn": "2024-10-05T12:34:56.000",
|
||||
"lastUpdatedBy": "someuser",
|
||||
}
|
||||
example: { "refundTimestamp": "2024-10-05T12:34:56.000" }
|
||||
responses:
|
||||
"201":
|
||||
description: Created
|
||||
@@ -581,9 +472,7 @@ paths:
|
||||
schema:
|
||||
$ref: "#/components/schemas/unavailable"
|
||||
example:
|
||||
{
|
||||
"purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd",
|
||||
}
|
||||
{ "purchasedGboProductId": "a9b3dea5-fb8a-4b1e-9fe6-90cad31c0cfd" }
|
||||
components:
|
||||
securitySchemes:
|
||||
bearerToken:
|
||||
|
||||
@@ -86,6 +86,20 @@ paths:
|
||||
example: 65ad5520-4e62-41b7-89dd-a01be6cb78bf
|
||||
required: false
|
||||
description: Pointer to executor of this action (e.g. the batch job).
|
||||
- in: query
|
||||
name: role
|
||||
schema:
|
||||
type: string
|
||||
example: customer
|
||||
required: false
|
||||
description: Role of the user or process that initiated the action.
|
||||
- in: query
|
||||
name: user
|
||||
schema:
|
||||
type: string
|
||||
example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
|
||||
required: false
|
||||
description: User that initiated the action. In case of a customer this is the customer id.
|
||||
- in: query
|
||||
name: resourceName
|
||||
schema:
|
||||
@@ -123,6 +137,8 @@ paths:
|
||||
"created": "2024-07-02 15:01:00.000",
|
||||
"updated": "2024-07-02 15:01:00.000",
|
||||
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
|
||||
"role": "customer",
|
||||
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
|
||||
"scheduledActionResources":
|
||||
[
|
||||
{
|
||||
@@ -157,6 +173,8 @@ paths:
|
||||
"created": "2024-07-02 15:01:00.000",
|
||||
"updated": "2024-07-02 15:01:00.000",
|
||||
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
|
||||
"role": "customer",
|
||||
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
|
||||
"scheduledActionResources":
|
||||
[
|
||||
{
|
||||
@@ -217,6 +235,8 @@ paths:
|
||||
"created": "2024-07-02 15:01:00.000",
|
||||
"updated": "2024-07-02 15:01:00.000",
|
||||
"correlationId": "fb4443c6-5a6a-47a3-adf0-db3dfc183399",
|
||||
"role": "customer",
|
||||
"user": "1255ab39-2f10-409a-bf61-38c07e1b8a9e",
|
||||
"scheduledActionResources":
|
||||
[
|
||||
{
|
||||
@@ -390,6 +410,12 @@ components:
|
||||
type: string
|
||||
format: uuid
|
||||
example: 8699d72a-cf4d-4e6b-9e9c-549d837ca51f
|
||||
role:
|
||||
type: string
|
||||
example: customer
|
||||
user:
|
||||
type: string
|
||||
example: 1255ab39-2f10-409a-bf61-38c07e1b8a9e
|
||||
ScheduledActionType:
|
||||
type: object
|
||||
properties:
|
||||
|
||||
Reference in new issue
Block a user