Compare commits
No commits in common. "546d65505410b929716b187fa2fe56d5f75ebe08" and "79faa8ab3d9f35190f9013ea57afffce46c2064d" have entirely different histories.
546d655054
...
79faa8ab3d
@ -240,16 +240,6 @@ paths:
|
|||||||
"phoneTypeId": 2,
|
"phoneTypeId": 2,
|
||||||
"isPreferred": false
|
"isPreferred": false
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"devices": [
|
|
||||||
{
|
|
||||||
"externalDeviceId": "123e4567-e89b-12d3-a456-426614174000",
|
|
||||||
"alias": "My iPhone",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"externalDeviceId": "987e6543-e21b-12d3-a456-426614174999",
|
|
||||||
"alias": "My iPad",
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -337,18 +327,6 @@ paths:
|
|||||||
"phoneTypeId": 2,
|
"phoneTypeId": 2,
|
||||||
"isPreferred": false
|
"isPreferred": false
|
||||||
}
|
}
|
||||||
],
|
|
||||||
"devices": [
|
|
||||||
{
|
|
||||||
"deviceId": "813afdd8-bf8c-4e26-bfda-4da79552bd38",
|
|
||||||
"externalDeviceId": "123e4567-e89b-12d3-a456-426614174000",
|
|
||||||
"alias": "My iPhone",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"deviceId": "4f4249a2-ac6c-44f9-b740-66e66b6f3c28",
|
|
||||||
"externalDeviceId": "987e6543-e21b-12d3-a456-426614174999",
|
|
||||||
"alias": "My iPad",
|
|
||||||
}
|
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@ -3315,89 +3293,6 @@ paths:
|
|||||||
},
|
},
|
||||||
],
|
],
|
||||||
}
|
}
|
||||||
/customers/devices:
|
|
||||||
post:
|
|
||||||
summary: Add a new device to a customer profile.
|
|
||||||
description: Add a new device to a customer profile.
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/unavailable"
|
|
||||||
examples:
|
|
||||||
Add a new device:
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"externalDeviceId": "dee7d80e-9288-4508-a3ed-c067e619179f",
|
|
||||||
"alias": "My iPhone 13",
|
|
||||||
}
|
|
||||||
responses:
|
|
||||||
"201":
|
|
||||||
description: Created
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/unavailable"
|
|
||||||
examples:
|
|
||||||
New device added to customer profile:
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"deviceId": "0f0981bf-6d60-4b06-bc55-de1ba325f366",
|
|
||||||
"externalDeviceId": "dee7d80e-9288-4508-a3ed-c067e619179f",
|
|
||||||
"alias": "My iPhone 13",
|
|
||||||
}
|
|
||||||
/customers/devices/{deviceId}:
|
|
||||||
parameters:
|
|
||||||
- name: deviceId
|
|
||||||
in: path
|
|
||||||
required: true
|
|
||||||
style: simple
|
|
||||||
description: Id of the device to be deleted.
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 0f0981bf-6d60-4b06-bc55-de1ba325f366
|
|
||||||
patch:
|
|
||||||
summary: Update alias of a device in a customer profile.
|
|
||||||
description: Update alias of a device in a customer profile.
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/unavailable"
|
|
||||||
examples:
|
|
||||||
Update alias of a device:
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"alias": "My old iPhone 13",
|
|
||||||
}
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/unavailable"
|
|
||||||
examples:
|
|
||||||
Device alias updated in customer profile:
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"deviceId": "0f0981bf-6d60-4b06-bc55-de1ba325f366",
|
|
||||||
"externalDeviceId": "dee7d80e-9288-4508-a3ed-c067e619179f",
|
|
||||||
"alias": "My old iPhone 13",
|
|
||||||
}
|
|
||||||
delete:
|
|
||||||
summary: Delete a device from a customer profile.
|
|
||||||
description: Delete a device from a customer profile.
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: OK
|
|
||||||
components:
|
components:
|
||||||
schemas:
|
schemas:
|
||||||
unavailable:
|
unavailable:
|
||||||
@ -3576,6 +3471,27 @@ components:
|
|||||||
country:
|
country:
|
||||||
type: string
|
type: string
|
||||||
example: NL
|
example: NL
|
||||||
|
_links:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
self:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/addresses/1
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
delete_address:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/addresses/1
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: DELETE
|
||||||
phones:
|
phones:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
@ -3602,49 +3518,24 @@ components:
|
|||||||
countryCode:
|
countryCode:
|
||||||
type: string
|
type: string
|
||||||
example: "0031"
|
example: "0031"
|
||||||
devices:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
deviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 1
|
|
||||||
externalDeviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: dee7d80e-9288-4508-a3ed-c067e619179f
|
|
||||||
alias:
|
|
||||||
type: string
|
|
||||||
example: My iPhone 13
|
|
||||||
_links:
|
_links:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
add_device:
|
self:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/devices
|
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/phones/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: POST
|
example: GET
|
||||||
edit_device:
|
delete_phone:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/devices/1
|
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/phones/1
|
||||||
method:
|
|
||||||
type: string
|
|
||||||
example: PATCH
|
|
||||||
delete_device:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
href:
|
|
||||||
type: string
|
|
||||||
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/devices/1
|
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: DELETE
|
example: DELETE
|
||||||
@ -3660,6 +3551,16 @@ components:
|
|||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
|
create_customer_status:
|
||||||
|
type: object
|
||||||
|
description: ONLY ALLOWED FOR SMP - Create a new customer status
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
example: https://api.integratielaag.nl/abt/touchpoint/1.0/customers/statuses
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: POST
|
||||||
partial_edit:
|
partial_edit:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
@ -139,7 +139,7 @@ paths:
|
|||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
example: "0123456789"
|
example: "0123456789"
|
||||||
- name: ovChipCardAlias
|
- name: ovChipcardAlias
|
||||||
in: query
|
in: query
|
||||||
schema:
|
schema:
|
||||||
type: string
|
type: string
|
||||||
@ -278,14 +278,7 @@ paths:
|
|||||||
phoneTypeId: 2
|
phoneTypeId: 2
|
||||||
name: Work
|
name: Work
|
||||||
isPreferred: false
|
isPreferred: false
|
||||||
devices:
|
ovChipcards:
|
||||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
|
||||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
|
||||||
alias: "iPhone prive"
|
|
||||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
|
||||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
ovChipCards:
|
|
||||||
- ovChipCardId: 1
|
- ovChipCardId: 1
|
||||||
chipCardNumber: "1234123412341234"
|
chipCardNumber: "1234123412341234"
|
||||||
validUntil: "2023-01-01"
|
validUntil: "2023-01-01"
|
||||||
@ -411,14 +404,7 @@ paths:
|
|||||||
phoneTypeId: 2
|
phoneTypeId: 2
|
||||||
name: Work
|
name: Work
|
||||||
isPreferred: false
|
isPreferred: false
|
||||||
devices:
|
ovChipcards:
|
||||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
|
||||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
|
||||||
alias: "iPhone prive"
|
|
||||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
|
||||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
ovChipCards:
|
|
||||||
- ovChipCardId: 1
|
- ovChipCardId: 1
|
||||||
chipCardNumber: "1234123412341234"
|
chipCardNumber: "1234123412341234"
|
||||||
validUntil: "2023-01-01"
|
validUntil: "2023-01-01"
|
||||||
@ -557,14 +543,7 @@ paths:
|
|||||||
phoneTypeId: 2
|
phoneTypeId: 2
|
||||||
name: Work
|
name: Work
|
||||||
isPreferred: false
|
isPreferred: false
|
||||||
devices:
|
ovChipcards:
|
||||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
|
||||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
|
||||||
alias: "iPhone prive"
|
|
||||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
|
||||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
ovChipCards:
|
|
||||||
- ovChipCardId: 1
|
- ovChipCardId: 1
|
||||||
chipCardNumber: "1234123412341234"
|
chipCardNumber: "1234123412341234"
|
||||||
validUntil: "2023-01-01"
|
validUntil: "2023-01-01"
|
||||||
@ -698,14 +677,7 @@ paths:
|
|||||||
phoneTypeId: 2
|
phoneTypeId: 2
|
||||||
name: Work
|
name: Work
|
||||||
isPreferred: false
|
isPreferred: false
|
||||||
devices:
|
ovChipcards:
|
||||||
- deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
|
||||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
|
||||||
alias: "iPhone prive"
|
|
||||||
- deviceId: "d7683e89-b2ad-4e79-85b3-dbb42aad0325"
|
|
||||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
ovChipCards:
|
|
||||||
- ovChipCardId: 1
|
- ovChipCardId: 1
|
||||||
chipCardNumber: "1234123412341234"
|
chipCardNumber: "1234123412341234"
|
||||||
validUntil: "2023-01-01"
|
validUntil: "2023-01-01"
|
||||||
@ -851,11 +823,6 @@ paths:
|
|||||||
countryCode: "+31"
|
countryCode: "+31"
|
||||||
phoneTypeId: 2
|
phoneTypeId: 2
|
||||||
isPreferred: false
|
isPreferred: false
|
||||||
devices:
|
|
||||||
- externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
|
||||||
alias: "iPhone prive"
|
|
||||||
- externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
201:
|
201:
|
||||||
@ -1060,7 +1027,7 @@ paths:
|
|||||||
/customers/{customerProfileId}/addresses:
|
/customers/{customerProfileId}/addresses:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- Addresses
|
- Customer address
|
||||||
summary: Add a customer address
|
summary: Add a customer address
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
@ -1102,7 +1069,7 @@ paths:
|
|||||||
/addresses/{addressId}:
|
/addresses/{addressId}:
|
||||||
patch:
|
patch:
|
||||||
tags:
|
tags:
|
||||||
- Addresses
|
- Customer address
|
||||||
summary: Edit a customer address
|
summary: Edit a customer address
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
@ -1142,7 +1109,7 @@ paths:
|
|||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
- Addresses
|
- Customer address
|
||||||
summary: Delete a customer address
|
summary: Delete a customer address
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
@ -1165,8 +1132,8 @@ paths:
|
|||||||
/customers/{customerProfileId}/phones:
|
/customers/{customerProfileId}/phones:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- Phones
|
- Customer phoneNumber
|
||||||
summary: Add a customer phone
|
summary: Add a customer phonenumber
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
@ -1184,7 +1151,7 @@ paths:
|
|||||||
examples:
|
examples:
|
||||||
customerPhone:
|
customerPhone:
|
||||||
value:
|
value:
|
||||||
customerPhone:
|
phone:
|
||||||
number: "0701112233"
|
number: "0701112233"
|
||||||
countryCode: "0031"
|
countryCode: "0031"
|
||||||
phoneTypeId: 1
|
phoneTypeId: 1
|
||||||
@ -1204,8 +1171,8 @@ paths:
|
|||||||
/phones/{phoneId}:
|
/phones/{phoneId}:
|
||||||
patch:
|
patch:
|
||||||
tags:
|
tags:
|
||||||
- Phones
|
- Customer phoneNumber
|
||||||
summary: Edit a customer phone
|
summary: Edit a customer phonenumber
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
@ -1246,7 +1213,7 @@ paths:
|
|||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
- Phones
|
- Customer phoneNumber
|
||||||
summary: Delete a customer phone
|
summary: Delete a customer phone
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
@ -1266,209 +1233,12 @@ paths:
|
|||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
/devices:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
summary: Find devices.
|
|
||||||
description: Find devices.
|
|
||||||
parameters:
|
|
||||||
- in: query
|
|
||||||
name: deviceId
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
|
|
||||||
required: false
|
|
||||||
description: The id of the device.
|
|
||||||
- in: query
|
|
||||||
name: customerProfileId
|
|
||||||
schema:
|
|
||||||
type: integer
|
|
||||||
example: 1
|
|
||||||
required: false
|
|
||||||
description: The id of the customer profile.
|
|
||||||
- in: query
|
|
||||||
name: externalDeviceId
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: c5545584-04af-4c60-a955-d6a70baab848
|
|
||||||
required: false
|
|
||||||
description: The external id of the device.
|
|
||||||
- in: query
|
|
||||||
name: alias
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
example: iPhone prive
|
|
||||||
required: false
|
|
||||||
description: The alias of the device.
|
|
||||||
- name: sort
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
- name: offset
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: integer
|
|
||||||
- name: limit
|
|
||||||
in: query
|
|
||||||
schema:
|
|
||||||
type: integer
|
|
||||||
example: 20
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/getDevicesResponse"
|
|
||||||
example:
|
|
||||||
{
|
|
||||||
"devices":
|
|
||||||
[
|
|
||||||
{
|
|
||||||
"customerProfileId": 1,
|
|
||||||
"deviceId": "5bedce29-af0c-4f3c-b182-2caa8a1f9377",
|
|
||||||
"externalDeviceId": "c5545584-04af-4c60-a955-d6a70baab848",
|
|
||||||
"alias": "iPhone prive",
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"customerProfileId": 1,
|
|
||||||
"deviceId": "d7683e89-b2ad-4e79-85b3-dbb42aad0325",
|
|
||||||
"externalDeviceId": "7122a988-a00a-417d-a5b4-da2d91354976",
|
|
||||||
"alias": "iPhone zakelijk",
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"_links":
|
|
||||||
{
|
|
||||||
"self":
|
|
||||||
{
|
|
||||||
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/devices?offset=20",
|
|
||||||
"method": "GET",
|
|
||||||
},
|
|
||||||
"prev":
|
|
||||||
{
|
|
||||||
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/devices",
|
|
||||||
"method": "GET",
|
|
||||||
},
|
|
||||||
"next":
|
|
||||||
{
|
|
||||||
"href": "https://api.integratielaag.nl/abt/abtcustomers/2.0/devices?offset=40",
|
|
||||||
"method": "GET",
|
|
||||||
},
|
|
||||||
},
|
|
||||||
}
|
|
||||||
/customers/{customerProfileId}/devices:
|
|
||||||
post:
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
summary: Add a customer device
|
|
||||||
description: >-
|
|
||||||
|
|
||||||
parameters:
|
|
||||||
- name: customerProfileId
|
|
||||||
in: path
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: integer
|
|
||||||
example: 1
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/postCustomerDevice"
|
|
||||||
examples:
|
|
||||||
customerDevice:
|
|
||||||
value:
|
|
||||||
device:
|
|
||||||
externalDeviceId: "c5545584-04af-4c60-a955-d6a70baab848"
|
|
||||||
alias: "iPhone prive"
|
|
||||||
required: true
|
|
||||||
responses:
|
|
||||||
201:
|
|
||||||
description: Successfully created a customer device
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/getDevices"
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
/devices/{deviceId}:
|
|
||||||
patch:
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
summary: Edit a customer device
|
|
||||||
description: >-
|
|
||||||
|
|
||||||
parameters:
|
|
||||||
- name: deviceId
|
|
||||||
in: path
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
|
|
||||||
requestBody:
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/patchCustomerDevice"
|
|
||||||
examples:
|
|
||||||
updateDevice:
|
|
||||||
value:
|
|
||||||
device:
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
required: true
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Successfully modified a customer device
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/getDevices"
|
|
||||||
examples:
|
|
||||||
updateDeviceResponse:
|
|
||||||
value:
|
|
||||||
deviceId: "5bedce29-af0c-4f3c-b182-2caa8a1f9377"
|
|
||||||
externalDeviceId: "7122a988-a00a-417d-a5b4-da2d91354976"
|
|
||||||
alias: "iPhone zakelijk"
|
|
||||||
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
delete:
|
|
||||||
tags:
|
|
||||||
- Devices
|
|
||||||
summary: Delete a customer device
|
|
||||||
description: >-
|
|
||||||
|
|
||||||
parameters:
|
|
||||||
- name: deviceId
|
|
||||||
in: path
|
|
||||||
required: true
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 5bedce29-af0c-4f3c-b182-2caa8a1f9377
|
|
||||||
responses:
|
|
||||||
200:
|
|
||||||
description: Successfully deleted a customer device
|
|
||||||
content:
|
|
||||||
application/json: {}
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
/ovpaytokens:
|
/ovpaytokens:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- OVpay Tokens
|
- Ovpay Token
|
||||||
summary: Find OVpay tokens.
|
summary: Find ovpay tokens.
|
||||||
description: Find OVpay tokens.
|
description: Find ovpay tokens.
|
||||||
parameters:
|
parameters:
|
||||||
- in: query
|
- in: query
|
||||||
name: ovPayTokenId
|
name: ovPayTokenId
|
||||||
@ -1619,8 +1389,8 @@ paths:
|
|||||||
/customers/{customerProfileId}/ovpaytokens:
|
/customers/{customerProfileId}/ovpaytokens:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- OVpay Tokens
|
- Ovpay Token
|
||||||
summary: Create a new OVpay token
|
summary: Create a new ovpay token
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
@ -1638,7 +1408,7 @@ paths:
|
|||||||
examples:
|
examples:
|
||||||
EMV token:
|
EMV token:
|
||||||
value:
|
value:
|
||||||
ovPayToken:
|
ovpaytoken:
|
||||||
tokenTypeId: 1
|
tokenTypeId: 1
|
||||||
xTat: 0115b0df-db38-4702-8811-6f7de00db3ac
|
xTat: 0115b0df-db38-4702-8811-6f7de00db3ac
|
||||||
xBot: 71a88843-32b8-4d52-ac25-de2458c47775
|
xBot: 71a88843-32b8-4d52-ac25-de2458c47775
|
||||||
@ -1647,7 +1417,7 @@ paths:
|
|||||||
expirationDate: "2026-04-20T17:05:52.000+02:00"
|
expirationDate: "2026-04-20T17:05:52.000+02:00"
|
||||||
OVpas token physical:
|
OVpas token physical:
|
||||||
value:
|
value:
|
||||||
ovPayToken:
|
ovpaytoken:
|
||||||
tokenTypeId: 2
|
tokenTypeId: 2
|
||||||
xTat: 0115b0df-db38-4702-8811-6f7de00db3ac
|
xTat: 0115b0df-db38-4702-8811-6f7de00db3ac
|
||||||
xBot: 71a88843-32b8-4d52-ac25-de2458c47775
|
xBot: 71a88843-32b8-4d52-ac25-de2458c47775
|
||||||
@ -1658,7 +1428,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
201:
|
201:
|
||||||
description: Successfully created a customer ovPayToken
|
description: Successfully created a customer ovpaytoken
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
@ -1667,15 +1437,15 @@ paths:
|
|||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
/ovpaytokens/{ovPayTokenId}:
|
/ovpaytokens/{ovpaytokenId}:
|
||||||
patch:
|
patch:
|
||||||
tags:
|
tags:
|
||||||
- OVpay Tokens
|
- Ovpay Token
|
||||||
summary: Update an OVpay token
|
summary: Update an ovpay token
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- name: ovPayTokenId
|
- name: ovpaytokenId
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
@ -1689,28 +1459,28 @@ paths:
|
|||||||
examples:
|
examples:
|
||||||
updateFullToken:
|
updateFullToken:
|
||||||
value:
|
value:
|
||||||
ovPayToken:
|
ovpaytoken:
|
||||||
alias: "ING pas mobiel"
|
alias: "ING pas mobiel"
|
||||||
tokenStatusId: 1
|
tokenStatusId: 1
|
||||||
replacedByTokenId: 8
|
replacedByTokenId: 8
|
||||||
lastDigits: 4563
|
lastdigits: 4563
|
||||||
updateTokenAlias:
|
updateTokenAlias:
|
||||||
value:
|
value:
|
||||||
ovPayToken:
|
ovpaytoken:
|
||||||
alias: "ING pas mobiel"
|
alias: "ING pas mobiel"
|
||||||
updateTokenStatus to removed:
|
updateTokenStatus to removed:
|
||||||
value:
|
value:
|
||||||
ovPayToken:
|
ovpaytoken:
|
||||||
tokenStatusId: 6
|
tokenStatusId: 6
|
||||||
replaceToken:
|
replaceToken:
|
||||||
value:
|
value:
|
||||||
ovPayToken:
|
ovpaytoken:
|
||||||
tokenStatusId: 3
|
tokenStatusId: 3
|
||||||
replacedByTokenId: 8
|
replacedByTokenId: 8
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Successfully updated a customer ovPayToken
|
description: Successfully updated a customer ovpaytoken
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
@ -1721,12 +1491,12 @@ paths:
|
|||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
- OVpay Tokens
|
- Ovpay Token
|
||||||
summary: Delete an OVpay token
|
summary: Delete an ovpay token
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
- name: ovPayTokenId
|
- name: ovpaytokenId
|
||||||
in: path
|
in: path
|
||||||
required: true
|
required: true
|
||||||
schema:
|
schema:
|
||||||
@ -1734,7 +1504,7 @@ paths:
|
|||||||
example: 2
|
example: 2
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Successfully deleted a customer ovPayToken
|
description: Successfully deleted a customer ovpaytoken
|
||||||
content:
|
content:
|
||||||
application/json: {}
|
application/json: {}
|
||||||
security:
|
security:
|
||||||
@ -1744,8 +1514,8 @@ paths:
|
|||||||
/customers/{customerProfileId}/ovchipcards:
|
/customers/{customerProfileId}/ovchipcards:
|
||||||
post:
|
post:
|
||||||
tags:
|
tags:
|
||||||
- OV Chipcards
|
- Ovchipcard
|
||||||
summary: Create a new OV chipcard
|
summary: Create a new ovchipcard
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
@ -1759,18 +1529,18 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/ovChipCardEntity"
|
$ref: "#/components/schemas/ovChipcardEntity"
|
||||||
examples:
|
examples:
|
||||||
ovChipCards:
|
ovChipcards:
|
||||||
value:
|
value:
|
||||||
ovChipCard:
|
ovChipcard:
|
||||||
chipcardNumber: "1234123412341234"
|
chipCardNumber: "1234123412341234"
|
||||||
validUntil: "2027-01-01"
|
validUntil: "2027-01-01"
|
||||||
alias: Mijn chipkaart
|
alias: Mijn chipkaart
|
||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
201:
|
201:
|
||||||
description: Successfully created a customer ovChipCard
|
description: Successfully created a customer ovchipcard
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
@ -1779,11 +1549,11 @@ paths:
|
|||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
/ovchipcards/{ovChipCardId}:
|
/ovchipcards/{ovchipcardId}:
|
||||||
patch:
|
patch:
|
||||||
tags:
|
tags:
|
||||||
- OV Chipcards
|
- Ovchipcard
|
||||||
summary: Update an OV chipcard
|
summary: Update an ovchipcard
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
@ -1797,7 +1567,7 @@ paths:
|
|||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: "#/components/schemas/ovChipCardEntity"
|
$ref: "#/components/schemas/ovChipcardEntity"
|
||||||
examples:
|
examples:
|
||||||
updateOvChipCardAlias:
|
updateOvChipCardAlias:
|
||||||
value:
|
value:
|
||||||
@ -1806,7 +1576,7 @@ paths:
|
|||||||
required: true
|
required: true
|
||||||
responses:
|
responses:
|
||||||
200:
|
200:
|
||||||
description: Successfully updated a customer ovChipCard
|
description: Successfully updated a customer ovchipcard
|
||||||
content:
|
content:
|
||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
@ -1817,8 +1587,8 @@ paths:
|
|||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
delete:
|
delete:
|
||||||
tags:
|
tags:
|
||||||
- OV Chipcards
|
- Ovchipcard
|
||||||
summary: Delete an OV chipcard
|
summary: Delete an ovchipcard
|
||||||
description: >-
|
description: >-
|
||||||
|
|
||||||
parameters:
|
parameters:
|
||||||
@ -2409,10 +2179,6 @@ components:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/getPhones"
|
$ref: "#/components/schemas/getPhones"
|
||||||
devices:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: "#/components/schemas/getDevices"
|
|
||||||
getAddresses:
|
getAddresses:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -2459,21 +2225,6 @@ components:
|
|||||||
type: integer
|
type: integer
|
||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
getDevices:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
deviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
externalDeviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
alias:
|
|
||||||
type: string
|
|
||||||
required:
|
|
||||||
- deviceId
|
|
||||||
- externalDeviceId
|
|
||||||
- alias
|
|
||||||
getCustomerPreference:
|
getCustomerPreference:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -2516,7 +2267,7 @@ components:
|
|||||||
$ref: "#/components/schemas/getCustomerStatusInstance"
|
$ref: "#/components/schemas/getCustomerStatusInstance"
|
||||||
person:
|
person:
|
||||||
$ref: "#/components/schemas/getPerson"
|
$ref: "#/components/schemas/getPerson"
|
||||||
ovChipCards:
|
ovChipcards:
|
||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/getOvChipcards"
|
$ref: "#/components/schemas/getOvChipcards"
|
||||||
@ -2578,17 +2329,6 @@ components:
|
|||||||
type: integer
|
type: integer
|
||||||
isPreferred:
|
isPreferred:
|
||||||
type: boolean
|
type: boolean
|
||||||
devicePostEntity:
|
|
||||||
required:
|
|
||||||
- externalDeviceId
|
|
||||||
- alias
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
externalDeviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
alias:
|
|
||||||
type: string
|
|
||||||
defaultCustomerProfileResponse:
|
defaultCustomerProfileResponse:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -2612,10 +2352,6 @@ components:
|
|||||||
type: array
|
type: array
|
||||||
items:
|
items:
|
||||||
$ref: "#/components/schemas/postPhoneEntity"
|
$ref: "#/components/schemas/postPhoneEntity"
|
||||||
devices:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: "#/components/schemas/devicePostEntity"
|
|
||||||
postCustomerAddress:
|
postCustomerAddress:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
@ -2802,7 +2538,7 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
replacedByTokenId:
|
replacedByTokenId:
|
||||||
type: integer
|
type: integer
|
||||||
ovChipCardEntity:
|
ovChipcardEntity:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
ovChipCardId:
|
ovChipCardId:
|
||||||
@ -2842,38 +2578,6 @@ components:
|
|||||||
ovPayTokenId:
|
ovPayTokenId:
|
||||||
type: integer
|
type: integer
|
||||||
example: 1
|
example: 1
|
||||||
getDevicesResponse:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
devices:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: "#/components/schemas/getDeviceEntity"
|
|
||||||
getDeviceEntity:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
deviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
customerProfileId:
|
|
||||||
type: integer
|
|
||||||
externalDeviceId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
alias:
|
|
||||||
type: string
|
|
||||||
required:
|
|
||||||
- deviceId
|
|
||||||
- customerProfileId
|
|
||||||
- externalDeviceId
|
|
||||||
- alias
|
|
||||||
postCustomerDevice:
|
|
||||||
$ref: "#/components/schemas/devicePostEntity"
|
|
||||||
patchCustomerDevice:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
alias:
|
|
||||||
type: string
|
|
||||||
ErrorResponse:
|
ErrorResponse:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
File diff suppressed because it is too large
Load Diff
@ -657,8 +657,8 @@ paths:
|
|||||||
status: failed
|
status: failed
|
||||||
description: Validation XYZ failed.
|
description: Validation XYZ failed.
|
||||||
correlationId: null
|
correlationId: null
|
||||||
List containing multiple transaction audit trails of one transaction item:
|
? List containing multiple transaction audit trails of one transaction item
|
||||||
summary: List containing multiple audit trails of one transaction item
|
: summary: List containing multiple audit trails of one transaction item
|
||||||
description: List containing multiple audit trail records of one transaction item (with id `d667d293-aa82-4c9e-9b10-77cffc9058a1`).
|
description: List containing multiple audit trail records of one transaction item (with id `d667d293-aa82-4c9e-9b10-77cffc9058a1`).
|
||||||
value:
|
value:
|
||||||
"@odata.context": "$metadata#TransactionAuditTrail"
|
"@odata.context": "$metadata#TransactionAuditTrail"
|
||||||
@ -703,8 +703,8 @@ paths:
|
|||||||
status: created
|
status: created
|
||||||
description: Transaction created.
|
description: Transaction created.
|
||||||
correlationId: null
|
correlationId: null
|
||||||
List containing multiple audit trails of different failed transactions:
|
? List containing multiple audit trails of different failed transactions
|
||||||
summary: List containing multiple audit trails of different failed transactions
|
: summary: List containing multiple audit trails of different failed transactions
|
||||||
description: List containing multiple audit trails of different failed transactions (status = failed).
|
description: List containing multiple audit trails of different failed transactions (status = failed).
|
||||||
value:
|
value:
|
||||||
"@odata.context": "$metadata#TransactionAuditTrail"
|
"@odata.context": "$metadata#TransactionAuditTrail"
|
||||||
@ -2979,164 +2979,6 @@ paths:
|
|||||||
- default: []
|
- default: []
|
||||||
x-auth-type: Application & Application User
|
x-auth-type: Application & Application User
|
||||||
x-throttling-tier: Unlimited
|
x-throttling-tier: Unlimited
|
||||||
/transactionitems/reject:
|
|
||||||
post:
|
|
||||||
summary: Reject transaction items to source in bulk.
|
|
||||||
description: Reject transaction items to source in bulk.
|
|
||||||
tags:
|
|
||||||
- Bulk processing v2.2
|
|
||||||
requestBody:
|
|
||||||
required: true
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/TransactionItemsBulkRequestBody"
|
|
||||||
examples:
|
|
||||||
List of transaction item ids to reject:
|
|
||||||
summary: List of transaction item ids to reject to source
|
|
||||||
description: List of transaction item ids to reject to source.
|
|
||||||
value:
|
|
||||||
transactionItemIds:
|
|
||||||
- afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
|
||||||
- b1c4f8e7-3f4e-4d2a-9c6e-2f5e6d7c8b9a
|
|
||||||
- c2d5e6f7-4g5h-5i6j-0k1l-3m4n5o6p7q8r
|
|
||||||
responses:
|
|
||||||
"202":
|
|
||||||
description: Accepted
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/TransactionItemsPostResponseBody"
|
|
||||||
examples:
|
|
||||||
Array of transaction items accepted:
|
|
||||||
summary: Array of transaction item ids accepted
|
|
||||||
description: |
|
|
||||||
The array of transaction item ids was accepted successfully.
|
|
||||||
The transaction items 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/transactionitems/reject/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
|
||||||
retryAfter: 10
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
/transactionitems/responsestatus/reject/{clientTrackingId}:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Bulk processing v2.2
|
|
||||||
summary: Get the status of the transaction item bulk reject.
|
|
||||||
description: Get the status of the asynchronous transaction item bulk reject.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: clientTrackingId
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: The clientTrackingId of the transaction item bulk reject.
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/TransactionItemsRejectResponseStatusGetResponseBody"
|
|
||||||
examples:
|
|
||||||
Batch successfully processed:
|
|
||||||
summary: Batch successfully processed
|
|
||||||
description: |
|
|
||||||
Body of a batch of transaction items that was successfully rejected.
|
|
||||||
A number of transaction items were rejected.
|
|
||||||
value:
|
|
||||||
summary:
|
|
||||||
rejected: 15
|
|
||||||
total: 15
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
/transactionitems/return:
|
|
||||||
post:
|
|
||||||
summary: Return transaction items to trx db in bulk.
|
|
||||||
description: Return transaction items to trx db in bulk.
|
|
||||||
tags:
|
|
||||||
- Bulk processing v2.2
|
|
||||||
requestBody:
|
|
||||||
required: true
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/TransactionItemsBulkRequestBody"
|
|
||||||
examples:
|
|
||||||
List of transaction item ids to reject:
|
|
||||||
summary: List of transaction item ids to return to trx db
|
|
||||||
description: List of transaction item ids to return to trx db.
|
|
||||||
value:
|
|
||||||
transactionItemIds:
|
|
||||||
- afce35b2-1dff-4ace-98d0-4b9ac405c87d
|
|
||||||
- b1c4f8e7-3f4e-4d2a-9c6e-2f5e6d7c8b9a
|
|
||||||
- c2d5e6f7-4g5h-5i6j-0k1l-3m4n5o6p7q8r
|
|
||||||
responses:
|
|
||||||
"202":
|
|
||||||
description: Accepted
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/TransactionItemsPostResponseBody"
|
|
||||||
examples:
|
|
||||||
Array of transaction items accepted:
|
|
||||||
summary: Array of transaction item ids accepted
|
|
||||||
description: |
|
|
||||||
The array of transaction item ids was accepted successfully.
|
|
||||||
The transaction items 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/transactionitems/return/responsestatus/runtime/webhooks/workflow/scaleUnits/prod-00/workflows/6fd466916c
|
|
||||||
retryAfter: 10
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
/transactionitems/responsestatus/return/{clientTrackingId}:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- Bulk processing v2.2
|
|
||||||
summary: Get the status of the transaction item bulk return.
|
|
||||||
description: Get the status of the asynchronous transaction item bulk return.
|
|
||||||
parameters:
|
|
||||||
- in: path
|
|
||||||
name: clientTrackingId
|
|
||||||
schema:
|
|
||||||
type: string
|
|
||||||
required: true
|
|
||||||
description: The clientTrackingId of the transaction item bulk return.
|
|
||||||
responses:
|
|
||||||
"200":
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: "#/components/schemas/TransactionItemsReturnResponseStatusGetResponseBody"
|
|
||||||
examples:
|
|
||||||
Batch successfully processed:
|
|
||||||
summary: Batch successfully processed
|
|
||||||
description: |
|
|
||||||
Body of a batch of transaction items that was successfully returned to trx db.
|
|
||||||
A number of transaction items were returned to trx db.
|
|
||||||
value:
|
|
||||||
summary:
|
|
||||||
returned: 15
|
|
||||||
total: 15
|
|
||||||
security:
|
|
||||||
- default: []
|
|
||||||
x-auth-type: Application & Application User
|
|
||||||
x-throttling-tier: Unlimited
|
|
||||||
components:
|
components:
|
||||||
securitySchemes:
|
securitySchemes:
|
||||||
default:
|
default:
|
||||||
@ -4959,51 +4801,6 @@ components:
|
|||||||
transactionLineId:
|
transactionLineId:
|
||||||
type: string
|
type: string
|
||||||
example: fee907dd-e59d-44f5-a63b-bbdec38f79b7
|
example: fee907dd-e59d-44f5-a63b-bbdec38f79b7
|
||||||
TransactionItemsBulkRequestBody:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
transactionItemIds:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 1ad109d3-fd7d-4b6f-872b-220d492f385f
|
|
||||||
required:
|
|
||||||
- transactionItemIds
|
|
||||||
TransactionItemsRejectResponseStatusGetResponseBody:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
summary:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
rejected:
|
|
||||||
type: integer
|
|
||||||
example: 3
|
|
||||||
total:
|
|
||||||
type: integer
|
|
||||||
example: 3
|
|
||||||
required:
|
|
||||||
- rejected
|
|
||||||
- total
|
|
||||||
required:
|
|
||||||
- summary
|
|
||||||
TransactionItemsReturnResponseStatusGetResponseBody:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
summary:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
returned:
|
|
||||||
type: integer
|
|
||||||
example: 3
|
|
||||||
total:
|
|
||||||
type: integer
|
|
||||||
example: 3
|
|
||||||
required:
|
|
||||||
- returned
|
|
||||||
- total
|
|
||||||
required:
|
|
||||||
- summary
|
|
||||||
rfc9457:
|
rfc9457:
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user