diff --git a/src/openapi/customers/SE-customers-v2.yaml b/src/openapi/customers/SE-customers-v2.yaml index e09b067..0543f84 100644 --- a/src/openapi/customers/SE-customers-v2.yaml +++ b/src/openapi/customers/SE-customers-v2.yaml @@ -380,7 +380,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP requestBody: content: application/json: @@ -415,7 +415,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -429,7 +429,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP requestBody: content: application/json: @@ -464,7 +464,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -478,7 +478,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP - name: customerPreferenceId in: path required: true @@ -519,7 +519,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -533,8 +533,8 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP - + description: The role of the HTM employee in the case of the SMP + requestBody: content: application/json: @@ -575,7 +575,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -589,7 +589,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP - name: addressId in: path required: true @@ -634,7 +634,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -648,7 +648,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP - name: addressId in: path required: true @@ -669,14 +669,14 @@ paths: summary: Add a customer phone description: >- - parameters: + parameters: - name: X-HTM-JWT-AUTH-HEADER in: header schema: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -690,7 +690,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP requestBody: content: application/json: @@ -728,7 +728,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -742,7 +742,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP - name: phoneId in: path required: true @@ -754,7 +754,7 @@ paths: application/json: schema: $ref: "#/components/schemas/phoneEntity" - examples: + examples: updateFullPhoneEntity: value: phone: @@ -789,7 +789,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -803,7 +803,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP - name: phoneId in: path required: true @@ -816,7 +816,7 @@ paths: content: application/json: {} x-auth-type: Application & Application User - x-throttling-tier: Unlimited + x-throttling-tier: Unlimited /customers/billinginformations: get: tags: @@ -831,7 +831,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -845,7 +845,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP responses: 200: description: OK @@ -866,7 +866,7 @@ paths: "billingInformationId": 1, "iban": "NL••••••••••••1234", "ascription": "J. Doe", - "alias": null, + "alias": null, "created": "2024-10-20T17:05:52.000", }, ], @@ -875,7 +875,7 @@ paths: get: tags: - Customers - summary: Find direct debit mandates for a customer. + summary: Find direct debit mandates for a customer. description: Find direct debit mandates for a customer. parameters: - name: X-HTM-JWT-AUTH-HEADER @@ -884,7 +884,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -898,7 +898,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP responses: 200: description: OK @@ -914,12 +914,12 @@ paths: [ { "directDebitMandateId": 71, - "billingInformationId": + "billingInformationId": { "billingInformationId": 15, "iban": "NL••••••••••••1234", "ascription": "J. Doe", - "alias": null, + "alias": null, "created": "2024-10-20T17:05:52.000", }, "directDebitMandateType": @@ -1142,7 +1142,7 @@ paths: "ovPayTokenId": 1, "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34567", "alias": "MyToken", "tokenStatus": @@ -1225,7 +1225,7 @@ paths: "ovPayTokenId": 1, "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34567", "alias": "MyToken", "tokenStatus": @@ -1348,8 +1348,8 @@ paths: "ovPayTokenId": 1, "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, - "ovpasNumber": "OV34567", + { "tokenTypeId": 2, "name": "OV-pas physical" }, + "ovpasNumber": "OV34567", "alias": "MyToken", "tokenStatus": { "tokenStatusId": 2, "name": "Active" }, @@ -1446,7 +1446,7 @@ paths: "ovPayTokenId": 1, "xTat": "32089cc8-d187-47ff-a3a9-5c2558def811", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34567", "alias": "MyToken", "tokenStatus": @@ -1562,7 +1562,7 @@ paths: "ovPayTokenId": 1, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34567", "alias": "MyToken", "tokenStatus": @@ -1583,7 +1583,7 @@ paths: "ovPayTokenId": 6, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV54567", "alias": "MyToken", "tokenStatus": @@ -1605,7 +1605,7 @@ paths: "ovPayTokenId": 13, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34547", "alias": "MyToken", "tokenStatus": @@ -1627,7 +1627,7 @@ paths: "ovPayTokenId": 21, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34831", "alias": "Mijn OV Pas", "tokenStatus": @@ -1649,7 +1649,7 @@ paths: "ovPayTokenId": 28, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV34984", "alias": "Mijn OV Pas", "tokenStatus": @@ -1674,7 +1674,7 @@ paths: "ovPayTokenId": 115, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV54368", "alias": "My retired token", "tokenStatus": @@ -1696,7 +1696,7 @@ paths: "ovPayTokenId": 118, "xTat": "e7fa3392-646b-40e2-95a6-c417dc0b0969", "tokenType": - { "tokenTypeId": 2, "name": "OV-pas physical" }, + { "tokenTypeId": 2, "name": "OV-pas physical" }, "ovpasNumber": "OV98263", "alias": "My found token", "tokenStatus": @@ -2905,9 +2905,9 @@ paths: summary: "**INTEGRATIELAAG** Transfer old OVpay token to new OVpay token." description: |- **Note that this directly calls the integratielaag and not the Service Engine!** - First transfers all personal account data (if present), then all products, of an existing OVpay token + First transfers all personal account data (if present), then all products, of an existing OVpay token to a new OVpay token. The new token will also be persisted in the profile as a replacement - of the old token. This call is asynchronous, and progress can be monitored using the + of the old token. This call is asynchronous, and progress can be monitored using the `/customers/tokens/transfer/responsestatus/*` endpoint. tags: - Token Replace v2 @@ -2920,9 +2920,9 @@ paths: Transfer from a token without PAD to a new token: summary: Transfer from a token without PAD to a new token description: | - Transfer of a token without PAD to a new OVpay token. Note the new token in the request is always - identified by xTAT, regardless if the new token already exists in the customer profile. If the new - token does not exist in the customer profile, the user needs to provide an alias for the new token, + Transfer of a token without PAD to a new OVpay token. Note the new token in the request is always + identified by xTAT, regardless if the new token already exists in the customer profile. If the new + token does not exist in the customer profile, the user needs to provide an alias for the new token, and it will be created in the customer profile. value: { @@ -2936,11 +2936,11 @@ paths: Transfer from a token with PAD to a new token without existing PAD: summary: Transfer from a token with PAD to a new token without existing PAD description: | - Transfer of a token with PAD to a new token by xTAT without existing PAD. Note how this request is - different, since it has an e-mail address on which the new PAD should be created. This request may + Transfer of a token with PAD to a new token by xTAT without existing PAD. Note how this request is + different, since it has an e-mail address on which the new PAD should be created. This request may optionally provide an OTP for verification of th provided email address. - Also note the new token in the request is always identified by xTAT, regardless if the new token - already exists in the customer profile. If the new token does not exist in the customer profile, the + Also note the new token in the request is always identified by xTAT, regardless if the new token + already exists in the customer profile. If the new token does not exist in the customer profile, the user needs to provide an alias for the new token, and it will be created in the customer profile. value: { @@ -2957,8 +2957,8 @@ paths: summary: Transfer from a token with PAD to a new token with existing PAD description: | Transfer of a token with PAD to a new token by xTAT with existing PAD. - Note that the new token in the request is always identified by xTAT, regardless if the new token - already exists in the customer profile. If the new token does not exist in the customer profile, the + Note that the new token in the request is always identified by xTAT, regardless if the new token + already exists in the customer profile. If the new token does not exist in the customer profile, the user needs to provide an alias for the new token, and it will be created in the customer profile. value: { @@ -2996,7 +2996,7 @@ paths: Transfer of token started: description: | The transfer of the token was started successfully. The data of the token will be transferred - asynchronously. In the response body the consumer will find information on how to retrieve the + asynchronously. In the response body the consumer will find information on how to retrieve the processing status. value: { @@ -3038,7 +3038,7 @@ paths: - Token Replace v2 summary: "**INTEGRATIELAAG** Get the status of the initiated token transfer process." description: | - **Note that this directly calls the integratielaag and not the Service Engine!** Get the status of the + **Note that this directly calls the integratielaag and not the Service Engine!** Get the status of the asynchronous token transfer processing. responses: "200": @@ -3166,7 +3166,7 @@ paths: examples: Token transfer in progress: description: | - The transfer of the token is still in progress. The response body shows the details of the + The transfer of the token is still in progress. The response body shows the details of the processing status. value: { @@ -3347,7 +3347,7 @@ paths: in: query description: External id of the device you want to get the purchased HTM products for. schema: - type: string + type: string - name: ovpayTokenId in: query description: Id of the OVpay-token you want to get the purchased HTM products for. @@ -3380,9 +3380,9 @@ paths: } getTwoBarcodePurchasedProductsForDevice: summary: Two BarcodeTicket purchased products, one PendingActivation and one Active - description: |- - The first ticket (PendingActivation) shows the 30-day range in which the ticket can be activated - (using the PATCH endpoint) in the validityStart and validityEnd fields. The second ticket (Active) + description: |- + The first ticket (PendingActivation) shows the 30-day range in which the ticket can be activated + (using the PATCH endpoint) in the validityStart and validityEnd fields. The second ticket (Active) shows the actual validity period of the ticket after activation. value: { @@ -3401,14 +3401,14 @@ paths: "name": "Barcode", }, "orderId": "501B17EF-36C4-4039-B92C-6517969B464E", - "orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E", + "orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E", "ticketReference": "KJj43nejhbTxhrfef287", "serviceId": "HTM-4321-7654-7659", "issuedAt": "2026-03-21T09:01:35+01:00", "activatedAt": null, "blocked": false, - "cancelledAt": null, - "activateBefore": "2026-03-30", + "cancelledAt": null, + "activateBefore": "2026-03-30", "validityStart": null, "validityEnd": null, "barcode": null, @@ -3436,14 +3436,14 @@ paths: "name": "Barcode", }, "orderId": "501B17EF-36C4-4039-B92C-6517969B464E", - "orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E", + "orderLineId": "38B17EF-36C4-4039-B92C-4817969B464E", "ticketReference": "KJj43nejhbTxhr897287", "serviceId": "HTM-1234-7654-8945", "issuedAt": "2026-03-21T10:01:12+01:00", "activatedAt": "2026-03-21T12:45:01+01:00", "blocked": false, - "cancelledAt": null, - "activateBefore": null, + "cancelledAt": null, + "activateBefore": null, "validityStart": "2026-03-21T12:45:01+01:00", "validityEnd": "2026-03-21T14:45:01+01:00", "barcode": "iVBORw0KGgoAAAANSUhEUgAAAVwAAAFcAQAAAACsbTuBAAAFDElEQVR4Xu2bQa6rOhBEGzHwMEtgKewMyM5YCkvIkAGif50yyc/Tl770piZW9HSNywzqVlW3nXcjc83cusxnvsbMjBieuelf/bzGYz1jWCKmeGS+4g5grSwlz/IaI+JgEfzcvzQZo2yhxQgW7wDutLJrvVLzEInbVHLpM/tK5T7kHmNdbxssgqSipQj/0KLA24yqNvEWWRclpJKpefNgE7YZr/lj1eZ55wMYIWkUbZb7Xj/wH+BezvPkFJhQetmD+7AI2VuSEQMevANYESzqZh49VlEXIKOT7SDtseqnpz0Iyc2DJZezkEB5aaVKSvuF5FMwaIdB7wCGOgb5fFgus2wlKhPDpUiTlogr1tsHG7lfzcqYLlVnDHq6ylYn1OE54qd5cNC6aQxL0UQRy2YJJxCS8N4m273Gm4BJFAhzlytb5T4A0QrCYmUTrxd1bYNVgGqqPndH7vHwYqHLHf9cpO1pHJxU3Nq6vUbAVhXaocnTKO5cpK+4AViLitRwf8IQdYFwBkkKW7FzZxNh/AN/g5NHqXyed5MOz45kjkvKofpLYNwBrNBR/Dz9SKpTDkGd8CApZYonT24B7un56XKnoMeXkOBNHqTDk/NOmrrwyfIWYHe51O4kn4FBnfYbnHjqKuw3AGMreKOvC07DCAebHS5lAXWq5eKVA0HjYA2xM0MYCSMnqTqpx48ZVSmPTd15tT03AF+LVBuOgJoMqc2HL6Gy8nr1/K2DU+YpmKerd45fQ2ypzSFyq8coUM2D1yBksNWqOTWnjqvLpVYPvrt17f6BP+AaQk85zR4MarfHbAlSu/XhgGCJNg6mQNmASXnGhpZY+tKp93lywaY+SjcPhroCWx1BHFAnVemR81mdjEikWlllzYNrCM27bKVt7nInLplEnef6SfPFhb19MDmCbewcjtL/d7FwAzCqmShYzMd/qaPnp0AxV+SOpq5xMCnLZJOhZCNCZuIR4BWwL6un4luF5sE9N7CKXIJ2Zecncnt3vZ0it+hN7wNC6+DU/Ene1gj+lOOr4BDGilyT3D74NZ4OlYm2Xmx9t2rJN+kb7P3A/wUzV6lSQaonIoR3DUdy7vR1WQt782CrzrbbvTOdxwu2ZKy4MZXXflPzYJoVLg6GpbIVtLSb2JxduzEg+6Mm+R3AXECaHYRjG4nH2UIak7jSm9zXNQ9OLha2yhbUCT/vOA1VHUAGXpVuhpsHE7H7O0d6d2+i7rxeI2EVVMTm4wZg5vZUV2/nBUmoG5befZ0XERKkNg9O8zR9Rexls+WgldPRmTYHp90BrAIkqqYYnkmNGfvEY1E2Ijeu/3SQLKar1Q/8AX88eDqCRe3wZKJ89sVCRdaTZfvg/u8uFhoH14J0apHvil2rFwrUNtuDcXLOruNdvRoGB9ezgJXP2OrwN+mz8jl9lPab3Ob0NwDbVteFpEuX+7ylbHGdo5Oeny8y4vJgy2DniHhzQQp3c4yCkLwZvPbXk+INwKeqj6grVB/ha+dC88LVfec3zR/q2gYnlyO5GD+Kvfp03unruKCUygJb1e8HmwdbPp2pg8fgr3XYnE6YQGUWUp20Dz6hSgReznmXY3hLJ5A2ozJT9wN/gfVIEbzBsxvdYSneL571OV279S+/jubBiuCzAL5qt5xHPNHMcHgciSuD15rXbYMtJFbE1piEkEi0fPp6AoLX5Lvjt+paBvOIRQjSEEHaCX5BSP4DBSalHh4bB/8DVeIFt2RfPhQAAAAASUVORK5CYII=", @@ -3499,7 +3499,7 @@ paths: "barcodeTickets":[], "vouchers":[] } - } + } getSingleVoucherPurchasedProductForCustomer: summary: One voucher purchased product value: @@ -3523,7 +3523,7 @@ paths: "voucherStatus": { "voucherStatusId": 2, "name": "issued" - }, + }, "mandatoryCustomerDataItems": [ { @@ -3538,7 +3538,7 @@ paths: } ] } - } + } /purchasedproducts/{purchasedProductId}: parameters: - name: X-HTM-JWT-AUTH-HEADER @@ -3586,7 +3586,7 @@ paths: value: { "status": "Active" - } + } responses: "200": description: OK @@ -3732,7 +3732,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -3746,7 +3746,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP post: tags: - AGO @@ -3756,7 +3756,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" + $ref: "#/components/schemas/ActivateAgoRequest" examples: For self: value: @@ -3861,7 +3861,7 @@ paths: type: string example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c required: false - description: The JWT of a customer in case of touchpoint were customer logs in themselves + description: The JWT of a customer in case of touchpoint were customer logs in themselves - name: X-HTM-CUSTOMER-PROFILE-ID-HEADER in: header schema: @@ -3875,7 +3875,7 @@ paths: type: string example: Customer required: false - description: The role of the HTM employee in the case of the SMP + description: The role of the HTM employee in the case of the SMP post: tags: - AGO @@ -3885,7 +3885,7 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/unavailable" + $ref: "#/components/schemas/VerifyOtpRequest" example: otp: 123456 responses: @@ -4048,7 +4048,7 @@ components: customerProfileId: type: integer example: 1 - customerPreference: + customerPreference: $ref: "#/components/schemas/getCustomerPreference" customerNumber: type: integer @@ -4249,12 +4249,12 @@ components: customerPreferenceId: type: integer languageId: - type: integer + type: integer customerStatusEntity: type: object properties: customerStatusId: - type: integer + type: integer OvPayTokensResponse: type: object required: @@ -4533,7 +4533,7 @@ components: items: type: object required: - - purchasedProductId + - purchasedProductId - productId - name - status @@ -4656,13 +4656,13 @@ components: type: string example: HTM 2 uurskaart description: |- - The name of the originating HTM product definition. + The name of the originating HTM product definition. Will be returned in the language as specified in the Accept-Language header or the customer profile. Otherwise defaults to NL. description: type: string example: "Met deze kaart reis je 2 uur lang onbeperkt met de bussen en trams van HTM. Overstappen is natuurlijk toegestaan!" description: |- - The description of the originating HTM product definition. + The description of the originating HTM product definition. Will be returned in the language as specified in the Accept-Language header or the customer profile. Otherwise defaults to NL. status: type: string @@ -4721,15 +4721,15 @@ components: example: "2024-11-30" description: Only present for barcode tickets that are not yet activated. Tickets can only be activated BEFORE this date. validityStart: - description: |- - Only present for barcode tickets that have been activated. The date-time at which the ticket will become valid for traveling. + description: |- + Only present for barcode tickets that have been activated. The date-time at which the ticket will become valid for traveling. The ticket will not be valid before this date/time. type: string format: date-time-offset example: "2024-11-25T13:25:00+01:00" validityEnd: - description: |- - Only present for barcode tickets that have been activated. The date-time at which the ticket will become invalid for traveling. + description: |- + Only present for barcode tickets that have been activated. The date-time at which the ticket will become invalid for traveling. The ticket will not be valid after this date/time. type: string format: date-time-offset @@ -4928,7 +4928,7 @@ components: description: >- A ValidateTatOutputDescription IS A string that provides more details about the OTP validation result. - example: TAT Secured + example: TAT Secured TatUnsecured: type: object description: A TatUnsecured IS AN object THAT represents the response of TAT security @@ -4938,7 +4938,20 @@ components: example: Success description: type: string - example: TAT Unsecured + example: TAT Unsecured + ActivateAgoRequest: + type: object + properties: + emailAddress: + type: string + format: email + example: stasjo@htm.nl + VerifyOtpRequest: + type: object + properties: + emailAddress: + type: string + example: 123456 ErrorResponse: description: Default response when an invalid request has been sent type: object