develop #38
@ -4,7 +4,6 @@ info:
|
|||||||
version: '1.0'
|
version: '1.0'
|
||||||
servers:
|
servers:
|
||||||
- url: https://services.acc.api.htm.nl/chipkaart/1.0
|
- url: https://services.acc.api.htm.nl/chipkaart/1.0
|
||||||
- url: http://services.acc.api.htm.nl/chipkaart/1.0
|
|
||||||
security:
|
security:
|
||||||
- default: []
|
- default: []
|
||||||
tags:
|
tags:
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: CRUD APIs for ABT Contract database. These are NOT the functional APIs from Service Engine.
|
description: CRUD APIs for ABT Contract database. These are NOT the functional APIs from Service Engine.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v1
|
- url: https://services.acc.api.htm.nl/abt/abtcontracts/1.0
|
||||||
paths:
|
paths:
|
||||||
/customers/{customerNumber}/contracts:
|
/customers/{customerNumber}/contracts:
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub.
|
description: Service Engine APIs for ABT Contracts v2. These are NOT the CRUD APIs to the data hub.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/touchpoint/1.0
|
- url: https://services.acc.api.htm.nl/abt/touchpoint/1.0
|
||||||
paths:
|
paths:
|
||||||
/customers/contracts:
|
/customers/contracts:
|
||||||
parameters:
|
parameters:
|
||||||
|
|||||||
@ -6,7 +6,7 @@ info:
|
|||||||
To be used by touchpoints to get information about HTM customers.
|
To be used by touchpoints to get information about HTM customers.
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v1/touchpoint
|
- url: https://services.acc.api.htm.nl/abt/touchpoint/1.0
|
||||||
tags:
|
tags:
|
||||||
- name: Customers
|
- name: Customers
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "2.0"
|
version: "2.0"
|
||||||
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
|
description: CRUD APIs for ABT Customer database. These are NOT the functional APIs from Service Engine.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/abtcustomers/2.0
|
- url: https://services.acc.api.htm.nl/abt/abtcustomers/2.0
|
||||||
paths:
|
paths:
|
||||||
/customers:
|
/customers:
|
||||||
get:
|
get:
|
||||||
|
|||||||
@ -4,7 +4,6 @@ info:
|
|||||||
version: '1.0'
|
version: '1.0'
|
||||||
servers:
|
servers:
|
||||||
- url: https://services.acc.api.htm.nl/abt/abtcustomers/1.0
|
- url: https://services.acc.api.htm.nl/abt/abtcustomers/1.0
|
||||||
- url: http://services.acc.api.htm.nl/abt/abtcustomers/1.0
|
|
||||||
security:
|
security:
|
||||||
- default: []
|
- default: []
|
||||||
tags:
|
tags:
|
||||||
|
|||||||
@ -3,8 +3,7 @@ info:
|
|||||||
title: ABTCustomerReference
|
title: ABTCustomerReference
|
||||||
version: '1.0'
|
version: '1.0'
|
||||||
servers:
|
servers:
|
||||||
- url: https://services.dev.api.htm.nl/abt/customerreference/1.0
|
- url: https://services.acc.api.htm.nl/abt/customerreference/1.0
|
||||||
- url: http://services.dev.api.htm.nl/abt/customerreference/1.0
|
|
||||||
security:
|
security:
|
||||||
- default: []
|
- default: []
|
||||||
tags:
|
tags:
|
||||||
|
|||||||
@ -6,7 +6,7 @@ info:
|
|||||||
CRUD APIs for FIKO resource model v2.2. This version of the API corresponds with version 2.2
|
CRUD APIs for FIKO resource model v2.2. This version of the API corresponds with version 2.2
|
||||||
of the data model in [Lucid Chart](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?page=LL7PJg1Y_GOA>).
|
of the data model in [Lucid Chart](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?page=LL7PJg1Y_GOA>).
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/fiko/1.0
|
- url: https://services.acc.api.htm.nl/fiko/1.0
|
||||||
paths:
|
paths:
|
||||||
/Odata/TransactionItem:
|
/Odata/TransactionItem:
|
||||||
get:
|
get:
|
||||||
|
|||||||
@ -1,381 +0,0 @@
|
|||||||
openapi: 3.0.1
|
|
||||||
info:
|
|
||||||
title: ABTFikoReference
|
|
||||||
description: |-
|
|
||||||
CRUD APIs for FIKO reference data (based on the v1 model for FIKO, see [the FIKO v1 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=145%2C-316%2C2782%2C1418%2C0_0&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)). This means that, for now, only GET endpoints on `TaxMetadata` and `ProductGroupMetadata` (already named `ProductMetadata` to avoid rework for v2) are available.
|
|
||||||
|
|
||||||
When the v2 model for FIKO is implemented (see [the FIKO v2 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=-72%2C-954%2C2406%2C1226%2CUnjZp4g0O~CK&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)), POST/PUT/DELETE for these tables (as well as CRUD for additional tables) will become available, to support populating the reference tables with Unit4Financials data.
|
|
||||||
|
|
||||||
These are NOT functional API's to be published by the Service Engine, but are direct CRUD API's on top of the database.
|
|
||||||
version: '1.0'
|
|
||||||
servers:
|
|
||||||
- url: https://api.integratielaag.nl/abt/fikoreference/1.0
|
|
||||||
tags:
|
|
||||||
- name: ABTFikoReference CRUD v1
|
|
||||||
description: >-
|
|
||||||
CRUD APIs for FIKO reference data (based on the v1 model for FIKO, see [the FIKO v1 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=145%2C-316%2C2782%2C1418%2C0_0&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)).
|
|
||||||
- name: ABTFikoReference CRUD v2
|
|
||||||
description: >-
|
|
||||||
CRUD APIs for FIKO reference data (based on the v2 model for FIKO, see [the FIKO v2 datamodel in Lucid](https://lucid.app/lucidchart/50c0ff9d-48ba-4ea9-8182-10bede07d3b1/edit?viewport_loc=-72%2C-954%2C2406%2C1226%2CUnjZp4g0O~CK&invitationId=inv_1cd35e35-77f5-4e31-87d6-32fd74400350)).
|
|
||||||
|
|
||||||
paths:
|
|
||||||
/taxmetadata:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- ABTFikoReference CRUD v1
|
|
||||||
summary: Get a list of all possible values of the "TaxMetadata" reference table. Mainly used for populating dropdown lists (in PMT for example).
|
|
||||||
description: |-
|
|
||||||
Get a list of all possible values of the `TaxMetadata` reference table. Mainly used for populating dropdown lists (in PMT for example).\
|
|
||||||
The attributes `validFrom` and `validUntil` are not yet present in the FIKO v1 datamodel, but are already included in this resourcemodel; to prevent rework in the near future.\
|
|
||||||
For now, for `validFrom`, the value will always be returned as `2024-01-01T00:00:00.000+00:00` and for `validUntil` it will always be `null`.
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/TaxMetadataListResponse'
|
|
||||||
examples:
|
|
||||||
getListTaxMetadataSales:
|
|
||||||
summary: List containing three TaxMetadata entries, used for sales tax
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"Entries": [
|
|
||||||
{
|
|
||||||
"taxMetadataId": "61A148AF-6DCB-4BB6-9D3F-17A8B627F745",
|
|
||||||
"taxCode": "V21",
|
|
||||||
"taxPercentageAmount": 21,
|
|
||||||
"description": "BTW VERKOOP HOOG 21%",
|
|
||||||
"validFrom": "2024-01-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85",
|
|
||||||
"taxCode": "V09",
|
|
||||||
"taxPercentageAmount": 9,
|
|
||||||
"description": "BTW VERKOOP LAAG 9%",
|
|
||||||
"validFrom": "2024-01-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"taxMetadataId": "AC20A838-C81B-4652-96EA-F6E79E696E9C",
|
|
||||||
"taxCode": "V0",
|
|
||||||
"taxPercentageAmount": 0,
|
|
||||||
"description": "BTW VERKOOP NUL",
|
|
||||||
"validFrom": "2024-01-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": null
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
getListTaxMetadataSalesAndPurchase:
|
|
||||||
summary: List containing x TaxMetadata entries, used for sales and purchase tax
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"Entries": [
|
|
||||||
{
|
|
||||||
"taxMetadataId": "61A148AF-6DCB-4BB6-9D3F-17A8B627F745",
|
|
||||||
"taxCode": "V21",
|
|
||||||
"taxPercentageAmount": 21,
|
|
||||||
"description": "BTW VERKOOP HOOG 21%",
|
|
||||||
"validFrom": "2024-01-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"taxMetadataId": "47C8972E-A730-4032-9BDA-AF0A5BCB2C85",
|
|
||||||
"taxCode": "V09",
|
|
||||||
"taxPercentageAmount": 9,
|
|
||||||
"description": "BTW VERKOOP LAAG 9%",
|
|
||||||
"validFrom": "2024-01-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"taxMetadataId": "AC20A838-C81B-4652-96EA-F6E79E696E9C",
|
|
||||||
"taxCode": "V0",
|
|
||||||
"taxPercentageAmount": 0,
|
|
||||||
"description": "BTW VERKOOP NUL",
|
|
||||||
"validFrom": "2024-01-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": null
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"TBD": "TBD"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"TBD": "TBD"
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"TBD": "TBD"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
'400':
|
|
||||||
description: '400'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/400Response'
|
|
||||||
'401':
|
|
||||||
description: '401'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/401Response'
|
|
||||||
'404':
|
|
||||||
description: '404'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/404Response'
|
|
||||||
'500':
|
|
||||||
description: '500'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/500Response'
|
|
||||||
/productmetadata:
|
|
||||||
get:
|
|
||||||
tags:
|
|
||||||
- ABTFikoReference CRUD v1
|
|
||||||
summary: Get a list of all possible values of the "ProductMetadata" reference table. Mainly used for populating dropdown lists (in PMT for example).
|
|
||||||
description: |-
|
|
||||||
Get a list of all possible values of the `ProductGroupMetadata` (soon to be renamed to `ProductMetadata`) reference table. Mainly used for populating dropdown lists (in PMT for example).\
|
|
||||||
The name of the entity is `ProductGroupMetadata` in the FIKO v1 datamodel, but the resourcemodel already uses the name `ProductMetadata`, as will be the name from FIKO v2 onwards.\
|
|
||||||
This also applies to the attributes `productMetadataId` (still called `ProductGroupMetadataId` in FIKO v1), `productCode` (still called `productGroupCode` in FIKO v1) and `user` (present in FIKO v1, but removed in FIKO v2, so also in this resourcemodel).
|
|
||||||
responses:
|
|
||||||
'200':
|
|
||||||
description: OK
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/ProductMetadataListResponse'
|
|
||||||
examples:
|
|
||||||
getListProductMetadata:
|
|
||||||
summary: List containing one ProductMetadata entry, used for testing purposes
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"Entries": [
|
|
||||||
{
|
|
||||||
"productMetadataId": "501B17EF-36C4-4039-B92C-6517969B464E",
|
|
||||||
"productCode": "PG001",
|
|
||||||
"department": "Electronics",
|
|
||||||
"costCenter": "CC101",
|
|
||||||
"costType": "TypeA",
|
|
||||||
"description": "Group for electronic products",
|
|
||||||
"documentCode": "DOC001",
|
|
||||||
"timestampUpdated": "2024-09-03T15:07:53.470+00:00",
|
|
||||||
"validFrom": "2024-08-01T00:00:00.000+00:00",
|
|
||||||
"validUntil": "2025-08-01T00:00:00.000+00:00"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
}
|
|
||||||
'400':
|
|
||||||
description: '400'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/400Response'
|
|
||||||
'401':
|
|
||||||
description: '401'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/401Response'
|
|
||||||
'404':
|
|
||||||
description: '404'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/404Response'
|
|
||||||
'500':
|
|
||||||
description: '500'
|
|
||||||
content:
|
|
||||||
application/json:
|
|
||||||
schema:
|
|
||||||
$ref: '#/components/schemas/500Response'
|
|
||||||
|
|
||||||
components:
|
|
||||||
schemas:
|
|
||||||
TaxMetadataListResponse:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- Entries
|
|
||||||
properties:
|
|
||||||
Entries:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/TaxMetadataResponse'
|
|
||||||
ProductMetadataListResponse:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- Entries
|
|
||||||
properties:
|
|
||||||
Entries:
|
|
||||||
type: array
|
|
||||||
items:
|
|
||||||
$ref: '#/components/schemas/ProductMetadataResponse'
|
|
||||||
TaxMetadataResponse:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- taxMetadataId
|
|
||||||
- taxCode
|
|
||||||
- taxPercentageAmount
|
|
||||||
- validFrom
|
|
||||||
properties:
|
|
||||||
taxMetadataId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 501B17EF-36C4-4039-B92C-6517969B464E
|
|
||||||
taxCode:
|
|
||||||
type: string
|
|
||||||
example: V09
|
|
||||||
taxPercentageAmount:
|
|
||||||
type: integer
|
|
||||||
example: 21
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
example: BTW VERKOOP LAAG 9%
|
|
||||||
validFrom:
|
|
||||||
type: string
|
|
||||||
format: date-time-offset
|
|
||||||
example: '2024-09-03T10:01:34.000+00:00'
|
|
||||||
validUntil:
|
|
||||||
type: string
|
|
||||||
format: date-time-offset
|
|
||||||
example: '2024-09-03T10:01:34.000+00:00'
|
|
||||||
ProductMetadataResponse:
|
|
||||||
type: object
|
|
||||||
required:
|
|
||||||
- productMetadataId
|
|
||||||
- productCode
|
|
||||||
- department
|
|
||||||
- costCenter
|
|
||||||
- costType
|
|
||||||
- description
|
|
||||||
- documentCode
|
|
||||||
- timestampUpdated
|
|
||||||
- validFrom
|
|
||||||
properties:
|
|
||||||
productMetadataId:
|
|
||||||
type: string
|
|
||||||
format: uuid
|
|
||||||
example: 501B17EF-36C4-4039-B92C-6517969B464E
|
|
||||||
productCode:
|
|
||||||
type: string
|
|
||||||
description: Called "artikelnr" in U4F
|
|
||||||
example: TBD
|
|
||||||
department:
|
|
||||||
type: string
|
|
||||||
description: Called "element 1" in U4F
|
|
||||||
example: TBD
|
|
||||||
costCenter:
|
|
||||||
type: string
|
|
||||||
description: Called "element 3" in U4F
|
|
||||||
example: TBD
|
|
||||||
costType:
|
|
||||||
type: string
|
|
||||||
description: Called "element 2" in U4F
|
|
||||||
example: TBD
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
example: TBD
|
|
||||||
documentCode:
|
|
||||||
type: string
|
|
||||||
example: TBD
|
|
||||||
timestampUpdated:
|
|
||||||
type: string
|
|
||||||
format: date-time-offset
|
|
||||||
example: '2024-09-03T10:01:34.000+00:00'
|
|
||||||
validFrom:
|
|
||||||
type: string
|
|
||||||
format: date-time-offset
|
|
||||||
example: '2024-09-03T10:01:34.000+00:00'
|
|
||||||
validUntil:
|
|
||||||
type: string
|
|
||||||
format: date-time-offset
|
|
||||||
example: '2024-09-03T10:01:34.000+00:00'
|
|
||||||
400Response:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: string
|
|
||||||
example: '400'
|
|
||||||
type:
|
|
||||||
type: string
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
example: Bad Request
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
example: '''2023-02-01 00:00:00'' is not a valid Datetime'
|
|
||||||
apiErrorCode:
|
|
||||||
type: string
|
|
||||||
example: htm.api.err.40xxx
|
|
||||||
401Response:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: string
|
|
||||||
example: '900901'
|
|
||||||
type:
|
|
||||||
type: string
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
example: Invalid Credentials
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
example: >-
|
|
||||||
Invalid Credentials. Make sure you have provided the correct
|
|
||||||
security credentials
|
|
||||||
apiErrorCode:
|
|
||||||
type: string
|
|
||||||
example: htm.api.err.40xxx
|
|
||||||
403Response:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: string
|
|
||||||
example: '900901'
|
|
||||||
type:
|
|
||||||
type: string
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
example: Retailer not authorized
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
example: The retailer is not allowed to access resource for requested
|
|
||||||
apiErrorCode:
|
|
||||||
type: string
|
|
||||||
example: htm.api.err.40xxx touchpoint
|
|
||||||
404Response:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: string
|
|
||||||
example: '404'
|
|
||||||
type:
|
|
||||||
type: string
|
|
||||||
example: Status report
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
example: Not Found
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
example: The requested resource is not available.
|
|
||||||
apiErrorCode:
|
|
||||||
type: string
|
|
||||||
example: htm.api.err.40xxx
|
|
||||||
500Response:
|
|
||||||
type: object
|
|
||||||
properties:
|
|
||||||
code:
|
|
||||||
type: string
|
|
||||||
example: '500'
|
|
||||||
type:
|
|
||||||
type: string
|
|
||||||
message:
|
|
||||||
type: string
|
|
||||||
example: Internal Server Error
|
|
||||||
description:
|
|
||||||
type: string
|
|
||||||
apiErrorCode:
|
|
||||||
type: string
|
|
||||||
example: htm.api.err.40xxx
|
|
||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: Order APIs available in the Service Engine for order validation and fulfillment.
|
description: Order APIs available in the Service Engine for order validation and fulfillment.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/abtserviceengine/1.0
|
- url: https://services.acc.api.htm.nl/abt/touchpoint/2.0
|
||||||
paths:
|
paths:
|
||||||
/orders/validation/gboAgeProfile:
|
/orders/validation/gboAgeProfile:
|
||||||
get:
|
get:
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine.
|
description: CRUD APIs for ABT Orders database. These are NOT the functional APIs from Service Engine.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v1
|
- url: https://services.acc.api.htm.nl/abt/abtorder/1.0
|
||||||
paths:
|
paths:
|
||||||
/orders:
|
/orders:
|
||||||
get:
|
get:
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: Order APIs available in the Service Engine for order validation and fulfillment.
|
description: Order APIs available in the Service Engine for order validation and fulfillment.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v2
|
- url: https://services.acc.api.htm.nl/abt/touchpoint/2.0
|
||||||
paths:
|
paths:
|
||||||
/orders/validation:
|
/orders/validation:
|
||||||
post:
|
post:
|
||||||
|
|||||||
760
src/openapi/pad/padp-poc-openapi.yaml
Normal file
760
src/openapi/pad/padp-poc-openapi.yaml
Normal file
@ -0,0 +1,760 @@
|
|||||||
|
openapi: 3.0.1
|
||||||
|
info:
|
||||||
|
title: PadpReferenceApi
|
||||||
|
version: '1.0'
|
||||||
|
paths:
|
||||||
|
/poc/encrypt-decrypt-poc:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Encrypt/decrypt POC
|
||||||
|
summary: Encrypt/Decrypt POC
|
||||||
|
operationId: EncryptDecryptPoc
|
||||||
|
parameters:
|
||||||
|
- name: textToEncrypt
|
||||||
|
in: header
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: encryptedEphemeralKey
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
text/plain:
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
/poc/encrypt-poc:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Encrypt/decrypt POC
|
||||||
|
summary: Encrypt POC
|
||||||
|
operationId: EncryptPoc
|
||||||
|
parameters:
|
||||||
|
- name: textToEncrypt
|
||||||
|
in: header
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: encryptedEphemeralKey
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
text/plain:
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
/poc/decrypt-poc:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- Encrypt/decrypt POC
|
||||||
|
summary: Decrypt POC
|
||||||
|
operationId: DecryptPoc
|
||||||
|
parameters:
|
||||||
|
- name: textToDecrypt
|
||||||
|
in: header
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: encryptedEphemeralKey
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
text/plain:
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
/idp/b2b-access-token:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1020 - Get B2B Access Token
|
||||||
|
description: Returns a client access token, needed for most other PADP APIs.
|
||||||
|
operationId: GetB2bAccessToken
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/B2bAccessToken'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
/get-image-from-base64:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: Get rendered image from Base64 encoded String
|
||||||
|
operationId: GetImageFromBase64
|
||||||
|
parameters:
|
||||||
|
- name: base64String
|
||||||
|
in: header
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
image/jpeg:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/FileContentHttpResult'
|
||||||
|
/personal-data/{xtat}:
|
||||||
|
post:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1201 - Create Personal Data - First create an ephemeral key using API 1210!
|
||||||
|
description: First create an ephemeral key using API 1210!
|
||||||
|
operationId: CreatePersonalData
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: email
|
||||||
|
in: query
|
||||||
|
description: Email address to be used for OTP challenges
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: name
|
||||||
|
in: query
|
||||||
|
description: Should be at least two words (first name and last name)
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: birthDate
|
||||||
|
in: query
|
||||||
|
description: Should be a date between 1900-01-01 and now, in the format YYYY-MM-DD
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
multipart/form-data:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
photo:
|
||||||
|
type: string
|
||||||
|
description: Should be a JPG image, of max. 512KB and resolution between 520x520 and 720x720
|
||||||
|
format: binary
|
||||||
|
encoding:
|
||||||
|
photo:
|
||||||
|
style: form
|
||||||
|
responses:
|
||||||
|
'201':
|
||||||
|
description: Created
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1202 - Get Personal Data- First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
description: First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
operationId: GetPersonalData
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/PersonalData'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
delete:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1204 - Delete Personal Data - First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
description: First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
operationId: DeletePersonalData
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/DeletePersonalDataResponse'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
put:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1205 - Update Personal Data - First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
description: First perform an OTP challenge using API 1206 and 1207!Performs a complete replacement; empty request parameters will result in the corresponding PADP attribute being deleted.
|
||||||
|
operationId: UpdatePersonalData
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: skipUpdateCounter
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: boolean
|
||||||
|
- name: name
|
||||||
|
in: query
|
||||||
|
description: Should be at least two words (first name and last name)
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: birthDate
|
||||||
|
in: query
|
||||||
|
description: Should be a date between 1900-01-01 and now, in the format YYYY-MM-DD
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
requestBody:
|
||||||
|
content:
|
||||||
|
multipart/form-data:
|
||||||
|
schema:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
photo:
|
||||||
|
type: string
|
||||||
|
description: Should be a JPG image, of max. 512KB and resolution between 520x520 and 720x720
|
||||||
|
format: binary
|
||||||
|
encoding:
|
||||||
|
photo:
|
||||||
|
style: form
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
/personal-data/{xtat}/decrypted:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1202 - Get Personal Data AND decrypt response - First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
description: First perform an OTP challenge using API 1206 and 1207!
|
||||||
|
operationId: GetDecryptedPersonalData
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/DecryptedPersonalData'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
/personal-data/{xtat}/generate-otp:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1206 - Generate OTP
|
||||||
|
operationId: GenerateOtp
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/OtpResponse'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
/personal-data/{xtat}/validate-otp:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1207 - Validate OTP
|
||||||
|
operationId: ValidateOtp
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
- name: otp
|
||||||
|
in: query
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/UserAccessToken'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
/personal-data/{xtat}/encrypted-update-init:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1210 - Create Ephemeral Key
|
||||||
|
operationId: CreateEphemeralKey
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/EphemeralKey'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
/personal-data/{xtat}/administrative-data:
|
||||||
|
get:
|
||||||
|
tags:
|
||||||
|
- PADP Reference API
|
||||||
|
summary: API 1211 - Get Administrative Data
|
||||||
|
operationId: GetAdministrativeData
|
||||||
|
parameters:
|
||||||
|
- name: xtat
|
||||||
|
in: path
|
||||||
|
required: true
|
||||||
|
schema:
|
||||||
|
type: string
|
||||||
|
responses:
|
||||||
|
'200':
|
||||||
|
description: OK
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/AdministrativeData'
|
||||||
|
'400':
|
||||||
|
description: Bad Request
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'404':
|
||||||
|
description: Not Found
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
'500':
|
||||||
|
description: Internal Server Error
|
||||||
|
content:
|
||||||
|
application/json:
|
||||||
|
schema:
|
||||||
|
$ref: '#/components/schemas/ErrorResponse'
|
||||||
|
components:
|
||||||
|
schemas:
|
||||||
|
AdministrativeData:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
$ref: '#/components/schemas/AdministrativeDataElement'
|
||||||
|
photo:
|
||||||
|
$ref: '#/components/schemas/AdministrativeDataElement'
|
||||||
|
birthdate:
|
||||||
|
$ref: '#/components/schemas/AdministrativeDataElement'
|
||||||
|
additionalProperties: false
|
||||||
|
AdministrativeDataElement:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
inaccuracyFlag:
|
||||||
|
type: boolean
|
||||||
|
inaccuracyFlagReason:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
inaccuracyFlagCounter:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
changeCounter:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
maxUpdatesVerificationCount:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
lastChangeDate:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
isValidated:
|
||||||
|
type: boolean
|
||||||
|
additionalProperties: false
|
||||||
|
B2bAccessToken:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
access_token:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
expires_in:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
refresh_expires_in:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
refresh_token:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
token_type:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
not-before-policy:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
scope:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
BE_ID:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
ByteReadOnlyMemory:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
length:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
readOnly: true
|
||||||
|
isEmpty:
|
||||||
|
type: boolean
|
||||||
|
readOnly: true
|
||||||
|
span:
|
||||||
|
$ref: '#/components/schemas/ByteReadOnlySpan'
|
||||||
|
additionalProperties: false
|
||||||
|
ByteReadOnlySpan:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
length:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
readOnly: true
|
||||||
|
isEmpty:
|
||||||
|
type: boolean
|
||||||
|
readOnly: true
|
||||||
|
additionalProperties: false
|
||||||
|
Data:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
name:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
birthdate:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
photo:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
DecryptedData:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
decryptedName:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
decryptedBirthdate:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
decryptedPhoto:
|
||||||
|
type: string
|
||||||
|
description: Base64 encoded photo
|
||||||
|
format: byte
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
DecryptedPersonalData:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
decryptedData:
|
||||||
|
$ref: '#/components/schemas/DecryptedData'
|
||||||
|
encryptedData:
|
||||||
|
$ref: '#/components/schemas/PersonalData'
|
||||||
|
additionalProperties: false
|
||||||
|
DeletePersonalDataResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
deletedAttributes:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
EntityTagHeaderValue:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
tag:
|
||||||
|
$ref: '#/components/schemas/StringSegment'
|
||||||
|
isWeak:
|
||||||
|
type: boolean
|
||||||
|
readOnly: true
|
||||||
|
additionalProperties: false
|
||||||
|
EphemeralKey:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
ephemeralKeyAlias:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
encryptedEphemeralKey:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
Error:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
code:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
data:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
message:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
ErrorResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
errors:
|
||||||
|
type: array
|
||||||
|
items:
|
||||||
|
$ref: '#/components/schemas/Error'
|
||||||
|
nullable: true
|
||||||
|
exceptionClassName:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
exceptionStackTrace:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
FileContentHttpResult:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
contentType:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
readOnly: true
|
||||||
|
fileDownloadName:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
readOnly: true
|
||||||
|
lastModified:
|
||||||
|
type: string
|
||||||
|
format: date-time
|
||||||
|
nullable: true
|
||||||
|
readOnly: true
|
||||||
|
entityTag:
|
||||||
|
$ref: '#/components/schemas/EntityTagHeaderValue'
|
||||||
|
enableRangeProcessing:
|
||||||
|
type: boolean
|
||||||
|
readOnly: true
|
||||||
|
fileLength:
|
||||||
|
type: integer
|
||||||
|
format: int64
|
||||||
|
nullable: true
|
||||||
|
readOnly: true
|
||||||
|
fileContents:
|
||||||
|
$ref: '#/components/schemas/ByteReadOnlyMemory'
|
||||||
|
additionalProperties: false
|
||||||
|
Metadata:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
encryptedEphemeralKey:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
OtpResponse:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
maskedEmailAddress:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
|
PersonalData:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
metadata:
|
||||||
|
$ref: '#/components/schemas/Metadata'
|
||||||
|
data:
|
||||||
|
$ref: '#/components/schemas/Data'
|
||||||
|
additionalProperties: false
|
||||||
|
StringSegment:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
buffer:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
offset:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
readOnly: true
|
||||||
|
length:
|
||||||
|
type: integer
|
||||||
|
format: int32
|
||||||
|
readOnly: true
|
||||||
|
value:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
readOnly: true
|
||||||
|
hasValue:
|
||||||
|
type: boolean
|
||||||
|
readOnly: true
|
||||||
|
additionalProperties: false
|
||||||
|
UserAccessToken:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
accessToken:
|
||||||
|
type: string
|
||||||
|
nullable: true
|
||||||
|
additionalProperties: false
|
||||||
@ -6,7 +6,7 @@ info:
|
|||||||
To be used by touchpoints to get information about HTM products they are allowed to see and/or sell.
|
To be used by touchpoints to get information about HTM products they are allowed to see and/or sell.
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/abtserviceengine/1.0
|
- url: https://services.acc.api.htm.nl/abt/touchpoint/1.0
|
||||||
tags:
|
tags:
|
||||||
- name: ServiceEngine Products
|
- name: ServiceEngine Products
|
||||||
description: |-
|
description: |-
|
||||||
|
|||||||
@ -6,7 +6,7 @@ info:
|
|||||||
To be used by touchpoints to get information about HTM products they are allowed to see and/or sell.
|
To be used by touchpoints to get information about HTM products they are allowed to see and/or sell.
|
||||||
version: "1.0"
|
version: "1.0"
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/touchpoint/1.0
|
- url: https://services.acc.api.htm.nl/abt/touchpoint/1.0
|
||||||
tags:
|
tags:
|
||||||
- name: ServiceEngine Products
|
- name: ServiceEngine Products
|
||||||
description: |-
|
description: |-
|
||||||
|
|||||||
@ -7,7 +7,7 @@ info:
|
|||||||
Service Engine, using a different endpoint.
|
Service Engine, using a different endpoint.
|
||||||
version: '1.0'
|
version: '1.0'
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/productreference/1.0
|
- url: https://services.acc.api.htm.nl/abt/productreference/1.0
|
||||||
tags:
|
tags:
|
||||||
- name: ABTProductReference CRUD
|
- name: ABTProductReference CRUD
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@ -7,7 +7,7 @@ info:
|
|||||||
Service Engine, using a different endpoint.
|
Service Engine, using a different endpoint.
|
||||||
version: '1.0'
|
version: '1.0'
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/products/1.0
|
- url: https://services.acc.api.htm.nl/abt/abtproducts/1.0
|
||||||
tags:
|
tags:
|
||||||
- name: ABTProducts CRUD
|
- name: ABTProducts CRUD
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: CRUD APIs for ABT Purchased Products database. These are NOT the functional APIs from Service Engine.
|
description: CRUD APIs for ABT Purchased Products database. These are NOT the functional APIs from Service Engine.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v1
|
- url: https://services.acc.api.htm.nl/abt/abtproducts/1.0
|
||||||
paths:
|
paths:
|
||||||
/purchasedproducts:
|
/purchasedproducts:
|
||||||
get:
|
get:
|
||||||
|
|||||||
@ -4,7 +4,7 @@ info:
|
|||||||
version: "1.0"
|
version: "1.0"
|
||||||
description: CRUD APIs for ABT Utility tables. These are NOT the functional APIs from Service Engine.
|
description: CRUD APIs for ABT Utility tables. These are NOT the functional APIs from Service Engine.
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/v1
|
- url: https://services.acc.api.htm.nl/abt/abtutility/1.0
|
||||||
paths:
|
paths:
|
||||||
/scheduledactions:
|
/scheduledactions:
|
||||||
get:
|
get:
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user