ojp-shared-types/openapi/ojp-lir-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
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__PlaceParamStructure
    PlaceParam:
      type: object
      xml:
        name: PlaceParam
      required:
        - type
      properties:
        type:
          type: array
          items:
            $ref: "./ojp-shared.yml#/components/schemas/PlaceTypeEnum"
          xml:
            name: Type
        modes:
          $ref: "./ojp-shared.yml#/components/schemas/ModeFilterStructure"
          xml:
            name: Modes
        pointOfInterestFilter:
          $ref: "./ojp-shared.yml#/components/schemas/PointOfInterestFilterStructure"
          xml:
            name: PointOfInterestFilter
        numberOfResults:
          type: number
          xml:
            name: NumberOfResults
        includePtModes:
          type: boolean
          xml:
            name: IncludePtModes

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__InitialLocationInputStructure
    InitialInput:
      type: object
      xml:
        name: InitialInput
      properties:
        name:
          type: string
          xml:
            name: Name
        geoRestriction:
          $ref: './ojp-shared.yml#/components/schemas/GeoRestrictionsStructure'
          xml:
            name: GeoRestriction

    # https://vdvde.github.io/OJP/develop/documentation-tables/ojp.html#type_ojp__OJPLocationInformationRequestStructure
    OJPLocationInformationRequest:
      type: object
      xml:
        name: OJPLocationInformationRequest
      required:
        - requestTimestamp
      properties:
        requestTimestamp:
          type: string
          xml:
            name: RequestTimestamp
            namespace: "http://www.siri.org.uk/siri"
            prefix: siri
        initialInput:
          $ref: '#/components/schemas/InitialInput'
          xml:
            name: InitialInput
        placeRef:
          $ref: './ojp-shared.yml#/components/schemas/PlaceRef'
          xml:
            name: PlaceRef
        restrictions:
          $ref: '#/components/schemas/PlaceParam'
          xml:
            name: Restrictions

    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
                - OJPLocationInformationRequest
              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
                OJPLocationInformationRequest:
                  $ref: '#/components/schemas/OJPLocationInformationRequest'
                  xml:
                    name: OJPLocationInformationRequest