RC1
This commit is contained in:
Max Martens
parent
a6878b9a34
commit
7c666aa351
@ -4,9 +4,9 @@ info:
|
|||||||
description: >-
|
description: >-
|
||||||
Service Engine APIs for HTM Customers. These are NOT the CRUD APIs to access raw data in the database.
|
Service Engine APIs for HTM Customers. These are NOT the CRUD APIs to access raw data in the database.
|
||||||
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: 'x.x'
|
||||||
servers:
|
servers:
|
||||||
- url: https://api.integratielaag.nl/abt/serviceengine/customers/1.0
|
- url: https://api.integratielaag.nl/abt/serviceengine/customers/x.x
|
||||||
tags:
|
tags:
|
||||||
- name: ServiceEngine Customers
|
- name: ServiceEngine Customers
|
||||||
description: >-
|
description: >-
|
||||||
@ -135,7 +135,7 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"type": "https://api.integratielaag.nl/abt/serviceengine/1.0/customers",
|
"type": "https://api.integratielaag.nl/abt/serviceengine/x.x/customers",
|
||||||
"apiErrorCode": "400.1",
|
"apiErrorCode": "400.1",
|
||||||
"title": "Niet gevonden",
|
"title": "Niet gevonden",
|
||||||
"detail": "Klant niet gevonden",
|
"detail": "Klant niet gevonden",
|
||||||
@ -152,7 +152,7 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
example:
|
example:
|
||||||
{
|
{
|
||||||
"type": "https://api.integratielaag.nl/abt/serviceengine/1.0/customers",
|
"type": "https://api.integratielaag.nl/abt/serviceengine/x.x/customers",
|
||||||
"apiErrorCode": "409.1",
|
"apiErrorCode": "409.1",
|
||||||
"title": "Meer dan 1 klantprofiel gevonden",
|
"title": "Meer dan 1 klantprofiel gevonden",
|
||||||
"detail": "Meer dan 1 klantprofiel gevonden. Verfijn je zoekcriteria.",
|
"detail": "Meer dan 1 klantprofiel gevonden. Verfijn je zoekcriteria.",
|
||||||
@ -171,7 +171,7 @@ paths:
|
|||||||
application/json:
|
application/json:
|
||||||
schema:
|
schema:
|
||||||
$ref: '#/components/schemas/OvPayTokensResponse'
|
$ref: '#/components/schemas/OvPayTokensResponse'
|
||||||
/customers/tokens/{ovPayTokenId}/productInstances:
|
/customers/tokens/{ovPayTokenId}/productinstances:
|
||||||
get:
|
get:
|
||||||
tags:
|
tags:
|
||||||
- ServiceEngine Customers
|
- ServiceEngine Customers
|
||||||
@ -202,7 +202,7 @@ paths:
|
|||||||
value:
|
value:
|
||||||
productInstances: []
|
productInstances: []
|
||||||
getSingleProductInstance:
|
getSingleProductInstance:
|
||||||
summary: One product-instance found on token
|
summary: One non-renewable product-instance
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"productInstances": [
|
"productInstances": [
|
||||||
@ -210,17 +210,26 @@ paths:
|
|||||||
"productId": 1,
|
"productId": 1,
|
||||||
"name": "HTM 90% Korting",
|
"name": "HTM 90% Korting",
|
||||||
"status": "Active",
|
"status": "Active",
|
||||||
"fromInclusive": "2024-11-25T13:25:00+01:00",
|
"isRenewable": true,
|
||||||
"untilInclusive": "2024-12-25T03:59:59+01:00",
|
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
"productCategoryId": 1,
|
"productCategoryId": 1,
|
||||||
"name": "Kortingsabonnement"
|
"name": "Kortingsabonnement"
|
||||||
},
|
},
|
||||||
"gboTypeOfProduct": "discount",
|
"fromInclusive": "2024-11-25T13:25:00+01:00",
|
||||||
"purchasedProductId": 1,
|
"untilInclusive": "2024-12-25T03:59:59+01:00",
|
||||||
"orderId": "501B17EF-36C4-4039-B92C-6517969B464E",
|
"orderId": "501B17EF-36C4-4039-B92C-6517969B464E",
|
||||||
"orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E",
|
"orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E",
|
||||||
"contractId": "string"
|
"contractId": "56B17EF-C436-9043-B76C-481797WEB464F",
|
||||||
|
"_links": {
|
||||||
|
"get_order": {
|
||||||
|
"href": "https://api.integratielaag.nl/abt/serviceengine/x.x/orders/501B17EF-36C4-4039-B92C-6517969B464E",
|
||||||
|
"method": "GET"
|
||||||
|
},
|
||||||
|
"get_contract": {
|
||||||
|
"href": "https://api.integratielaag.nl/abt/serviceengine/x.x/customers/contracts/56B17EF-C436-9043-B76C-481797WEB464F",
|
||||||
|
"method": "GET"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
@ -316,7 +325,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/addresses/1
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/addresses/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: DELETE
|
example: DELETE
|
||||||
@ -354,7 +363,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/phones/1
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/phones/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: DELETE
|
example: DELETE
|
||||||
@ -366,7 +375,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: PATCH
|
example: PATCH
|
||||||
@ -378,7 +387,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
@ -390,7 +399,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: POST
|
example: POST
|
||||||
@ -502,7 +511,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens/1
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: PATCH
|
example: PATCH
|
||||||
@ -514,7 +523,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens/1/replace
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/replace
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: POST
|
example: POST
|
||||||
@ -526,7 +535,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens/1
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: DELETE
|
example: DELETE
|
||||||
@ -535,7 +544,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens/1/productInstances
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/productinstances
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
@ -544,7 +553,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/serviceengine/1.0/customers/tokens/1/trips
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/tokens/1/trips
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
@ -599,17 +608,11 @@ components:
|
|||||||
example: HTM 90% Korting
|
example: HTM 90% Korting
|
||||||
status:
|
status:
|
||||||
type: string
|
type: string
|
||||||
|
enum: [ "Active", "Ended", "Refunded" ]
|
||||||
example: Active
|
example: Active
|
||||||
fromInclusive:
|
isRenewable:
|
||||||
type: string
|
type: boolean
|
||||||
format: date-time-offset
|
example: true
|
||||||
example: "2024-11-25T13:25:00+01:00"
|
|
||||||
untilInclusive:
|
|
||||||
type: string
|
|
||||||
format: date-time-offset
|
|
||||||
description: >-
|
|
||||||
If not present, this product-instance represents a subscription/contract without a real end. If present, it can be either the natural end date or the refund timestamp.
|
|
||||||
example: "2024-12-25T03:59:59+01:00"
|
|
||||||
productCategory:
|
productCategory:
|
||||||
type: object
|
type: object
|
||||||
description: The category of the originating HTM product definition
|
description: The category of the originating HTM product definition
|
||||||
@ -620,13 +623,16 @@ components:
|
|||||||
name:
|
name:
|
||||||
type: string
|
type: string
|
||||||
example: Kortingsabonnement
|
example: Kortingsabonnement
|
||||||
gboTypeOfProduct:
|
fromInclusive:
|
||||||
type: string
|
type: string
|
||||||
example: discount
|
format: date-time-offset
|
||||||
description: The type of the product instance as GBO defines it
|
example: "2024-11-25T13:25:00+01:00"
|
||||||
purchasedProductId:
|
untilInclusive:
|
||||||
type: integer
|
type: string
|
||||||
example: 1
|
format: date-time-offset
|
||||||
|
description: >-
|
||||||
|
If not present, this product-instance represents a subscription/contract without a real end date. If present, it can be either the natural end date or the refund timestamp.
|
||||||
|
example: "2024-12-25T03:59:59+01:00"
|
||||||
orderId:
|
orderId:
|
||||||
type: string
|
type: string
|
||||||
format: uuid
|
format: uuid
|
||||||
@ -636,7 +642,34 @@ components:
|
|||||||
format: uuid
|
format: uuid
|
||||||
example: 38B17EF-36C4-4039-B92C-4817969B464E
|
example: 38B17EF-36C4-4039-B92C-4817969B464E
|
||||||
contractId:
|
contractId:
|
||||||
description: doen? of via purchasedProductId?
|
type: string
|
||||||
|
format: uuid
|
||||||
|
example: 56B17EF-C436-9043-B76C-481797WEB464F
|
||||||
|
description: Only present for subscriptions/contracts
|
||||||
|
_links:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
get_order:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
description: Always present for any HTM product-instance
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/orders/501B17EF-36C4-4039-B92C-6517969B464E
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
get_contract:
|
||||||
|
type: object
|
||||||
|
properties:
|
||||||
|
href:
|
||||||
|
type: string
|
||||||
|
description: Only present for subscriptions/contracts
|
||||||
|
example: https://api.integratielaag.nl/abt/serviceengine/x.x/customers/contracts/56B17EF-C436-9043-B76C-481797WEB464F
|
||||||
|
method:
|
||||||
|
type: string
|
||||||
|
example: GET
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user