ojp-shared-types/openapi/ojp-ser-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
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__StopEventParamStructure
    StopEventParam:
      type: object
      xml:
        name: StopEventParam
      properties:
        includeAllRestrictedLines:
          type: boolean
          xml:
            name: IncludeAllRestrictedLines
        numberOfResults:
          type: number
          xml:
            name: NumberOfResults
        stopEventType:
          type: string
          # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__StopEventTypeEnumeration
          enum: [departure, arrival, both]
          xml:
            name: StopEventType
        includePreviousCalls:
          type: boolean
          xml:
            name: IncludePreviousCalls
        includeOnwardCalls:
          type: boolean
          xml:
            name: IncludeOnwardCalls
        useRealtimeData:
          $ref: "./ojp-shared.yml#/components/schemas/UseRealtimeDataEnum"
          xml:
            name: UseRealtimeData

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__PlaceContextStructure
    PlaceContext:
      type: object
      xml:
        name: OJPStopEventRequest
      required:
        - placeRef
      properties:
        placeRef:
          $ref: './ojp-shared.yml#/components/schemas/PlaceRef'
          xml:
            name: PlaceRef
        depArrTime:
          type: string
          xml:
            name: DepArrTime

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__OJPLocationInformationRequestStructure
    OJPStopEventRequest:
      type: object
      xml:
        name: OJPStopEventRequest
      required:
        - requestTimestamp
        - location
      properties:
        requestTimestamp:
          type: string
          xml:
            name: RequestTimestamp
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        location:
          $ref: '#/components/schemas/PlaceContext'
          xml:
            name: Location
        params:
          $ref: '#/components/schemas/StopEventParam'
          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
                - OJPStopEventRequest
              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
                OJPStopEventRequest:
                  $ref: '#/components/schemas/OJPStopEventRequest'
                  xml:
                    name: OJPStopEventRequest