diff --git a/src/openapi/customers/customers-trips.yaml b/src/openapi/customers/customers-trips.yaml index 00726bb..4f924ed 100644 --- a/src/openapi/customers/customers-trips.yaml +++ b/src/openapi/customers/customers-trips.yaml @@ -1,6 +1,6 @@ openapi: 3.0.1 info: - title: ABTCustomers + title: ABT Customer Self Service APIs version: '1.0' servers: - url: https://services.acc.api.htm.nl/abt/abtcustomers/1.0 @@ -10,7 +10,7 @@ paths: /customers/tokens/{ovpayTokenId}/trips: get: tags: - - Customer self-service trips + - Trips summary: Get trips for a token description: >- Get the most recent trips for a given token ID, as long as this token is @@ -173,7 +173,7 @@ paths: /customers/trips/{tripId}: get: tags: - - Customer self-service trips + - Trips summary: Get trips details for a trip and token description: >- Get the trip details for a given trip and token ID, as long as the trip @@ -243,6 +243,85 @@ paths: - default: [] x-auth-type: Application & Application User x-throttling-tier: Unlimited + /customers/tariff/stops: + get: + tags: + - Trips + summary: 9776 - Get Possible Stops With Details + operationId: API-9776v3_getPossibleStopsWithDetails + description: Get Possible Stops With Details + security: + - OAuthAuthorization: + - default + parameters: + - name: X-HTM-JWT-AUTH-HEADER + in: header + required: true + style: simple + explode: false + schema: + type: string + - name: xbot + description: >- + A xBOT IS AN unique identifier THAT is an external representation of + a backoffice Token for a particular Business Entity + in: query + required: true + schema: + type: string + format: uuid + - name: tripId + in: query + description: A tripId IS AN identifier THAT distinguishes a Trip from all other Trips + required: true + schema: + type: integer + format: int64 + - name: transactionId + in: query + description: >- + A transactionId IS A unique identifier THAT is generated by the GBO + and assigned to every Transaction that is received + required: true + schema: + type: string + responses: + '200': + description: Success with results + content: + application/json: + schema: + $ref: '#/components/schemas/MissingCkiCkoRequest' + '400': + description: '400' + content: + application/json: + schema: + $ref: '#/components/schemas/400Response' + '401': + description: '401' + content: + application/json: + schema: + $ref: '#/components/schemas/401Response' + '403': + description: '403' + content: + application/json: + schema: + $ref: '#/components/schemas/403Response' + '404': + description: '404' + content: + application/json: + schema: + $ref: '#/components/schemas/404Response' + '500': + description: '500' + content: + application/json: + schema: + $ref: '#/components/schemas/500Response' components: schemas: getTokenTrips: @@ -599,6 +678,131 @@ components: type: string createdAt: type: string + MissingCkiCkoRequest: + type: object + properties: + xbot: + type: string + description: >- + A xBOT IS AN unique identifier THAT is an external representation of + a backoffice Token for a particular Business Entity + counterpartTransactionId: + type: string + description: >- + A counterpartTransactionId IS A unique identifier THAT assigned to + every Transaction that is received + counterpartEntryExitType: + type: string + description: >- + AN counterpartEntryExitType IS AN direction indicator THAT describes + a possible direction indicated by the callee that created the + Transaction + counterpartTimeStamp: + type: string + description: >- + A counterpartTimeStamp IS A date, time and time zone indication THAT + describes when the Transaction was created either by a Device or + callee + counterpartStop: + $ref: '#/components/schemas/ScheduledStopPointData' + deviceId: + type: string + description: >- + A deviceId IS AN unique identifier THAT distinguishes a Device from + all other Devices + deviceClassId: + type: string + description: >- + A deviceClassId IS AN enumerated identifier THAT describes the type + of Device responsible for creating the Transaction + scheduledStopPoints: + type: array + items: + $ref: '#/components/schemas/ScheduledStopPointData' + ScheduledStopPointData: + type: object + properties: + alternativeTexts: + type: array + items: + $ref: '#/components/schemas/AlternativeText' + name: + type: string + description: >- + A name IS A string THAT is used to described name of the + TariffLocation name + shortName: + type: string + description: >- + A shortName IS AN abbreviation THAT contains a shortened version of + the TariffLocation name + description: + type: string + description: >- + A description IS A string THAT is used as an additional label of the + TariffLocation as defined in the Tariff Fragment + location: + $ref: '#/components/schemas/Location' + stopId: + type: string + description: >- + A stopId IS A unique identifier THAT distinguishes a Tariff Location + from all other Tariff Locations + transportModes: + type: array + description: >- + A transportMode IS AN identifier THAT describes the mode of + transport + items: + type: string + AlternativeText: + type: object + description: >- + AN AlternativeText IS AN object THAT contains values to enable one or + more language translations + properties: + text: + type: object + description: >- + A text is AN wrapper THAT is used as an abstraction layer to contain + the properties of AlternativeText + properties: + lang: + type: string + description: >- + A lang IS AN enumerated identifier THAT describes the language + of the text within the AlternativeText object + example: en-US + textIdType: + type: string + description: A textIdType IS AN name THAT is used to categorize types of text + example: publicName + text: + type: string + description: >- + A text IS A name THAT has been translated to a particular + language + example: Default Travel Entitlement + Location: + type: object + properties: + longitude: + type: number + description: >- + A longitude IS A number THAT represents the geographic coordinate + that specifies the east-west position of a point on the surface of + the Earth + latitude: + type: number + description: >- + A latitude IS A number THAT represents the geographic coordinate + that specifies the north-south position of a point on the surface of + the Earth + altitude: + type: number + description: >- + AN altitude IS A number THAT represents the height of an object or + point in relation to sea level or ground level 400Response: type: object properties: