diff --git a/src/openapi/products/productreference-crud.yaml b/src/openapi/products/productreference-crud.yaml index 7428502..b96bd70 100644 --- a/src/openapi/products/productreference-crud.yaml +++ b/src/openapi/products/productreference-crud.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: ABTProductReference description: >- - CRUD APIs for HTM product reference tables (based on the new domainmodel v2.4). + CRUD APIs for HTM product reference tables (based on the new domainmodel v2.6). Internal use only; external touchpoints can get (some)) access via the HTM Service Engine, using a different endpoint. version: '1.0' diff --git a/src/openapi/products/products-crud.yaml b/src/openapi/products/products-crud.yaml index d86e7f6..b236c3a 100644 --- a/src/openapi/products/products-crud.yaml +++ b/src/openapi/products/products-crud.yaml @@ -2,7 +2,7 @@ openapi: 3.0.1 info: title: ABTProducts 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.6). Internal use only; external touchpoints can get read-only, filtered access via the HTM Service Engine, using a different endpoint. version: '1.0' @@ -126,7 +126,7 @@ paths: "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { - "productCategoryId": 6, + "productCategoryId": 5, "isTravelProduct": false, "name": "Barcode" }, @@ -154,7 +154,7 @@ paths: "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { - "productCategoryId": 6, + "productCategoryId": 5, "isTravelProduct": false, "name": "Barcode" }, @@ -204,7 +204,7 @@ paths: "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { - "productCategoryId": 6, + "productCategoryId": 5, "isTravelProduct": false, "name": "Barcode" }, @@ -282,7 +282,7 @@ paths: "productName": "HTM dagkaart", "productDescription": "Reis een dag met het openbaar vervoer bij HTM", "productCategory": { - "productCategoryId": 6, + "productCategoryId": 5, "isTravelProduct": false, "name": "Barcode" }, @@ -398,13 +398,10 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 - ], - "allowedGboAgeProfileIds": [ - 1, - 2 + 5, + 6 ], + "allowedGboAgeProfileIds": [], "productCategoryId": 1, "requiredCustomerLevelId": 1, "incompatibleProducts": [ @@ -415,7 +412,7 @@ paths: ], "mandatoryCustomerDataItemIds": [ 4, - 5 + 7 ], "tokenTypeIds": [ 1 @@ -462,8 +459,7 @@ paths: } postGboProductMultiplePeriods: summary: >- - Add new GBO product (non-renewable, multiple - sellingPeriods/prices per period) + Add new GBO product (non-renewable, multiple sellingPeriods/prices per period) value: { "fikoArticleNumber": "1234", @@ -488,13 +484,10 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 - ], - "allowedGboAgeProfileIds": [ - 1, - 2 + 5, + 6 ], + "allowedGboAgeProfileIds": [], "productCategoryId": 1, "requiredCustomerLevelId": 1, "incompatibleProducts": [ @@ -505,7 +498,7 @@ paths: ], "mandatoryCustomerDataItemIds": [ 4, - 5 + 7 ], "tokenTypeIds": [ 1 @@ -586,14 +579,13 @@ paths: } postGboPadProduct: summary: >- - Add new GBO product (PAD required, renewable, serviceOptions, - forbiddenPaymentMethods) + Add new GBO product (PAD required, renewable, allowedGboAgeProfiles, padBirthDate) value: { "fikoArticleNumber": "1234", "isValid": true, "isArchived": false, - "gboPackageTemplateId": "35301", + "gboPackageTemplateId": "33610", "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.", "validityPeriod": { @@ -612,14 +604,16 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 + 5, + 6 ], - "allowedGboAgeProfileIds": [ - 1, - 2 + "allowedGboAgeProfileIds": [ + 2, + 3, + 4, + 5 ], - "productCategoryId": 3, + "productCategoryId": 2, "requiredCustomerLevelId": 3, "requiredProducts": [ { @@ -634,10 +628,8 @@ paths: } ], "mandatoryCustomerDataItemIds": [ - 3, 4, - 5, - 6 + 8 ], "requiredGboPersonalAttributeIds": [ 1, @@ -650,10 +642,7 @@ paths: 3 ], "paymentMomentId": 1, - "serviceOptionIds": [ - 1, - 2 - ], + "serviceOptionIds": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": true, @@ -670,7 +659,7 @@ paths: "toInclusive": "2024-12-31T23:59:59.999", "salesTouchpointId": 3, "forbiddenPaymentMethodIds": [ - 1 + 3 ], "sellingPrices": [ { @@ -811,28 +800,15 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 6, + "customerSegmentId": 5, "name": "Student" }, { - "customerSegmentId": 7, + "customerSegmentId": 6, "name": "Ooievaarspas-gerechtigde" } ], - "allowedGboAgeProfiles": [ - { - "gboAgeProfileId": 2, - "name": "Kind (4 t/m 11 jaar)", - "ageFromInclusive": 4, - "ageUntilInclusive": 11 - }, - { - "gboAgeProfileId": 3, - "name": "Jongere (12 t/m 18 jaar)", - "ageFromInclusive": 12, - "ageUntilInclusive": 18 - } - ], + "allowedGboAgeProfiles": null, "productCategory": { "productCategoryId": 1, "isTravelProduct": true, @@ -856,7 +832,7 @@ paths: "customerDataItem": "emailAddress" }, { - "mandatoryCustomerDataItemId": 5, + "mandatoryCustomerDataItemId": 7, "customerDataItem": "ovPayToken" } ], @@ -986,11 +962,11 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 6, + "customerSegmentId": 5, "name": "Student" }, { - "customerSegmentId": 7, + "customerSegmentId": 6, "name": "Ooievaarspas-gerechtigde" } ], @@ -1031,7 +1007,7 @@ paths: "customerDataItem": "emailAddress" }, { - "mandatoryCustomerDataItemId": 5, + "mandatoryCustomerDataItemId": 7, "customerDataItem": "ovPayToken" } ], @@ -1180,7 +1156,7 @@ paths: ] } getDetailsGboPadProduct: - summary: GBO product (PAD required, renewable, serviceOptions, forbiddenPaymentMethods) + summary: GBO product (PAD required, renewable, allowedGboAgeProfiles, padBirthDate) value: { "productId": 3, @@ -1218,11 +1194,11 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 6, + "customerSegmentId": 5, "name": "Student" }, { - "customerSegmentId": 7, + "customerSegmentId": 6, "name": "Ooievaarspas-gerechtigde" } ], @@ -1253,7 +1229,7 @@ paths: } ], "productCategory": { - "productCategoryId": 3, + "productCategoryId": 2, "isTravelProduct": true, "name": "Afgekocht reisrecht" }, @@ -1311,13 +1287,7 @@ paths: "paymentMomentId": 1, "name": "prepaid" }, - "serviceOptions": [ - { - "serviceOptionId": 1, - "action": "cancellableTermAhead", - "description": "Per termijn vooruit opzegbaar" - } - ], + "serviceOptions": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": true, @@ -1354,8 +1324,8 @@ paths: }, "forbiddenPaymentMethods": [ { - "forbiddenPaymentMethodId": 1, - "name": "Credit Card", + "forbiddenPaymentMethodId": 3, + "name": "creditcard", "issuer": "American Express" } ], @@ -1449,11 +1419,11 @@ paths: ], "customerSegments": [ { - "customerSegmentId": 6, + "customerSegmentId": 5, "name": "Student" }, { - "customerSegmentId": 7, + "customerSegmentId": 6, "name": "Ooievaarspas-gerechtigde" } ], @@ -1472,7 +1442,7 @@ paths: } ], "productCategory": { - "productCategoryId": 3, + "productCategoryId": 2, "isTravelProduct": true, "name": "Afgekocht reisrecht" }, @@ -1530,18 +1500,7 @@ paths: "paymentMomentId": 1, "name": "prepaid" }, - "serviceOptions": [ - { - "serviceOptionId": 1, - "action": "cancellableTermAhead", - "description": "Per termijn vooruit opzegbaar" - }, - { - "serviceOptionId": 2, - "action": "cancellableWithin14Days", - "description": "Binnen 14 dagen na aanschaf opzegbaar, met restitutie en herberekening ritten met product" - } - ], + "serviceOptions": null, "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": true, @@ -1578,8 +1537,8 @@ paths: }, "forbiddenPaymentMethods": [ { - "forbiddenPaymentMethodId": 1, - "name": "Credit Card", + "forbiddenPaymentMethodId": 3, + "name": "creditcard", "issuer": "American Express" } ], @@ -1727,13 +1686,10 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 - ], - "allowedGboAgeProfileIds": [ - 1, - 2 + 5, + 6 ], + "allowedGboAgeProfileIds": [], "productCategoryId": 1, "requiredCustomerLevelId": 1, "incompatibleProducts": [ @@ -1744,7 +1700,7 @@ paths: ], "mandatoryCustomerDataItemIds": [ 4, - 5 + 7 ], "tokenTypeIds": [ 1 @@ -1794,8 +1750,7 @@ paths: } advancedUpdateGboProduct: summary: >- - Advanced update (remove mandatoryCustomerDataItem references, - add new second sellingPeriod) + Advanced update (remove mandatoryCustomerDataItem references, add new second sellingPeriod) value: { "fikoArticleNumber": "1234", @@ -1821,13 +1776,10 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 - ], - "allowedGboAgeProfileIds": [ - 1, - 2 + 5, + 6 ], + "allowedGboAgeProfileIds": [], "productCategoryId": 1, "requiredCustomerLevelId": 1, "incompatibleProducts": [ @@ -1910,8 +1862,7 @@ paths: } updateGboProductMultiplePeriods: summary: >- - Update existing GBO product (non-renewable, multiple - sellingPeriods/prices per period) + Update existing GBO product (non-renewable, multiple sellingPeriods/prices per period) value: { "fikoArticleNumber": "1234", @@ -1937,13 +1888,10 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 - ], - "allowedGboAgeProfileIds": [ - 1, - 2 + 5, + 6 ], + "allowedGboAgeProfileIds": [], "productCategoryId": 1, "requiredCustomerLevelId": 1, "incompatibleProducts": [ @@ -1954,7 +1902,7 @@ paths: ], "mandatoryCustomerDataItemIds": [ 4, - 5 + 7 ], "tokenTypeIds": [ 1 @@ -2042,14 +1990,13 @@ paths: } updateGboPadProduct: summary: >- - Update existing GBO product (PAD required, renewable, - serviceOptions, forbiddenPaymentMethods) + Update existing GBO product (PAD required, renewable, allowedGboAgeProfiles, padBirthDate) value: { "fikoArticleNumber": "1234", "isValid": true, "isArchived": false, - "gboPackageTemplateId": "35301", + "gboPackageTemplateId": "33610", "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.", "validityPeriod": { @@ -2069,14 +2016,16 @@ paths: 1 ], "customerSegmentIds": [ - 6, - 7 + 5, + 6 ], "allowedGboAgeProfileIds": [ - 1, - 2 + 2, + 3, + 4, + 5 ], - "productCategoryId": 3, + "productCategoryId": 2, "requiredCustomerLevelId": 3, "requiredProducts": [ { @@ -2091,10 +2040,8 @@ paths: } ], "mandatoryCustomerDataItemIds": [ - 3, 4, - 5, - 6 + 8 ], "requiredGboPersonalAttributeIds": [ 1, @@ -2107,10 +2054,7 @@ paths: 3 ], "paymentMomentId": 1, - "serviceOptionIds": [ - 1, - 2 - ], + "serviceOptionIds": [], "validityDuration": "P1M", "maxStartInFutureDuration": "P6W", "isRenewable": true, @@ -2128,7 +2072,7 @@ paths: "toInclusive": "2024-12-31T23:59:59.999", "salesTouchpointId": 3, "forbiddenPaymentMethodIds": [ - 1 + 3 ], "sellingPrices": [ { @@ -2824,10 +2768,10 @@ components: properties: forbiddenPaymentMethodId: type: integer - example: 1 + example: 3 name: type: string - example: Credit Card + example: creditcard issuer: type: string example: American Express