ojp-shared-types/openapi/ojp-tr-request.yml at main · openTdataCH/ojp-shared-types · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
openapi: 3.0.3
info:
  title: XML OJP 2.0 API
  description: API that returns trip data in XML format.
  version: 0.0.1

servers:
  - url: https://api.example.com

paths:
  /ojp:
    post:
      summary: Main /ojp endpoint
      description: Main /ojp endpoint
      responses:
        "200":
          description: Successful response
          content:
            application/xml:
              schema:
                $ref: "#/components/schemas/OJP"
        "500":
          description: Server error

components:
  schemas:
    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__TripParamStructure
    TripParam:
      type: object
      xml:
        name: Params
      properties:
        modeAndModeOfOperationFilter:
          type: array
          xml:
            name: ModeAndModeOfOperationFilter
          items:
            $ref: "./ojp-shared.yml#/components/schemas/ModeFilterStructure"
        lineFilter:
          $ref: "./ojp-shared.yml#/components/schemas/LineDirectionFilterStructure"
          xml:
            name: LineFilter
        operatorFilter:
          $ref: "./ojp-shared.yml#/components/schemas/OperatorFilterStructure"
          xml:
            name: OperatorFilter
        vehicleFilter:
          $ref: "./ojp-shared.yml#/components/schemas/VehicleFilterStructure"
          xml:
            name: VehicleFilter
        bikeTransport:
          type: boolean
          xml:
            name: BikeTransport
        walkSpeed:
          type: number
          xml:
            name: WalkSpeed
        numberOfResults:
          type: number
          xml:
            name: NumberOfResults
        numberOfResultsBefore:
          type: number
          xml:
            name: NumberOfResultsBefore
        numberOfResultsAfter:
          type: number
          xml:
            name: NumberOfResultsAfter
        useRealtimeData:
          $ref: "./ojp-shared.yml#/components/schemas/UseRealtimeDataEnum"
          xml:
            name: UseRealtimeData
        optimisationMethod:
          $ref: "./ojp-shared.yml#/components/schemas/OptimisationMethodEnum"
          xml:
            name: OptimisationMethod
        includeAllRestrictedLines:
          type: boolean
          xml:
            name: IncludeAllRestrictedLines
        itModeToCover:
          type: array
          xml:
            name: ItModeToCover
          items:
            $ref: './ojp-shared.yml#/components/schemas/ItModesStructure'
        includeTrackSections:
          type: boolean
          xml:
            name: IncludeTrackSections
        includeLegProjection:
          type: boolean
          xml:
            name: IncludeLegProjection
        includeTurnDescription:
          type: boolean
          xml:
            name: IncludeTurnDescription
        includeIntermediateStops:
          type: boolean
          xml:
            name: IncludeIntermediateStops

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__TripViaStructure
    ViaPoint:
      type: object
      xml:
        name: ViaPoint
      required:
        - viaPoint
      properties:
        viaPoint:
          $ref: './ojp-shared.yml#/components/schemas/PlaceRef'
          xml:
            name: PlaceRef
        dwellTime:
          type: string
          xml:
            name: DwellTime

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__OJPTripRequestStructure
    OJPTripRequest:
      type: object
      xml:
        name: OJPTripRequest
      required:
        - requestTimestamp
        - origin
        - destination
        - via
      properties:
        requestTimestamp:
          type: string
          xml:
            name: RequestTimestamp
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        origin:
          $ref: './ojp-shared.yml#/components/schemas/PlaceContext'
          xml:
            name: Origin
        destination:
          $ref: './ojp-shared.yml#/components/schemas/PlaceContext'
          xml:
            name: Destination
        via:
          type: array
          xml:
            name: Via
          items:
            $ref: "#/components/schemas/ViaPoint"
        params:
          $ref: '#/components/schemas/TripParam'
          xml:
            name: Params

    OJP:
      type: object
      xml:
        name: OJP
      required:
        - OJPRequest
      properties:
        OJPRequest:
          type: object
          xml:
            name: OJPRequest
          required:
            - serviceRequest
          properties:
            serviceRequest:
              type: object
              xml:
                name: ServiceRequest
                namespace: "http://www.siri.org.uk/siri"
                prefix: siri
              required:
                - requestTimestamp
                - requestorRef
                - OJPTripRequest
              properties:
                serviceRequestContext:
                  $ref: './ojp-shared.yml#/components/schemas/ServiceRequestContext'
                  xml:
                    name: ServiceRequestContext
                requestTimestamp:
                  type: string
                  xml:
                    name: RequestTimestamp
                    namespace: "http://www.siri.org.uk/siri"
                    prefix: siri
                requestorRef:
                  type: string
                  xml:
                    name: RequestorRef
                    namespace: "http://www.siri.org.uk/siri"
                    prefix: siri
                OJPTripRequest:
                  $ref: '#/components/schemas/OJPTripRequest'
                  xml:
                    name: OJPTripRequest