Compare commits
No commits in common. "065d5135943ee4297faa3aba6b5333ee843b6222" and "f1728ecebfceab4038e25306b940a21a32d23123" have entirely different histories.
065d513594
...
f1728ecebf
@ -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://api.integratielaag.nl/abt/abtserviceengine/2.0
|
||||||
tags:
|
tags:
|
||||||
- name: ServiceEngine Products
|
- name: ServiceEngine Products
|
||||||
description: |-
|
description: |-
|
||||||
@ -70,7 +70,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/99",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/99",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -103,7 +103,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/2",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -136,7 +136,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/2",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -169,7 +169,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/49",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/49",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -202,7 +202,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/126",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/126",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -235,7 +235,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/2",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/2",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -259,7 +259,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/4",
|
"href": "https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/4",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -929,7 +929,7 @@ paths:
|
|||||||
"productId": 109,
|
"productId": 109,
|
||||||
"parentProductId": 49,
|
"parentProductId": 49,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": null,
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - HL62",
|
"productName": "HTM Regio Vrij - HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1095,7 +1095,7 @@ paths:
|
|||||||
"productId": 114,
|
"productId": 114,
|
||||||
"parentProductId": 109,
|
"parentProductId": 109,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33629",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Voltarief - HL62",
|
"productName": "HTM Regio Vrij - Voltarief - HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1261,7 +1261,7 @@ paths:
|
|||||||
"productId": 115,
|
"productId": 115,
|
||||||
"parentProductId": 109,
|
"parentProductId": 109,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33630",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Reductietarief - HL62",
|
"productName": "HTM Regio Vrij - Reductietarief - HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1422,7 +1422,7 @@ paths:
|
|||||||
"productId": 116,
|
"productId": 116,
|
||||||
"parentProductId": 115,
|
"parentProductId": 115,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33630",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62",
|
"productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1586,7 +1586,7 @@ paths:
|
|||||||
"productId": 117,
|
"productId": 117,
|
||||||
"parentProductId": 115,
|
"parentProductId": 115,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33630",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62",
|
"productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1754,7 +1754,7 @@ paths:
|
|||||||
"productId": 112,
|
"productId": 112,
|
||||||
"parentProductId": 49,
|
"parentProductId": 49,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33618",
|
"gboPackageTemplateId": null,
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - HL65",
|
"productName": "HTM Regio Vrij - HL65",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65",
|
||||||
@ -2181,7 +2181,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/abtserviceengine/1.0/products/1
|
example: https://api.integratielaag.nl/abt/abtserviceengine/2.0/products/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
@ -2191,7 +2191,10 @@ components:
|
|||||||
required:
|
required:
|
||||||
- productId
|
- productId
|
||||||
- productOwner
|
- productOwner
|
||||||
|
- isRenewable
|
||||||
- isSellableAtHtm
|
- isSellableAtHtm
|
||||||
|
- needsSolvencyCheckConsumer
|
||||||
|
- needsSolvencyCheckBusiness
|
||||||
properties:
|
properties:
|
||||||
productId:
|
productId:
|
||||||
type: integer
|
type: integer
|
||||||
|
|||||||
@ -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://api.integratielaag.nl/abt/touchpoint/2.0
|
||||||
tags:
|
tags:
|
||||||
- name: ServiceEngine Products
|
- name: ServiceEngine Products
|
||||||
description: |-
|
description: |-
|
||||||
@ -70,7 +70,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/99",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/99",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -103,7 +103,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/2",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -136,7 +136,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/2",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -169,7 +169,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/49",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/49",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -202,7 +202,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/126",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/126",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -235,7 +235,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/2",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/2",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -259,7 +259,7 @@ paths:
|
|||||||
{
|
{
|
||||||
"get_details":
|
"get_details":
|
||||||
{
|
{
|
||||||
"href": "https://api.integratielaag.nl/abt/touchpoint/1.0/products/4",
|
"href": "https://api.integratielaag.nl/abt/touchpoint/2.0/products/4",
|
||||||
"method": "GET",
|
"method": "GET",
|
||||||
},
|
},
|
||||||
},
|
},
|
||||||
@ -929,7 +929,7 @@ paths:
|
|||||||
"productId": 109,
|
"productId": 109,
|
||||||
"parentProductId": 49,
|
"parentProductId": 49,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": null,
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - HL62",
|
"productName": "HTM Regio Vrij - HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1095,7 +1095,7 @@ paths:
|
|||||||
"productId": 114,
|
"productId": 114,
|
||||||
"parentProductId": 109,
|
"parentProductId": 109,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33629",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Voltarief - HL62",
|
"productName": "HTM Regio Vrij - Voltarief - HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1261,7 +1261,7 @@ paths:
|
|||||||
"productId": 115,
|
"productId": 115,
|
||||||
"parentProductId": 109,
|
"parentProductId": 109,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33630",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Reductietarief - HL62",
|
"productName": "HTM Regio Vrij - Reductietarief - HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1422,7 +1422,7 @@ paths:
|
|||||||
"productId": 116,
|
"productId": 116,
|
||||||
"parentProductId": 115,
|
"parentProductId": 115,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33630",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62",
|
"productName": "HTM Regio Vrij - Reductietarief - Losse Maand- HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1586,7 +1586,7 @@ paths:
|
|||||||
"productId": 117,
|
"productId": 117,
|
||||||
"parentProductId": 115,
|
"parentProductId": 115,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33615",
|
"gboPackageTemplateId": "33630",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62",
|
"productName": "HTM Regio Vrij - Reductietarief - Doorlopend abonnement- HL62",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL62",
|
||||||
@ -1754,7 +1754,7 @@ paths:
|
|||||||
"productId": 112,
|
"productId": 112,
|
||||||
"parentProductId": 49,
|
"parentProductId": 49,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"gboPackageTemplateId": "33618",
|
"gboPackageTemplateId": null,
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij - HL65",
|
"productName": "HTM Regio Vrij - HL65",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in gebied HL65",
|
||||||
@ -2181,7 +2181,7 @@ components:
|
|||||||
properties:
|
properties:
|
||||||
href:
|
href:
|
||||||
type: string
|
type: string
|
||||||
example: https://api.integratielaag.nl/abt/touchpoint/1.0/products/1
|
example: https://api.integratielaag.nl/abt/touchpoint/2.0/products/1
|
||||||
method:
|
method:
|
||||||
type: string
|
type: string
|
||||||
example: GET
|
example: GET
|
||||||
@ -2191,7 +2191,10 @@ components:
|
|||||||
required:
|
required:
|
||||||
- productId
|
- productId
|
||||||
- productOwner
|
- productOwner
|
||||||
|
- isRenewable
|
||||||
- isSellableAtHtm
|
- isSellableAtHtm
|
||||||
|
- needsSolvencyCheckConsumer
|
||||||
|
- needsSolvencyCheckBusiness
|
||||||
properties:
|
properties:
|
||||||
productId:
|
productId:
|
||||||
type: integer
|
type: integer
|
||||||
|
|||||||
@ -2,7 +2,7 @@ openapi: 3.0.1
|
|||||||
info:
|
info:
|
||||||
title: ABTProducts
|
title: ABTProducts
|
||||||
description: >-
|
description: >-
|
||||||
CRUD APIs for HTM products (based on the new domainmodel v2.5). Internal use
|
CRUD APIs for HTM products (based on the new domainmodel v2.4). Internal use
|
||||||
only; external touchpoints can get read-only, filtered access via the HTM
|
only; external touchpoints can get read-only, filtered access via the HTM
|
||||||
Service Engine, using a different endpoint.
|
Service Engine, using a different endpoint.
|
||||||
version: '1.0'
|
version: '1.0'
|
||||||
@ -23,7 +23,6 @@ paths:
|
|||||||
Get a list of all HTM products that refer to a given parentProductId (or without parent, if not specified), without any other filters. \
|
Get a list of all HTM products that refer to a given parentProductId (or without parent, if not specified), without any other filters. \
|
||||||
Only a few details are returned per product - use the `GET /products/{productId}` endpoint
|
Only a few details are returned per product - use the `GET /products/{productId}` endpoint
|
||||||
to get more details. \
|
to get more details. \
|
||||||
Two attributes are only returned if no touchpoint HTTP header is present: `isValid` and `isArchived`. \
|
|
||||||
In the examples, it can be seen that (when a touchpoint HTTP header is present)
|
In the examples, it can be seen that (when a touchpoint HTTP header is present)
|
||||||
only products that have active sellingPeriods for touchpoints within the same
|
only products that have active sellingPeriods for touchpoints within the same
|
||||||
retailer as the calling retailer are returned. \
|
retailer as the calling retailer are returned. \
|
||||||
@ -53,46 +52,14 @@ paths:
|
|||||||
{
|
{
|
||||||
"Entries": []
|
"Entries": []
|
||||||
}
|
}
|
||||||
getListOneValidProductNoSellingPeriodsNoTouchpointId:
|
getListOneProductNoSellingPeriodsNoTouchpointId:
|
||||||
summary: List containing one (valid) product without any SellingPeriods (no touchpointId in HTTP-headers)
|
summary: List containing one product without any SellingPeriods (no touchpointId in HTTP-headers)
|
||||||
description: All products are returned, even if they have no active sellingPeriods or are invalid or archived
|
description: All products are returned, even if they have no activesellingPeriods
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"Entries": [
|
"Entries": [
|
||||||
{
|
{
|
||||||
"productId": 1,
|
"productId": 1,
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM pilot 90% korting",
|
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
|
||||||
"productCategory": {
|
|
||||||
"productCategoryId": 1,
|
|
||||||
"isTravelProduct": true,
|
|
||||||
"name": "Kortingsabonnement"
|
|
||||||
},
|
|
||||||
"tokenTypes": [
|
|
||||||
{
|
|
||||||
"tokenTypeId": 1,
|
|
||||||
"name": "EMV"
|
|
||||||
}
|
|
||||||
],
|
|
||||||
"sellableTouchpointIds": null,
|
|
||||||
"amountInclTax": null,
|
|
||||||
"imageReference": "https://www.htm.nl/media/leif2leu/htm-logo-mobile.svg",
|
|
||||||
"productPageUrl": "https://www.htm.nl/nog-onbekende-product-pagina"
|
|
||||||
}
|
|
||||||
]
|
|
||||||
}
|
|
||||||
getListOneInvalidProductNoSellingPeriodsNoTouchpointId:
|
|
||||||
summary: List containing one (invalid) product without any SellingPeriods (no touchpointId in HTTP-headers)
|
|
||||||
description: All products are returned, even if they have no active sellingPeriods or are invalid or archived
|
|
||||||
value:
|
|
||||||
{
|
|
||||||
"Entries": [
|
|
||||||
{
|
|
||||||
"productId": 1,
|
|
||||||
"isValid": false,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
@ -115,14 +82,12 @@ paths:
|
|||||||
}
|
}
|
||||||
getListOneProductNoTouchpointId:
|
getListOneProductNoTouchpointId:
|
||||||
summary: List containing one product with 4 currently active SellingPeriods (no touchpointId in HTTP-headers)
|
summary: List containing one product with 4 currently active SellingPeriods (no touchpointId in HTTP-headers)
|
||||||
description: All products are returned, even if they have no active SellingPeriods or are invalid or archived
|
description: All products are returned, even if they have no active SellingPeriods
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"Entries": [
|
"Entries": [
|
||||||
{
|
{
|
||||||
"productId": 2,
|
"productId": 2,
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM dagkaart",
|
"productName": "HTM dagkaart",
|
||||||
"productDescription": "Reis een dag met het openbaar vervoer bij HTM",
|
"productDescription": "Reis een dag met het openbaar vervoer bij HTM",
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
@ -171,14 +136,12 @@ paths:
|
|||||||
}
|
}
|
||||||
getListMultipleProductsNoTouchpointId:
|
getListMultipleProductsNoTouchpointId:
|
||||||
summary: List containing multiple products (no touchpointId in HTTP-headers)
|
summary: List containing multiple products (no touchpointId in HTTP-headers)
|
||||||
description: All products are returned, even if they have no active SellingPeriods or are invalid or archived
|
description: All products are returned, even if they have no active SellingPeriods
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"Entries": [
|
"Entries": [
|
||||||
{
|
{
|
||||||
"productId": 1,
|
"productId": 1,
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
@ -199,8 +162,6 @@ paths:
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"productId": 2,
|
"productId": 2,
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM dagkaart",
|
"productName": "HTM dagkaart",
|
||||||
"productDescription": "Reis een dag met het openbaar vervoer bij HTM",
|
"productDescription": "Reis een dag met het openbaar vervoer bij HTM",
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
@ -221,8 +182,6 @@ paths:
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"productId": 3,
|
"productId": 3,
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM 20% korting",
|
"productName": "HTM 20% korting",
|
||||||
"productDescription": "Reis een maand lang met 20% korting!",
|
"productDescription": "Reis een maand lang met 20% korting!",
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
@ -246,8 +205,6 @@ paths:
|
|||||||
},
|
},
|
||||||
{
|
{
|
||||||
"productId": 4,
|
"productId": 4,
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"productName": "HTM 40% korting",
|
"productName": "HTM 40% korting",
|
||||||
"productDescription": "Reis een maand lang met 40% korting!",
|
"productDescription": "Reis een maand lang met 40% korting!",
|
||||||
"productCategory": {
|
"productCategory": {
|
||||||
@ -271,7 +228,7 @@ paths:
|
|||||||
}
|
}
|
||||||
]
|
]
|
||||||
}
|
}
|
||||||
getListMultipleProductsTouchpointId1:
|
getListMultipleProductsTuchpointId1:
|
||||||
summary: List containing multiple products (touchpointId 3 in HTTP-headers)
|
summary: List containing multiple products (touchpointId 3 in HTTP-headers)
|
||||||
description: Only products that have active SellingPeriods for touchpoint 3 and/or 4 (part of same retailer) are returned
|
description: Only products that have active SellingPeriods for touchpoint 3 and/or 4 (part of same retailer) are returned
|
||||||
value:
|
value:
|
||||||
@ -368,17 +325,16 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"productOwnerId": 1,
|
"productOwnerId": 1,
|
||||||
"isValid": false,
|
"isRenewable": false,
|
||||||
"isArchived": false,
|
"isSellableAtHtm": false,
|
||||||
"isSellableAtHtm": false
|
"needsSolvencyCheckConsumer": false,
|
||||||
|
"needsSolvencyCheckBusiness": false
|
||||||
}
|
}
|
||||||
postGboProduct:
|
postGboProduct:
|
||||||
summary: Add new GBO product (non-renewable)
|
summary: Add new GBO product (non-renewable)
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
@ -467,8 +423,6 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
@ -591,8 +545,6 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "35301",
|
"gboPackageTemplateId": "35301",
|
||||||
"productName": "HTM Regio Vrij DH73",
|
"productName": "HTM Regio Vrij DH73",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.",
|
||||||
@ -779,8 +731,6 @@ paths:
|
|||||||
"productId": 1,
|
"productId": 1,
|
||||||
"parentProductId": null,
|
"parentProductId": null,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
@ -953,8 +903,6 @@ paths:
|
|||||||
"productId": 2,
|
"productId": 2,
|
||||||
"parentProductId": null,
|
"parentProductId": null,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
@ -1184,8 +1132,6 @@ paths:
|
|||||||
"productId": 3,
|
"productId": 3,
|
||||||
"parentProductId": null,
|
"parentProductId": null,
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "35301",
|
"gboPackageTemplateId": "35301",
|
||||||
"tapConnectProductCode": null,
|
"tapConnectProductCode": null,
|
||||||
"productName": "HTM Regio Vrij DH73",
|
"productName": "HTM Regio Vrij DH73",
|
||||||
@ -1470,17 +1416,16 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"productOwnerId": 1,
|
"productOwnerId": 1,
|
||||||
"isValid": false,
|
"isRenewable": false,
|
||||||
"isArchived": false,
|
"isSellableAtHtm": false,
|
||||||
"isSellableAtHtm": false
|
"needsSolvencyCheckConsumer": false,
|
||||||
|
"needsSolvencyCheckBusiness": false
|
||||||
}
|
}
|
||||||
updateGboProduct:
|
updateGboProduct:
|
||||||
summary: Update existing GBO product (non-renewable)
|
summary: Update existing GBO product (non-renewable)
|
||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
@ -1573,8 +1518,6 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
@ -1689,8 +1632,6 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "30901",
|
"gboPackageTemplateId": "30901",
|
||||||
"productName": "HTM pilot 90% korting",
|
"productName": "HTM pilot 90% korting",
|
||||||
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
"productDescription": "Reis met 90% korting gedurende de eerste F&F pilot!",
|
||||||
@ -1821,8 +1762,6 @@ paths:
|
|||||||
value:
|
value:
|
||||||
{
|
{
|
||||||
"fikoArticleNumber": "1234",
|
"fikoArticleNumber": "1234",
|
||||||
"isValid": true,
|
|
||||||
"isArchived": false,
|
|
||||||
"gboPackageTemplateId": "35301",
|
"gboPackageTemplateId": "35301",
|
||||||
"productName": "HTM Regio Vrij DH73",
|
"productName": "HTM Regio Vrij DH73",
|
||||||
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.",
|
"productDescription": "Voor een vast bedrag onbeperkt reizen met EBS, HTM en RET in het gekozen gebied in de regio Rotterdam Den Haag.",
|
||||||
@ -2160,26 +2099,10 @@ components:
|
|||||||
type: object
|
type: object
|
||||||
required:
|
required:
|
||||||
- productId
|
- productId
|
||||||
- productName
|
|
||||||
- productDescription
|
|
||||||
- productCategory
|
|
||||||
- tokenTypes
|
|
||||||
- sellableTouchpointIds
|
|
||||||
- amountInclTax
|
|
||||||
- imageReference
|
|
||||||
- productPageUrl
|
|
||||||
properties:
|
properties:
|
||||||
productId:
|
productId:
|
||||||
type: integer
|
type: integer
|
||||||
example: 1
|
example: 1
|
||||||
isValid:
|
|
||||||
type: boolean
|
|
||||||
description: Not returned for external touchpoints
|
|
||||||
example: true
|
|
||||||
isArchived:
|
|
||||||
type: boolean
|
|
||||||
description: Not returned for external touchpoints
|
|
||||||
example: false
|
|
||||||
productName:
|
productName:
|
||||||
type: string
|
type: string
|
||||||
example: HTM pilot 90% korting
|
example: HTM pilot 90% korting
|
||||||
@ -2236,9 +2159,10 @@ components:
|
|||||||
required:
|
required:
|
||||||
- productId
|
- productId
|
||||||
- productOwner
|
- productOwner
|
||||||
- isValid
|
- isRenewable
|
||||||
- isArchived
|
|
||||||
- isSellableAtHtm
|
- isSellableAtHtm
|
||||||
|
- needsSolvencyCheckConsumer
|
||||||
|
- needsSolvencyCheckBusiness
|
||||||
properties:
|
properties:
|
||||||
productId:
|
productId:
|
||||||
type: integer
|
type: integer
|
||||||
@ -2250,14 +2174,6 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
description: The article number of the product in FIKO
|
description: The article number of the product in FIKO
|
||||||
example: 1234
|
example: 1234
|
||||||
isValid:
|
|
||||||
type: boolean
|
|
||||||
description: Indicates if the product is valid - if false, the Service Engine will prevent touchpoints from seeing this product
|
|
||||||
example: true
|
|
||||||
isArchived:
|
|
||||||
type: boolean
|
|
||||||
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
|
|
||||||
example: false
|
|
||||||
gboPackageTemplateId:
|
gboPackageTemplateId:
|
||||||
type: string
|
type: string
|
||||||
example: '30901'
|
example: '30901'
|
||||||
@ -2590,9 +2506,10 @@ components:
|
|||||||
CreateProductRequest:
|
CreateProductRequest:
|
||||||
required:
|
required:
|
||||||
- productOwnerId
|
- productOwnerId
|
||||||
- isValid
|
- isRenewable
|
||||||
- isArchived
|
|
||||||
- isSellableAtHtm
|
- isSellableAtHtm
|
||||||
|
- needsSolvencyCheckConsumer
|
||||||
|
- needsSolvencyCheckBusiness
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
parentProductId:
|
parentProductId:
|
||||||
@ -2603,14 +2520,6 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
description: The article number of the product in FIKO
|
description: The article number of the product in FIKO
|
||||||
example: 1234
|
example: 1234
|
||||||
isValid:
|
|
||||||
type: boolean
|
|
||||||
description: Indicates if the product is valid - if false, the Service Engine will prevent touchpoints from seeing this product
|
|
||||||
example: true
|
|
||||||
isArchived:
|
|
||||||
type: boolean
|
|
||||||
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
|
|
||||||
example: false
|
|
||||||
gboPackageTemplateId:
|
gboPackageTemplateId:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: >-
|
||||||
@ -2963,9 +2872,10 @@ components:
|
|||||||
UpdateProductRequest:
|
UpdateProductRequest:
|
||||||
required:
|
required:
|
||||||
- productOwnerId
|
- productOwnerId
|
||||||
- isValid
|
- isRenewable
|
||||||
- isArchived
|
|
||||||
- isSellableAtHtm
|
- isSellableAtHtm
|
||||||
|
- needsSolvencyCheckConsumer
|
||||||
|
- needsSolvencyCheckBusiness
|
||||||
type: object
|
type: object
|
||||||
properties:
|
properties:
|
||||||
parentProductId:
|
parentProductId:
|
||||||
@ -2976,14 +2886,6 @@ components:
|
|||||||
type: string
|
type: string
|
||||||
description: The article number of the product in FIKO
|
description: The article number of the product in FIKO
|
||||||
example: 1234
|
example: 1234
|
||||||
isValid:
|
|
||||||
type: boolean
|
|
||||||
description: Indicates if the product is valid - if false, the Service Engine will prevent touchpoints from seeing this product
|
|
||||||
example: true
|
|
||||||
isArchived:
|
|
||||||
type: boolean
|
|
||||||
description: Indicates if the product is archived - if true, the Service Engine will prevent touchpoints from seeing this product
|
|
||||||
example: false
|
|
||||||
gboPackageTemplateId:
|
gboPackageTemplateId:
|
||||||
type: string
|
type: string
|
||||||
description: >-
|
description: >-
|
||||||
|
|||||||
Loading…
Reference in New Issue
Block a user