From a7e32f61222dc206d3503b4cd29b61e0ca803b0c Mon Sep 17 00:00:00 2001 From: "b.boterman@htm.nl" Date: Thu, 5 Mar 2026 12:37:04 +0100 Subject: [PATCH] OVPAY-2473 - Added examples for GET trip details. --- src/openapi/customers/customers-trips.yaml | 331 +++++++++++++++++++++ 1 file changed, 331 insertions(+) diff --git a/src/openapi/customers/customers-trips.yaml b/src/openapi/customers/customers-trips.yaml index 36dfce5..c94b264 100644 --- a/src/openapi/customers/customers-trips.yaml +++ b/src/openapi/customers/customers-trips.yaml @@ -208,6 +208,337 @@ paths: application/json: schema: $ref: '#/components/schemas/getTrips' + examples: + completedTripDetails: + summary: Example of a completed trip + value: + tripId: 66538 + tripVersion: 2 + tripStatus: COMPLETE + tripFareNature: FIXED + paymentMethodId: dba0b896-118d-4e9e-abf5-af264ced34c4 + paymentMethodMode: BAL + paymentMethodName: BAL + paymentProviderName: Account Balance + paymentProviderBusinessEntityId: "4" + paymentProviderCommercialName: VAD Flex + paymentProviderCommercialUrl: https://www.vad.nl/mijnvad + organisationIcon: /icons/organisations/4.svg + organisationId: "4" + organisationName: NS + supersededByTripIds: + - 66539 + - 66540 + supersedesTripIds: [] + tripStartTxnId: 1125977 + tripEndTxnId: 1125978 + numberOfSyntheticLegs: 3 + numberofSyntheticTrips: 2 + products: + - productTemplateId: "N/A" + purchaseDateTime: 2021-06-02T08:38:32Z + appliedValue: 2470 + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: SALES + typesOfFareProduct: + - privateCode: payg + fareAggregationCycle: 2 + - xpit: 72c11b8d-5a96-4cc2-9fc8-258a25b57f69 + productTemplateId: "1:2001" + productCommercialName: + items: + - key: nl-NL + value: Pay As You Go Program (NL) + - key: en-US + value: Pay As You Go Program + validFrom: 2021-06-02T08:38:32Z + validUntil: 2099-12-31T23:59:59Z + weight: 2470 + appliedMetric: FARE + appliedValue: 2470 + xprofit: 0eb178f7-c548-417e-a44f-7248a582ac9d + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: INTERNAL + typesOfFareProduct: + - privateCode: payg + checkinTransactionTimestamp: 2021-06-01T06:00:00Z + checkoutTransactionTimestamp: 2021-06-01T06:22:00Z + checkinTransactionReference: 001e8481;1151;gemaltoPure + checkoutTransactionReference: 001e8481;1152;gemaltoPure + checkinLocation: + stopId: 621 + stopName: + items: + - key: nl-NL + value: Utrecht Centraal + - key: en-US + value: Utrecht Centraal + stopDesc: Station Utrecht Centraal + stopUrl: /icons/stops/stop.svg + locationType: 0 + checkoutLocation: + stopId: 253 + stopName: + items: + - key: nl-NL + value: Goes + - key: en-US + value: Goes + stopDesc: Station Goes + stopUrl: /icons/stops/stop.svg + locationType: 0 + xbot: 36637b86-7a31-4b77-99dd-2d39b9c1a9b6 + tokenType: GemaltoPure + transportType: RAIL + lineId: "10" + networkId: "1" + networkName: HRN + vehicleId: 123 + currency: EUR + transportIcon: /icons/transportTypes/rail.svg + legs: + - legId: 83387 + checkinTransactionTimestamp: 2021-06-01T06:00:00Z + checkoutTransactionTimestamp: 2021-06-01T06:22:00Z + checkinLocation: + stopId: 621 + stopName: + items: + - key: nl-NL + value: Utrecht Centraal + - key: en-US + value: Utrecht Centraal + stopDesc: Station Utrecht Centraal + stopUrl: /icons/stops/stop.svg + locationType: 0 + checkoutLocation: + stopId: 253 + stopName: + items: + - key: nl-NL + value: Goes + - key: en-US + value: Goes + stopDesc: Station Goes + stopUrl: /icons/stops/stop.svg + locationType: 0 + baseRate: 2470 + lineId: "10" + networkId: "1" + networkName: HRN + fare: 2470 + fareState: CALCULATED + currency: EUR + products: + - productTemplateId: "N/A" + purchaseDateTime: 2021-06-02T08:38:32Z + appliedValue: 2470 + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: SALES + typesOfFareProduct: + - privateCode: payg + - xpit: 72c11b8d-5a96-4cc2-9fc8-258a25b57f69 + productTemplateId: "1:2001" + productCommercialName: + items: + - key: nl-NL + value: Pay As You Go Program (NL) + - key: en-US + value: Pay As You Go Program + validFrom: 2021-06-02T08:38:32Z + validUntil: 2099-12-31T23:59:59Z + weight: 2470 + appliedMetric: FARE + appliedValue: 2470 + xprofit: 0eb178f7-c548-417e-a44f-7248a582ac9d + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: INTERNAL + typesOfFareProduct: + - privateCode: payg + appliedTimePeriods: [] + tariffJourneyStart: true + tariffDistance: 9 + aggrGeoIntervalDistance: 9 + topoDistance: 0 + concessionId: "1" + tripLegIdx: 0 + appliedZones: + - zoneId: "73" + zoneName: + items: + - key: nl-NL + value: Enschede-Glanerburg + - key: en-US + value: Enschede-Glanerburg + lastUpdatedTripDateTime: 2021-06-01T06:22:00Z + fare: 2470 + loyaltyOrDiscount: false + supportCode: wYyM3nDb2Uy5ge + checkinTransactionId: 001e8481-1151-gemaltoPure-1622527200000 + checkoutTransactionId: 001e8481-1152-gemaltoPure-1622528520000 + tariffVersionId: NS:5 + correlationId: c3ae1ba3-780a-4416-8a38-3fd03a9005b7 + createdAt: 2021-06-02T15:03:46.813Z + missingCkoTripDetails: + summary: Example of a trip with missing check-out + value: + tripId: 66538 + tripVersion: 2 + tripStatus: MISSING_CKO + tripFareNature: FIXED + paymentMethodId: dba0b896-118d-4e9e-abf5-af264ced34c4 + paymentMethodMode: BAL + paymentMethodName: BAL + paymentProviderName: Account Balance + paymentProviderBusinessEntityId: "4" + paymentProviderCommercialName: VAD Flex + paymentProviderCommercialUrl: https://www.vad.nl/mijnvad + organisationIcon: /icons/organisations/4.svg + organisationId: "4" + organisationName: NS + supersededByTripIds: + - 66539 + - 66540 + supersedesTripIds: [] + tripStartTxnId: 1125977 + tripEndTxnId: 1125978 + numberOfSyntheticLegs: 3 + numberofSyntheticTrips: 2 + products: + - productTemplateId: "N/A" + purchaseDateTime: 2021-06-02T08:38:32Z + appliedValue: 2470 + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: SALES + typesOfFareProduct: + - privateCode: payg + fareAggregationCycle: 2 + - xpit: 72c11b8d-5a96-4cc2-9fc8-258a25b57f69 + productTemplateId: "1:2001" + productCommercialName: + items: + - key: nl-NL + value: Pay As You Go Program (NL) + - key: en-US + value: Pay As You Go Program + validFrom: 2021-06-02T08:38:32Z + validUntil: 2099-12-31T23:59:59Z + weight: 2470 + appliedMetric: FARE + appliedValue: 2470 + xprofit: 0eb178f7-c548-417e-a44f-7248a582ac9d + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: INTERNAL + typesOfFareProduct: + - privateCode: payg + checkinTransactionTimestamp: 2021-06-01T06:00:00Z + checkoutTransactionTimestamp: 2021-06-01T06:22:00Z + checkinTransactionReference: 001e8481;1151;gemaltoPure + checkoutTransactionReference: 001e8481;1152;gemaltoPure + checkinLocation: + stopId: 621 + stopName: + items: + - key: nl-NL + value: Utrecht Centraal + - key: en-US + value: Utrecht Centraal + stopDesc: Station Utrecht Centraal + stopUrl: /icons/stops/stop.svg + locationType: 0 + checkoutLocation: + stopId: 253 + stopName: + items: + - key: nl-NL + value: Goes + - key: en-US + value: Goes + stopDesc: Station Goes + stopUrl: /icons/stops/stop.svg + locationType: 0 + xbot: 36637b86-7a31-4b77-99dd-2d39b9c1a9b6 + tokenType: GemaltoPure + transportType: RAIL + lineId: "10" + networkId: "1" + networkName: HRN + vehicleId: 123 + currency: EUR + transportIcon: /icons/transportTypes/rail.svg + legs: + - legId: 83387 + checkinTransactionTimestamp: 2021-06-01T06:00:00Z + checkoutTransactionTimestamp: null + checkinLocation: + stopId: 621 + stopName: + items: + - key: nl-NL + value: Utrecht Centraal + - key: en-US + value: Utrecht Centraal + stopDesc: Station Utrecht Centraal + stopUrl: /icons/stops/stop.svg + locationType: 0 + checkoutLocation: null + baseRate: 400 + lineId: "10" + networkId: "1" + networkName: HRN + fare: 400 + fareState: CALCULATED + currency: EUR + products: + - productTemplateId: "N/A" + purchaseDateTime: 2021-06-02T08:38:32Z + appliedValue: 400 + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: SALES + typesOfFareProduct: + - privateCode: payg + - xpit: 72c11b8d-5a96-4cc2-9fc8-258a25b57f69 + productTemplateId: "1:2001" + productCommercialName: + items: + - key: nl-NL + value: Pay As You Go Program (NL) + - key: en-US + value: Pay As You Go Program + validFrom: 2021-06-02T08:38:32Z + validUntil: 2099-12-31T23:59:59Z + weight: 400 + appliedMetric: FARE + appliedValue: 400 + xprofit: 0eb178f7-c548-417e-a44f-7248a582ac9d + xspit: 39b9183d-767d-4364-9d1b-575613c12a96 + category: INTERNAL + typesOfFareProduct: + - privateCode: payg + appliedTimePeriods: [] + tariffJourneyStart: true + tariffDistance: 9 + aggrGeoIntervalDistance: 9 + topoDistance: 0 + concessionId: "1" + tripLegIdx: 0 + appliedZones: + - zoneId: "73" + zoneName: + items: + - key: nl-NL + value: Enschede-Glanerburg + - key: en-US + value: Enschede-Glanerburg + lastUpdatedTripDateTime: 2021-06-01T06:22:00Z + fare: 2470 + loyaltyOrDiscount: false + supportCode: wYyM3nDb2Uy5ge + checkinTransactionId: 001e8481-1151-gemaltoPure-1622527200000 + checkoutTransactionId: null + tariffVersionId: NS:5 + correlationId: c3ae1ba3-780a-4416-8a38-3fd03a9005b7 + createdAt: 2021-06-02T15:03:46.813Z '400': description: '400' content: