A CARRIS também disponibiliza dados publicamente nos formatos GTFS e GTFS-RT através do seu portal do programador (https://gateway.carris.pt/apiui/#!/)
36 |
37 | ```javascript
38 | {
39 | "token": "string", //o valor desta chave é token de app fornecido pela carris
40 | "type": "string" //o valor desta chave deverá ser "apikey" no primeiro request
41 | }
42 | ```
43 |
Resposta
44 |
45 | ```javascript
46 | {
47 | "authorizationToken": "string", // guardar token JWT a usar em todas os outros pedidos
48 | "refreshToken": "string", // guardar token para atualizar o token expirado
49 | "expires": int // data de expiração do token em segundos desde a Era Unix/Unix Epoch
50 | }
51 | ```
52 |
53 |
Pode descodificar o token JWT "authorizationToken" e saber mais sobre a norma JWT em JWT.io
54 |
55 |
68 |
69 | ```
70 | A resposta depende do endpoint que escolher.
71 | Será dada no formato JSON.
72 | ```
73 |
74 |
..::Refresh/Atualização::..
75 |
Trocar o seu authenticationToken inválido por um válido
76 |
Após aproximadamente 15 minutos (se preferir, calcule a hora de criação do token com a hora de expiração do mesmo para obter o tempo de vida do token), o seu authorizationToken irá expirar. Recolha o refreshToken que obteu em Autenticação Inicial e inclua-o no corpo do seu pedido. Ser-lhe-á atribuído um novo authorizationToken válido.
77 |
78 |
Repita este processo ao longo do tempo de vida da sua aplicação (faça um novo pedido de Autenticação Inicial se o tempo de vida da app for reiniciado). A cada 15 minutos, revogue o authorizationToken atual e atualize-o - e assim sucessivamente.
79 |
80 |
Pedido
81 |
Agora, deverá recolher o refreshToken obtido em Autenticação Inicial e faça dele o valor da chave "token". Indique que o token é de atualização, mudando o valor da chave "type" para "refresh".
82 |
83 | ```javascript
84 | {
85 | "token": "string", // token de refresh
86 | "type": "string" // o valor desta chave deve ser "refresh" aquando da atualização do seu token
87 | }
88 | ```
89 |
Resposta
90 |
Esta resposta será igual à obtida em Autenticação Inicial. Recolha os valores da chave e use-os nos seus próximos pedidos, de forma a manter um flow de tokens contínuo. Aquando do término de mais um período de 15 minutos, volte a atualizar o seu authorizationToken e assim sucessivamente!
91 |
92 | ```javascript
93 | {
94 | "authorizationToken": "string", // guardar token a usar em todas os outros pedidos
95 | "refreshToken": "string", // guardar token para atualizar o token expirado
96 | "expires": int // data de expiração do token em segundos desde a Era Unix/Unix Epoch
97 | }
98 | ```
99 |
100 |
101 |
Divirta-se e partilhe os seus projetos connosco!
102 |
Não hesite em contactar para mais informações!
103 |
Os Pull Requests e Issues são bem-vindos :)
104 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published
637 | by the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/docs/swagger.json:
--------------------------------------------------------------------------------
1 | {
2 | "openapi": "3.0.0",
3 | "info": {
4 | "title": "XTranPassengerAPI 2.10",
5 | "description": "Documentation of the XTranPassengerAPI 2.10 methods.",
6 | "version": "2.10-oas3"
7 | },
8 | "servers": [
9 | {
10 | "url": "https://gateway.carris.pt/gateway"
11 | }
12 | ],
13 | "paths": {
14 | "/authenticationapi/authorization/sign": {
15 | "post": {
16 | "tags": [
17 | "Authentication"
18 | ],
19 | "summary": "Returns tokens for authorization purposes.",
20 | "operationId": "GetBearerTokenJWT",
21 | "requestBody": {
22 | "description": "Parameters to obtain or refresh authenticationToken.",
23 | "content": {
24 | "application/json": {
25 | "schema": {
26 | "$ref": "#/components/schemas/body"
27 | }
28 | }
29 | }
30 | },
31 | "responses": {
32 | "200": {
33 | "description": "OK"
34 | },
35 | "400": {
36 | "description": "Bad Request - check POST request body."
37 | }
38 | }
39 | }
40 | },
41 | "/xtranpassengerapi/api/v2.10/alerts": {
42 | "get": {
43 | "tags": [
44 | "Alerts"
45 | ],
46 | "summary": "Returns of alerts for the public.",
47 | "operationId": "GetAlerts",
48 | "responses": {
49 | "200": {
50 | "description": "Success",
51 | "content": {
52 | "text/plain": {
53 | "schema": {
54 | "uniqueItems": false,
55 | "type": "array",
56 | "items": {
57 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.AlertDto"
58 | }
59 | }
60 | },
61 | "text/html": {
62 | "schema": {
63 | "uniqueItems": false,
64 | "type": "array",
65 | "items": {
66 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.AlertDto"
67 | }
68 | }
69 | },
70 | "application/json": {
71 | "schema": {
72 | "uniqueItems": false,
73 | "type": "array",
74 | "items": {
75 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.AlertDto"
76 | }
77 | }
78 | },
79 | "text/json": {
80 | "schema": {
81 | "uniqueItems": false,
82 | "type": "array",
83 | "items": {
84 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.AlertDto"
85 | }
86 | }
87 | }
88 | }
89 | }
90 | },
91 | "security": [
92 | {
93 | "Authorization": []
94 | }
95 | ]
96 | }
97 | },
98 | "/xtranpassengerapi/api/v2.10/busstops/routenumber/{routeNumber}/laststation/{lastStation}/startLat/{lat}/startLon/{lon}/numberbusstops/{nBusStops}": {
99 | "get": {
100 | "tags": [
101 | "BusStops"
102 | ],
103 | "summary": "Returns the list of stations for a specific route, given a specific number of parameters received from Google.",
104 | "operationId": "GetStationsForStep",
105 | "parameters": [
106 | {
107 | "name": "routeNumber",
108 | "in": "path",
109 | "description": "The route public number. (Example: 12E)",
110 | "required": true,
111 | "style": "simple",
112 | "explode": false,
113 | "schema": {
114 | "type": "string"
115 | }
116 | },
117 | {
118 | "name": "lastStation",
119 | "in": "path",
120 | "description": "The headsign ('terminus') of a route (Example: Sta. Apolonia)",
121 | "required": true,
122 | "style": "simple",
123 | "explode": false,
124 | "schema": {
125 | "type": "string"
126 | }
127 | },
128 | {
129 | "name": "lat",
130 | "in": "path",
131 | "description": "The starting latitude coordinates to match to a bus stop (Example: 38.725311).",
132 | "required": true,
133 | "style": "simple",
134 | "explode": false,
135 | "schema": {
136 | "type": "number",
137 | "format": "double"
138 | }
139 | },
140 | {
141 | "name": "lon",
142 | "in": "path",
143 | "description": "The starting longitude coordinates to match to a bus stop (Example: -9.151905).",
144 | "required": true,
145 | "style": "simple",
146 | "explode": false,
147 | "schema": {
148 | "type": "number",
149 | "format": "double"
150 | }
151 | },
152 | {
153 | "name": "nBusStops",
154 | "in": "path",
155 | "description": "Number of bus stops to return as list result (Example: 4).",
156 | "required": true,
157 | "style": "simple",
158 | "explode": false,
159 | "schema": {
160 | "type": "integer",
161 | "format": "int32"
162 | }
163 | }
164 | ],
165 | "responses": {
166 | "200": {
167 | "description": "Success",
168 | "content": {
169 | "text/plain": {
170 | "schema": {
171 | "uniqueItems": false,
172 | "type": "array",
173 | "items": {
174 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
175 | }
176 | }
177 | },
178 | "text/html": {
179 | "schema": {
180 | "uniqueItems": false,
181 | "type": "array",
182 | "items": {
183 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
184 | }
185 | }
186 | },
187 | "application/json": {
188 | "schema": {
189 | "uniqueItems": false,
190 | "type": "array",
191 | "items": {
192 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
193 | }
194 | }
195 | },
196 | "text/json": {
197 | "schema": {
198 | "uniqueItems": false,
199 | "type": "array",
200 | "items": {
201 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
202 | }
203 | }
204 | }
205 | }
206 | }
207 | },
208 | "security": [
209 | {
210 | "Authorization": []
211 | }
212 | ]
213 | }
214 | },
215 | "/xtranpassengerapi/api/v2.10/busstops": {
216 | "get": {
217 | "tags": [
218 | "BusStops"
219 | ],
220 | "summary": "Returns a list of busstops",
221 | "responses": {
222 | "200": {
223 | "description": "Success",
224 | "content": {
225 | "text/plain": {
226 | "schema": {
227 | "uniqueItems": false,
228 | "type": "array",
229 | "items": {
230 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
231 | }
232 | }
233 | },
234 | "text/html": {
235 | "schema": {
236 | "uniqueItems": false,
237 | "type": "array",
238 | "items": {
239 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
240 | }
241 | }
242 | },
243 | "application/json": {
244 | "schema": {
245 | "uniqueItems": false,
246 | "type": "array",
247 | "items": {
248 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
249 | }
250 | }
251 | },
252 | "text/json": {
253 | "schema": {
254 | "uniqueItems": false,
255 | "type": "array",
256 | "items": {
257 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
258 | }
259 | }
260 | }
261 | }
262 | }
263 | },
264 | "security": [
265 | {
266 | "Authorization": []
267 | }
268 | ]
269 | }
270 | },
271 | "/xtranpassengerapi/api/v2.10/busstops/timestamp/{timestamp}": {
272 | "get": {
273 | "tags": [
274 | "BusStops"
275 | ],
276 | "summary": "Returns a list of busstops with changes from the sent timestamp",
277 | "parameters": [
278 | {
279 | "name": "timestamp",
280 | "in": "path",
281 | "required": true,
282 | "style": "simple",
283 | "explode": false,
284 | "schema": {
285 | "type": "string",
286 | "format": "date-time"
287 | }
288 | }
289 | ],
290 | "responses": {
291 | "200": {
292 | "description": "Success",
293 | "content": {
294 | "text/plain": {
295 | "schema": {
296 | "uniqueItems": false,
297 | "type": "array",
298 | "items": {
299 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
300 | }
301 | }
302 | },
303 | "text/html": {
304 | "schema": {
305 | "uniqueItems": false,
306 | "type": "array",
307 | "items": {
308 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
309 | }
310 | }
311 | },
312 | "application/json": {
313 | "schema": {
314 | "uniqueItems": false,
315 | "type": "array",
316 | "items": {
317 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
318 | }
319 | }
320 | },
321 | "text/json": {
322 | "schema": {
323 | "uniqueItems": false,
324 | "type": "array",
325 | "items": {
326 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
327 | }
328 | }
329 | }
330 | }
331 | }
332 | },
333 | "security": [
334 | {
335 | "Authorization": []
336 | }
337 | ]
338 | }
339 | },
340 | "/xtranpassengerapi/api/v2.10/busstops/rvd/{rvdId}": {
341 | "get": {
342 | "tags": [
343 | "BusStops"
344 | ],
345 | "summary": "Returns the list of stops that make up the trail of the sent ID",
346 | "parameters": [
347 | {
348 | "name": "rvdId",
349 | "in": "path",
350 | "required": true,
351 | "style": "simple",
352 | "explode": false,
353 | "schema": {
354 | "type": "integer",
355 | "format": "int32"
356 | }
357 | }
358 | ],
359 | "responses": {
360 | "200": {
361 | "description": "Success",
362 | "content": {
363 | "text/plain": {
364 | "schema": {
365 | "uniqueItems": false,
366 | "type": "array",
367 | "items": {
368 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
369 | }
370 | }
371 | },
372 | "text/html": {
373 | "schema": {
374 | "uniqueItems": false,
375 | "type": "array",
376 | "items": {
377 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
378 | }
379 | }
380 | },
381 | "application/json": {
382 | "schema": {
383 | "uniqueItems": false,
384 | "type": "array",
385 | "items": {
386 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
387 | }
388 | }
389 | },
390 | "text/json": {
391 | "schema": {
392 | "uniqueItems": false,
393 | "type": "array",
394 | "items": {
395 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
396 | }
397 | }
398 | }
399 | }
400 | }
401 | },
402 | "security": [
403 | {
404 | "Authorization": []
405 | }
406 | ]
407 | }
408 | },
409 | "/xtranpassengerapi/api/v2.10/busstops/near/lat/{lat}/lon/{lng}": {
410 | "get": {
411 | "tags": [
412 | "BusStops"
413 | ],
414 | "summary": "Get a list with the nearest bus stops from any given point. The distance is measured as meters.",
415 | "parameters": [
416 | {
417 | "name": "lat",
418 | "in": "path",
419 | "description": "The location latitude.",
420 | "required": true,
421 | "style": "simple",
422 | "explode": false,
423 | "schema": {
424 | "type": "number",
425 | "format": "double"
426 | }
427 | },
428 | {
429 | "name": "lng",
430 | "in": "path",
431 | "description": "The location longitude.",
432 | "required": true,
433 | "style": "simple",
434 | "explode": false,
435 | "schema": {
436 | "type": "number",
437 | "format": "double"
438 | }
439 | }
440 | ],
441 | "responses": {
442 | "200": {
443 | "description": "Success",
444 | "content": {
445 | "text/plain": {
446 | "schema": {
447 | "uniqueItems": false,
448 | "type": "array",
449 | "items": {
450 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.NearbyBusStopDto"
451 | }
452 | }
453 | },
454 | "text/html": {
455 | "schema": {
456 | "uniqueItems": false,
457 | "type": "array",
458 | "items": {
459 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.NearbyBusStopDto"
460 | }
461 | }
462 | },
463 | "application/json": {
464 | "schema": {
465 | "uniqueItems": false,
466 | "type": "array",
467 | "items": {
468 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.NearbyBusStopDto"
469 | }
470 | }
471 | },
472 | "text/json": {
473 | "schema": {
474 | "uniqueItems": false,
475 | "type": "array",
476 | "items": {
477 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.NearbyBusStopDto"
478 | }
479 | }
480 | }
481 | }
482 | }
483 | },
484 | "security": [
485 | {
486 | "Authorization": []
487 | }
488 | ]
489 | }
490 | },
491 | "/xtranpassengerapi/api/v2.10/Estimations": {
492 | "get": {
493 | "tags": [
494 | "Estimations"
495 | ],
496 | "summary": "Checking if there's a valid connection to the time estimator",
497 | "operationId": "Test",
498 | "responses": {
499 | "200": {
500 | "description": "Success",
501 | "content": {
502 | "text/plain": {
503 | "schema": {
504 | "type": "string"
505 | }
506 | },
507 | "text/html": {
508 | "schema": {
509 | "type": "string"
510 | }
511 | },
512 | "application/json": {
513 | "schema": {
514 | "type": "string"
515 | }
516 | },
517 | "text/json": {
518 | "schema": {
519 | "type": "string"
520 | }
521 | }
522 | }
523 | }
524 | },
525 | "security": [
526 | {
527 | "Authorization": []
528 | }
529 | ]
530 | }
531 | },
532 | "/xtranpassengerapi/api/v2.10/Estimations/busStop/{busStop}/top/{results}": {
533 | "get": {
534 | "tags": [
535 | "Estimations"
536 | ],
537 | "summary": "Returns a list of estimations with maximum results for the next buses passing in the stop sent by parameter (public stop identifier).",
538 | "operationId": "GetFromBusStops",
539 | "parameters": [
540 | {
541 | "name": "busStop",
542 | "in": "path",
543 | "required": true,
544 | "style": "simple",
545 | "explode": false,
546 | "schema": {
547 | "type": "string"
548 | }
549 | },
550 | {
551 | "name": "results",
552 | "in": "path",
553 | "required": true,
554 | "style": "simple",
555 | "explode": false,
556 | "schema": {
557 | "type": "integer",
558 | "format": "int32"
559 | }
560 | }
561 | ],
562 | "responses": {
563 | "200": {
564 | "description": "Success",
565 | "content": {
566 | "text/plain": {
567 | "schema": {
568 | "uniqueItems": false,
569 | "type": "array",
570 | "items": {
571 | "$ref": "#/components/schemas/XtpApiDtos.TimeEstimator.EstimationDto"
572 | }
573 | }
574 | },
575 | "text/html": {
576 | "schema": {
577 | "uniqueItems": false,
578 | "type": "array",
579 | "items": {
580 | "$ref": "#/components/schemas/XtpApiDtos.TimeEstimator.EstimationDto"
581 | }
582 | }
583 | },
584 | "application/json": {
585 | "schema": {
586 | "uniqueItems": false,
587 | "type": "array",
588 | "items": {
589 | "$ref": "#/components/schemas/XtpApiDtos.TimeEstimator.EstimationDto"
590 | }
591 | }
592 | },
593 | "text/json": {
594 | "schema": {
595 | "uniqueItems": false,
596 | "type": "array",
597 | "items": {
598 | "$ref": "#/components/schemas/XtpApiDtos.TimeEstimator.EstimationDto"
599 | }
600 | }
601 | }
602 | }
603 | }
604 | },
605 | "security": [
606 | {
607 | "Authorization": []
608 | }
609 | ]
610 | }
611 | },
612 | "/xtranpassengerapi/api/v2.10/Estimations/estimationbusstop/{busStops}/top/{results}": {
613 | "get": {
614 | "tags": [
615 | "Estimations"
616 | ],
617 | "summary": "Returns a list of estimations for multiple stops in a single request. \r\nStops should be separated by the '-' character. The result returns data from the stops, each containing its list of estimates.",
618 | "operationId": "GetEstimationBusStop",
619 | "parameters": [
620 | {
621 | "name": "busStops",
622 | "in": "path",
623 | "required": true,
624 | "style": "simple",
625 | "explode": false,
626 | "schema": {
627 | "type": "string"
628 | }
629 | },
630 | {
631 | "name": "results",
632 | "in": "path",
633 | "required": true,
634 | "style": "simple",
635 | "explode": false,
636 | "schema": {
637 | "type": "integer",
638 | "format": "int32"
639 | }
640 | }
641 | ],
642 | "responses": {
643 | "200": {
644 | "description": "Success",
645 | "content": {
646 | "text/plain": {
647 | "schema": {
648 | "uniqueItems": false,
649 | "type": "array",
650 | "items": {
651 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.EstimationBusStopDto"
652 | }
653 | }
654 | },
655 | "text/html": {
656 | "schema": {
657 | "uniqueItems": false,
658 | "type": "array",
659 | "items": {
660 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.EstimationBusStopDto"
661 | }
662 | }
663 | },
664 | "application/json": {
665 | "schema": {
666 | "uniqueItems": false,
667 | "type": "array",
668 | "items": {
669 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.EstimationBusStopDto"
670 | }
671 | }
672 | },
673 | "text/json": {
674 | "schema": {
675 | "uniqueItems": false,
676 | "type": "array",
677 | "items": {
678 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.EstimationBusStopDto"
679 | }
680 | }
681 | }
682 | }
683 | }
684 | },
685 | "security": [
686 | {
687 | "Authorization": []
688 | }
689 | ]
690 | }
691 | },
692 | "/xtranpassengerapi/api/v2.10/Geocoding/{search}": {
693 | "get": {
694 | "tags": [
695 | "Geocoding"
696 | ],
697 | "summary": "Returns a list of possible points matching the given address",
698 | "operationId": "Forward",
699 | "parameters": [
700 | {
701 | "name": "search",
702 | "in": "path",
703 | "required": true,
704 | "style": "simple",
705 | "explode": false,
706 | "schema": {
707 | "type": "string"
708 | }
709 | }
710 | ],
711 | "responses": {
712 | "200": {
713 | "description": "Success",
714 | "content": {
715 | "text/plain": {
716 | "schema": {
717 | "uniqueItems": false,
718 | "type": "array",
719 | "items": {
720 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
721 | }
722 | }
723 | },
724 | "text/html": {
725 | "schema": {
726 | "uniqueItems": false,
727 | "type": "array",
728 | "items": {
729 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
730 | }
731 | }
732 | },
733 | "application/json": {
734 | "schema": {
735 | "uniqueItems": false,
736 | "type": "array",
737 | "items": {
738 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
739 | }
740 | }
741 | },
742 | "text/json": {
743 | "schema": {
744 | "uniqueItems": false,
745 | "type": "array",
746 | "items": {
747 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
748 | }
749 | }
750 | }
751 | }
752 | }
753 | },
754 | "security": [
755 | {
756 | "Authorization": []
757 | }
758 | ]
759 | }
760 | },
761 | "/xtranpassengerapi/api/v2.10/Geocoding/reverse/lat/{lat}/lng/{lng}": {
762 | "get": {
763 | "tags": [
764 | "Geocoding"
765 | ],
766 | "summary": "Returns the address to the specified geographical point",
767 | "operationId": "Reverse",
768 | "parameters": [
769 | {
770 | "name": "lat",
771 | "in": "path",
772 | "required": true,
773 | "style": "simple",
774 | "explode": false,
775 | "schema": {
776 | "type": "number",
777 | "format": "double"
778 | }
779 | },
780 | {
781 | "name": "lng",
782 | "in": "path",
783 | "required": true,
784 | "style": "simple",
785 | "explode": false,
786 | "schema": {
787 | "type": "number",
788 | "format": "double"
789 | }
790 | }
791 | ],
792 | "responses": {
793 | "200": {
794 | "description": "Success",
795 | "content": {
796 | "text/plain": {
797 | "schema": {
798 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
799 | }
800 | },
801 | "text/html": {
802 | "schema": {
803 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
804 | }
805 | },
806 | "application/json": {
807 | "schema": {
808 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
809 | }
810 | },
811 | "text/json": {
812 | "schema": {
813 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
814 | }
815 | }
816 | }
817 | }
818 | },
819 | "security": [
820 | {
821 | "Authorization": []
822 | }
823 | ]
824 | }
825 | },
826 | "/xtranpassengerapi/api/v2.10/Geocoding/suggest/{query}": {
827 | "get": {
828 | "tags": [
829 | "Geocoding"
830 | ],
831 | "summary": "Autocomplete for user inputs, so that it can search for an address",
832 | "operationId": "Suggest",
833 | "parameters": [
834 | {
835 | "name": "query",
836 | "in": "path",
837 | "required": true,
838 | "style": "simple",
839 | "explode": false,
840 | "schema": {
841 | "type": "string"
842 | }
843 | }
844 | ],
845 | "responses": {
846 | "200": {
847 | "description": "Success",
848 | "content": {
849 | "text/plain": {
850 | "schema": {
851 | "uniqueItems": false,
852 | "type": "array",
853 | "items": {
854 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoSuggestionDto"
855 | }
856 | }
857 | },
858 | "text/html": {
859 | "schema": {
860 | "uniqueItems": false,
861 | "type": "array",
862 | "items": {
863 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoSuggestionDto"
864 | }
865 | }
866 | },
867 | "application/json": {
868 | "schema": {
869 | "uniqueItems": false,
870 | "type": "array",
871 | "items": {
872 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoSuggestionDto"
873 | }
874 | }
875 | },
876 | "text/json": {
877 | "schema": {
878 | "uniqueItems": false,
879 | "type": "array",
880 | "items": {
881 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoSuggestionDto"
882 | }
883 | }
884 | }
885 | }
886 | }
887 | },
888 | "security": [
889 | {
890 | "Authorization": []
891 | }
892 | ]
893 | }
894 | },
895 | "/xtranpassengerapi/api/v2.10/Geocoding/fromId/{locationId}": {
896 | "get": {
897 | "tags": [
898 | "Geocoding"
899 | ],
900 | "summary": "Retrieve the address data from a user search",
901 | "operationId": "FromId",
902 | "parameters": [
903 | {
904 | "name": "locationId",
905 | "in": "path",
906 | "required": true,
907 | "style": "simple",
908 | "explode": false,
909 | "schema": {
910 | "type": "string"
911 | }
912 | }
913 | ],
914 | "responses": {
915 | "200": {
916 | "description": "Success",
917 | "content": {
918 | "text/plain": {
919 | "schema": {
920 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
921 | }
922 | },
923 | "text/html": {
924 | "schema": {
925 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
926 | }
927 | },
928 | "application/json": {
929 | "schema": {
930 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
931 | }
932 | },
933 | "text/json": {
934 | "schema": {
935 | "$ref": "#/components/schemas/XtpApiDtos.Geocoding.GeoResultDto"
936 | }
937 | }
938 | }
939 | }
940 | },
941 | "security": [
942 | {
943 | "Authorization": []
944 | }
945 | ]
946 | }
947 | },
948 | "/xtranpassengerapi/api/v2.10/GTFS/realtime/vehiclepositions": {
949 | "get": {
950 | "tags": [
951 | "Gtfs"
952 | ],
953 | "summary": "Returns the vehicle positions of the current GTFS realtime feed.",
954 | "operationId": "GetRealTime",
955 | "responses": {
956 | "200": {
957 | "description": "Success"
958 | }
959 | },
960 | "security": [
961 | {
962 | "Authorization": []
963 | }
964 | ]
965 | }
966 | },
967 | "/xtranpassengerapi/api/v2.10/GTFS": {
968 | "get": {
969 | "tags": [
970 | "Gtfs"
971 | ],
972 | "summary": "Returns the current GTFS feed.",
973 | "responses": {
974 | "200": {
975 | "description": "Success"
976 | }
977 | },
978 | "security": [
979 | {
980 | "Authorization": []
981 | }
982 | ]
983 | }
984 | },
985 | "/xtranpassengerapi/api/v2.10/GTFS/date/{date}": {
986 | "get": {
987 | "tags": [
988 | "Gtfs"
989 | ],
990 | "summary": "Returns a valid GTFS feed for a given date.",
991 | "parameters": [
992 | {
993 | "name": "date",
994 | "in": "path",
995 | "description": "A date in the YYYY-MM-DD format. Example: 2019-07-02",
996 | "required": true,
997 | "style": "simple",
998 | "explode": false,
999 | "schema": {
1000 | "type": "string",
1001 | "format": "date-time"
1002 | }
1003 | }
1004 | ],
1005 | "responses": {
1006 | "200": {
1007 | "description": "Success"
1008 | }
1009 | },
1010 | "security": [
1011 | {
1012 | "Authorization": []
1013 | }
1014 | ]
1015 | }
1016 | },
1017 | "/xtranpassengerapi/api/v2.10/Planner/startlat/{startLat}/startlon/{startLon}/endLat/{endLat}/endLon/{endLon}/start/{startDate}/language/{language}": {
1018 | "get": {
1019 | "tags": [
1020 | "Planner"
1021 | ],
1022 | "summary": "Planning a voyage from one point to another",
1023 | "parameters": [
1024 | {
1025 | "name": "startLat",
1026 | "in": "path",
1027 | "required": true,
1028 | "style": "simple",
1029 | "explode": false,
1030 | "schema": {
1031 | "type": "number",
1032 | "format": "double"
1033 | }
1034 | },
1035 | {
1036 | "name": "startLon",
1037 | "in": "path",
1038 | "required": true,
1039 | "style": "simple",
1040 | "explode": false,
1041 | "schema": {
1042 | "type": "number",
1043 | "format": "double"
1044 | }
1045 | },
1046 | {
1047 | "name": "endLat",
1048 | "in": "path",
1049 | "required": true,
1050 | "style": "simple",
1051 | "explode": false,
1052 | "schema": {
1053 | "type": "number",
1054 | "format": "double"
1055 | }
1056 | },
1057 | {
1058 | "name": "endLon",
1059 | "in": "path",
1060 | "required": true,
1061 | "style": "simple",
1062 | "explode": false,
1063 | "schema": {
1064 | "type": "number",
1065 | "format": "double"
1066 | }
1067 | },
1068 | {
1069 | "name": "startDate",
1070 | "in": "path",
1071 | "required": true,
1072 | "style": "simple",
1073 | "explode": false,
1074 | "schema": {
1075 | "type": "string",
1076 | "format": "date-time"
1077 | }
1078 | },
1079 | {
1080 | "name": "language",
1081 | "in": "path",
1082 | "required": true,
1083 | "style": "simple",
1084 | "explode": false,
1085 | "schema": {
1086 | "type": "string"
1087 | }
1088 | }
1089 | ],
1090 | "responses": {
1091 | "200": {
1092 | "description": "Success",
1093 | "content": {
1094 | "text/plain": {
1095 | "schema": {
1096 | "uniqueItems": false,
1097 | "type": "array",
1098 | "items": {
1099 | "$ref": "#/components/schemas/XtpApiDtos.Google.SolutionDto"
1100 | }
1101 | }
1102 | },
1103 | "text/html": {
1104 | "schema": {
1105 | "uniqueItems": false,
1106 | "type": "array",
1107 | "items": {
1108 | "$ref": "#/components/schemas/XtpApiDtos.Google.SolutionDto"
1109 | }
1110 | }
1111 | },
1112 | "application/json": {
1113 | "schema": {
1114 | "uniqueItems": false,
1115 | "type": "array",
1116 | "items": {
1117 | "$ref": "#/components/schemas/XtpApiDtos.Google.SolutionDto"
1118 | }
1119 | }
1120 | },
1121 | "text/json": {
1122 | "schema": {
1123 | "uniqueItems": false,
1124 | "type": "array",
1125 | "items": {
1126 | "$ref": "#/components/schemas/XtpApiDtos.Google.SolutionDto"
1127 | }
1128 | }
1129 | }
1130 | }
1131 | }
1132 | },
1133 | "security": [
1134 | {
1135 | "Authorization": []
1136 | }
1137 | ]
1138 | }
1139 | },
1140 | "/xtranpassengerapi/api/v2.10/Routes/busStop/{busStopId}": {
1141 | "get": {
1142 | "tags": [
1143 | "Routes"
1144 | ],
1145 | "summary": "Returns a list of routes that pass at a given busstop",
1146 | "parameters": [
1147 | {
1148 | "name": "busStopId",
1149 | "in": "path",
1150 | "description": "The id of the busstop.",
1151 | "required": true,
1152 | "style": "simple",
1153 | "explode": false,
1154 | "schema": {
1155 | "type": "integer",
1156 | "format": "int32"
1157 | }
1158 | }
1159 | ],
1160 | "responses": {
1161 | "200": {
1162 | "description": "Success",
1163 | "content": {
1164 | "text/plain": {
1165 | "schema": {
1166 | "uniqueItems": false,
1167 | "type": "array",
1168 | "items": {
1169 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1170 | }
1171 | }
1172 | },
1173 | "text/html": {
1174 | "schema": {
1175 | "uniqueItems": false,
1176 | "type": "array",
1177 | "items": {
1178 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1179 | }
1180 | }
1181 | },
1182 | "application/json": {
1183 | "schema": {
1184 | "uniqueItems": false,
1185 | "type": "array",
1186 | "items": {
1187 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1188 | }
1189 | }
1190 | },
1191 | "text/json": {
1192 | "schema": {
1193 | "uniqueItems": false,
1194 | "type": "array",
1195 | "items": {
1196 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1197 | }
1198 | }
1199 | }
1200 | }
1201 | }
1202 | },
1203 | "security": [
1204 | {
1205 | "Authorization": []
1206 | }
1207 | ]
1208 | }
1209 | },
1210 | "/xtranpassengerapi/api/v2.10/Routes": {
1211 | "get": {
1212 | "tags": [
1213 | "Routes"
1214 | ],
1215 | "summary": "Returns the list of routes",
1216 | "responses": {
1217 | "200": {
1218 | "description": "Success",
1219 | "content": {
1220 | "text/plain": {
1221 | "schema": {
1222 | "uniqueItems": false,
1223 | "type": "array",
1224 | "items": {
1225 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1226 | }
1227 | }
1228 | },
1229 | "text/html": {
1230 | "schema": {
1231 | "uniqueItems": false,
1232 | "type": "array",
1233 | "items": {
1234 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1235 | }
1236 | }
1237 | },
1238 | "application/json": {
1239 | "schema": {
1240 | "uniqueItems": false,
1241 | "type": "array",
1242 | "items": {
1243 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1244 | }
1245 | }
1246 | },
1247 | "text/json": {
1248 | "schema": {
1249 | "uniqueItems": false,
1250 | "type": "array",
1251 | "items": {
1252 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1253 | }
1254 | }
1255 | }
1256 | }
1257 | }
1258 | },
1259 | "security": [
1260 | {
1261 | "Authorization": []
1262 | }
1263 | ]
1264 | }
1265 | },
1266 | "/xtranpassengerapi/api/v2.10/Routes/timestamp/{timestamp}": {
1267 | "get": {
1268 | "tags": [
1269 | "Routes"
1270 | ],
1271 | "summary": "Returns the list of routes with updates after the sent timestamp",
1272 | "parameters": [
1273 | {
1274 | "name": "timestamp",
1275 | "in": "path",
1276 | "required": true,
1277 | "style": "simple",
1278 | "explode": false,
1279 | "schema": {
1280 | "type": "string",
1281 | "format": "date-time"
1282 | }
1283 | }
1284 | ],
1285 | "responses": {
1286 | "200": {
1287 | "description": "Success",
1288 | "content": {
1289 | "text/plain": {
1290 | "schema": {
1291 | "uniqueItems": false,
1292 | "type": "array",
1293 | "items": {
1294 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1295 | }
1296 | }
1297 | },
1298 | "text/html": {
1299 | "schema": {
1300 | "uniqueItems": false,
1301 | "type": "array",
1302 | "items": {
1303 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1304 | }
1305 | }
1306 | },
1307 | "application/json": {
1308 | "schema": {
1309 | "uniqueItems": false,
1310 | "type": "array",
1311 | "items": {
1312 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1313 | }
1314 | }
1315 | },
1316 | "text/json": {
1317 | "schema": {
1318 | "uniqueItems": false,
1319 | "type": "array",
1320 | "items": {
1321 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.RouteDto"
1322 | }
1323 | }
1324 | }
1325 | }
1326 | }
1327 | },
1328 | "security": [
1329 | {
1330 | "Authorization": []
1331 | }
1332 | ]
1333 | }
1334 | },
1335 | "/xtranpassengerapi/api/v2.10/Routes/{routeNumber}": {
1336 | "get": {
1337 | "tags": [
1338 | "Routes"
1339 | ],
1340 | "summary": "Returns the route by its route number.",
1341 | "operationId": "GetAsync",
1342 | "parameters": [
1343 | {
1344 | "name": "routeNumber",
1345 | "in": "path",
1346 | "required": true,
1347 | "style": "simple",
1348 | "explode": false,
1349 | "schema": {
1350 | "type": "string"
1351 | }
1352 | }
1353 | ],
1354 | "responses": {
1355 | "200": {
1356 | "description": "Success",
1357 | "content": {
1358 | "text/plain": {
1359 | "schema": {
1360 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1361 | }
1362 | },
1363 | "text/html": {
1364 | "schema": {
1365 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1366 | }
1367 | },
1368 | "application/json": {
1369 | "schema": {
1370 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1371 | }
1372 | },
1373 | "text/json": {
1374 | "schema": {
1375 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1376 | }
1377 | }
1378 | }
1379 | }
1380 | },
1381 | "security": [
1382 | {
1383 | "Authorization": []
1384 | }
1385 | ]
1386 | }
1387 | },
1388 | "/xtranpassengerapi/api/v2.10/Routes/{routeNumber}/from/{from}/until/{until}": {
1389 | "get": {
1390 | "tags": [
1391 | "Routes"
1392 | ],
1393 | "summary": "Returns the route by its route number within a given period of time.",
1394 | "parameters": [
1395 | {
1396 | "name": "routeNumber",
1397 | "in": "path",
1398 | "description": "The public number",
1399 | "required": true,
1400 | "style": "simple",
1401 | "explode": false,
1402 | "schema": {
1403 | "type": "string"
1404 | }
1405 | },
1406 | {
1407 | "name": "from",
1408 | "in": "path",
1409 | "description": "Filter variants from a given time",
1410 | "required": true,
1411 | "style": "simple",
1412 | "explode": false,
1413 | "schema": {
1414 | "type": "string",
1415 | "format": "date-time"
1416 | }
1417 | },
1418 | {
1419 | "name": "until",
1420 | "in": "path",
1421 | "description": "Filter variants until a given time",
1422 | "required": true,
1423 | "style": "simple",
1424 | "explode": false,
1425 | "schema": {
1426 | "type": "string",
1427 | "format": "date-time"
1428 | }
1429 | }
1430 | ],
1431 | "responses": {
1432 | "200": {
1433 | "description": "Success",
1434 | "content": {
1435 | "text/plain": {
1436 | "schema": {
1437 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1438 | }
1439 | },
1440 | "text/html": {
1441 | "schema": {
1442 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1443 | }
1444 | },
1445 | "application/json": {
1446 | "schema": {
1447 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1448 | }
1449 | },
1450 | "text/json": {
1451 | "schema": {
1452 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.FullRouteDto"
1453 | }
1454 | }
1455 | }
1456 | }
1457 | },
1458 | "security": [
1459 | {
1460 | "Authorization": []
1461 | }
1462 | ]
1463 | }
1464 | },
1465 | "/xtranpassengerapi/api/v2.10/SGO/busNumber/{busNumber}": {
1466 | "get": {
1467 | "tags": [
1468 | "SGO"
1469 | ],
1470 | "summary": "Returns a list of vehicle statuses.",
1471 | "parameters": [
1472 | {
1473 | "name": "busNumber",
1474 | "in": "path",
1475 | "required": true,
1476 | "style": "simple",
1477 | "explode": false,
1478 | "schema": {
1479 | "type": "integer",
1480 | "format": "int32"
1481 | }
1482 | }
1483 | ],
1484 | "responses": {
1485 | "200": {
1486 | "description": "Success",
1487 | "content": {
1488 | "text/plain": {
1489 | "schema": {
1490 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.SGOVehicleStatusDto"
1491 | }
1492 | },
1493 | "text/html": {
1494 | "schema": {
1495 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.SGOVehicleStatusDto"
1496 | }
1497 | },
1498 | "application/json": {
1499 | "schema": {
1500 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.SGOVehicleStatusDto"
1501 | }
1502 | },
1503 | "text/json": {
1504 | "schema": {
1505 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.SGOVehicleStatusDto"
1506 | }
1507 | }
1508 | }
1509 | }
1510 | },
1511 | "security": [
1512 | {
1513 | "Authorization": []
1514 | }
1515 | ]
1516 | }
1517 | },
1518 | "/xtranpassengerapi/api/v2.10/StopTimes/routeNumber/{routeNumber}/direction/{direction}/stop/{stopId}/date/{date}": {
1519 | "get": {
1520 | "tags": [
1521 | "StopTimes"
1522 | ],
1523 | "summary": "Returns the list of stop times for a specific busstop, given a route number and its direction.",
1524 | "parameters": [
1525 | {
1526 | "name": "routeNumber",
1527 | "in": "path",
1528 | "description": "The route public number. (Example: 12E)",
1529 | "required": true,
1530 | "style": "simple",
1531 | "explode": false,
1532 | "schema": {
1533 | "type": "string"
1534 | }
1535 | },
1536 | {
1537 | "name": "direction",
1538 | "in": "path",
1539 | "description": "The route direction. (Example: CIRC)",
1540 | "required": true,
1541 | "style": "simple",
1542 | "explode": false,
1543 | "schema": {
1544 | "type": "string"
1545 | }
1546 | },
1547 | {
1548 | "name": "stopId",
1549 | "in": "path",
1550 | "description": "The busstop id (Example: 13802).",
1551 | "required": true,
1552 | "style": "simple",
1553 | "explode": false,
1554 | "schema": {
1555 | "type": "string"
1556 | }
1557 | },
1558 | {
1559 | "name": "date",
1560 | "in": "path",
1561 | "description": "The date for the schedule in 'yyyy-mm-dd' format (Example: 2019-12-31)",
1562 | "required": true,
1563 | "style": "simple",
1564 | "explode": false,
1565 | "schema": {
1566 | "type": "string"
1567 | }
1568 | }
1569 | ],
1570 | "responses": {
1571 | "200": {
1572 | "description": "Success",
1573 | "content": {
1574 | "text/plain": {
1575 | "schema": {
1576 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ScheduleDto"
1577 | }
1578 | },
1579 | "text/html": {
1580 | "schema": {
1581 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ScheduleDto"
1582 | }
1583 | },
1584 | "application/json": {
1585 | "schema": {
1586 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ScheduleDto"
1587 | }
1588 | },
1589 | "text/json": {
1590 | "schema": {
1591 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ScheduleDto"
1592 | }
1593 | }
1594 | }
1595 | }
1596 | },
1597 | "security": [
1598 | {
1599 | "Authorization": []
1600 | }
1601 | ]
1602 | }
1603 | },
1604 | "/xtranpassengerapi/api/v2.10/vehicleStatuses/routeNumber/{routeNumber}": {
1605 | "get": {
1606 | "tags": [
1607 | "VehicleStatuses"
1608 | ],
1609 | "summary": "Returns the list of vehicle status for a single route.",
1610 | "operationId": "GetVehiclesForRoute",
1611 | "parameters": [
1612 | {
1613 | "name": "routeNumber",
1614 | "in": "path",
1615 | "required": true,
1616 | "style": "simple",
1617 | "explode": false,
1618 | "schema": {
1619 | "type": "string"
1620 | }
1621 | }
1622 | ],
1623 | "responses": {
1624 | "200": {
1625 | "description": "Success",
1626 | "content": {
1627 | "text/plain": {
1628 | "schema": {
1629 | "uniqueItems": false,
1630 | "type": "array",
1631 | "items": {
1632 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1633 | }
1634 | }
1635 | },
1636 | "text/html": {
1637 | "schema": {
1638 | "uniqueItems": false,
1639 | "type": "array",
1640 | "items": {
1641 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1642 | }
1643 | }
1644 | },
1645 | "application/json": {
1646 | "schema": {
1647 | "uniqueItems": false,
1648 | "type": "array",
1649 | "items": {
1650 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1651 | }
1652 | }
1653 | },
1654 | "text/json": {
1655 | "schema": {
1656 | "uniqueItems": false,
1657 | "type": "array",
1658 | "items": {
1659 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1660 | }
1661 | }
1662 | }
1663 | }
1664 | }
1665 | },
1666 | "security": [
1667 | {
1668 | "Authorization": []
1669 | }
1670 | ]
1671 | }
1672 | },
1673 | "/xtranpassengerapi/api/v2.10/vehicleStatuses": {
1674 | "get": {
1675 | "tags": [
1676 | "VehicleStatuses"
1677 | ],
1678 | "summary": "Returns a list of vehicle statuses.",
1679 | "responses": {
1680 | "200": {
1681 | "description": "Success",
1682 | "content": {
1683 | "text/plain": {
1684 | "schema": {
1685 | "uniqueItems": false,
1686 | "type": "array",
1687 | "items": {
1688 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1689 | }
1690 | }
1691 | },
1692 | "text/html": {
1693 | "schema": {
1694 | "uniqueItems": false,
1695 | "type": "array",
1696 | "items": {
1697 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1698 | }
1699 | }
1700 | },
1701 | "application/json": {
1702 | "schema": {
1703 | "uniqueItems": false,
1704 | "type": "array",
1705 | "items": {
1706 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1707 | }
1708 | }
1709 | },
1710 | "text/json": {
1711 | "schema": {
1712 | "uniqueItems": false,
1713 | "type": "array",
1714 | "items": {
1715 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VehicleStatusDto"
1716 | }
1717 | }
1718 | }
1719 | }
1720 | }
1721 | },
1722 | "security": [
1723 | {
1724 | "Authorization": []
1725 | }
1726 | ]
1727 | }
1728 | }
1729 | },
1730 | "components": {
1731 | "schemas": {
1732 | "XtpApiDtos.TinyPassenger.AlertDto": {
1733 | "type": "object",
1734 | "properties": {
1735 | "id": {
1736 | "type": "integer",
1737 | "format": "int32"
1738 | },
1739 | "alertType": {
1740 | "type": "string",
1741 | "enum": [
1742 | "Informative",
1743 | "Ocurrence"
1744 | ]
1745 | },
1746 | "alertDescription": {
1747 | "type": "string"
1748 | },
1749 | "publishDate": {
1750 | "type": "string",
1751 | "format": "date-time"
1752 | },
1753 | "expirationDate": {
1754 | "type": "string",
1755 | "format": "date-time"
1756 | },
1757 | "routeNumber": {
1758 | "type": "string"
1759 | },
1760 | "busStopNumber": {
1761 | "type": "string"
1762 | }
1763 | }
1764 | },
1765 | "XtpApiDtos.TinyPassenger.BusStopDto": {
1766 | "type": "object",
1767 | "properties": {
1768 | "id": {
1769 | "type": "integer",
1770 | "format": "int32"
1771 | },
1772 | "name": {
1773 | "type": "string"
1774 | },
1775 | "publicId": {
1776 | "type": "string"
1777 | },
1778 | "lat": {
1779 | "type": "number",
1780 | "format": "double"
1781 | },
1782 | "lng": {
1783 | "type": "number",
1784 | "format": "double"
1785 | },
1786 | "isPublicVisible": {
1787 | "type": "boolean"
1788 | },
1789 | "timestamp": {
1790 | "type": "string",
1791 | "format": "date-time"
1792 | }
1793 | }
1794 | },
1795 | "XtpApiDtos.TinyPassenger.NearbyBusStopDto": {
1796 | "type": "object",
1797 | "properties": {
1798 | "distance": {
1799 | "type": "number",
1800 | "format": "double"
1801 | },
1802 | "id": {
1803 | "type": "integer",
1804 | "format": "int32"
1805 | },
1806 | "name": {
1807 | "type": "string"
1808 | },
1809 | "publicId": {
1810 | "type": "string"
1811 | },
1812 | "lat": {
1813 | "type": "number",
1814 | "format": "double"
1815 | },
1816 | "lng": {
1817 | "type": "number",
1818 | "format": "double"
1819 | },
1820 | "isPublicVisible": {
1821 | "type": "boolean"
1822 | },
1823 | "timestamp": {
1824 | "type": "string",
1825 | "format": "date-time"
1826 | }
1827 | }
1828 | },
1829 | "XtpApiDtos.TimeEstimator.EstimationDto": {
1830 | "type": "object",
1831 | "properties": {
1832 | "routeNumber": {
1833 | "type": "string"
1834 | },
1835 | "routeName": {
1836 | "type": "string"
1837 | },
1838 | "destination": {
1839 | "type": "string"
1840 | },
1841 | "time": {
1842 | "type": "string",
1843 | "format": "date-time"
1844 | },
1845 | "busNumber": {
1846 | "type": "string"
1847 | },
1848 | "plateNumber": {
1849 | "type": "string"
1850 | },
1851 | "voyageNumber": {
1852 | "type": "integer",
1853 | "format": "int32"
1854 | },
1855 | "publicId": {
1856 | "type": "string"
1857 | }
1858 | }
1859 | },
1860 | "XtpApiDtos.TinyPassenger.EstimationBusStopDto": {
1861 | "type": "object",
1862 | "properties": {
1863 | "estimationList": {
1864 | "uniqueItems": false,
1865 | "type": "array",
1866 | "items": {
1867 | "$ref": "#/components/schemas/XtpApiDtos.TimeEstimator.EstimationDto"
1868 | }
1869 | },
1870 | "id": {
1871 | "type": "integer",
1872 | "format": "int32"
1873 | },
1874 | "name": {
1875 | "type": "string"
1876 | },
1877 | "publicId": {
1878 | "type": "string"
1879 | },
1880 | "lat": {
1881 | "type": "number",
1882 | "format": "double"
1883 | },
1884 | "lng": {
1885 | "type": "number",
1886 | "format": "double"
1887 | },
1888 | "isPublicVisible": {
1889 | "type": "boolean"
1890 | },
1891 | "timestamp": {
1892 | "type": "string",
1893 | "format": "date-time"
1894 | }
1895 | }
1896 | },
1897 | "XtpApiDtos.Geocoding.GeoResultDto": {
1898 | "type": "object",
1899 | "properties": {
1900 | "lat": {
1901 | "type": "number",
1902 | "format": "double"
1903 | },
1904 | "lng": {
1905 | "type": "number",
1906 | "format": "double"
1907 | },
1908 | "address": {
1909 | "type": "string"
1910 | },
1911 | "header": {
1912 | "type": "string"
1913 | },
1914 | "isLocalMatch": {
1915 | "type": "boolean"
1916 | }
1917 | }
1918 | },
1919 | "XtpApiDtos.Geocoding.GeoSuggestionDto": {
1920 | "type": "object",
1921 | "properties": {
1922 | "locationId": {
1923 | "type": "string"
1924 | },
1925 | "address": {
1926 | "type": "string"
1927 | },
1928 | "header": {
1929 | "type": "string"
1930 | }
1931 | }
1932 | },
1933 | "XtpApiDtos.Google.SolutionDto": {
1934 | "type": "object",
1935 | "properties": {
1936 | "bounds": {
1937 | "$ref": "#/components/schemas/XtpApiDtos.Google.BoundsDto"
1938 | },
1939 | "leg": {
1940 | "$ref": "#/components/schemas/XtpApiDtos.Google.SolutionLegDto"
1941 | },
1942 | "fare": {
1943 | "type": "string"
1944 | }
1945 | }
1946 | },
1947 | "XtpApiDtos.Google.BoundsDto": {
1948 | "type": "object",
1949 | "properties": {
1950 | "location1": {
1951 | "$ref": "#/components/schemas/XtpApiDtos.Google.LocationDto"
1952 | },
1953 | "location2": {
1954 | "$ref": "#/components/schemas/XtpApiDtos.Google.LocationDto"
1955 | }
1956 | }
1957 | },
1958 | "XtpApiDtos.Google.SolutionLegDto": {
1959 | "type": "object",
1960 | "properties": {
1961 | "distance": {
1962 | "type": "string"
1963 | },
1964 | "duration": {
1965 | "type": "string"
1966 | },
1967 | "bigSteps": {
1968 | "uniqueItems": false,
1969 | "type": "array",
1970 | "items": {
1971 | "$ref": "#/components/schemas/XtpApiDtos.Google.BigStepDto"
1972 | }
1973 | }
1974 | }
1975 | },
1976 | "XtpApiDtos.Google.LocationDto": {
1977 | "type": "object",
1978 | "properties": {
1979 | "lat": {
1980 | "type": "number",
1981 | "format": "double"
1982 | },
1983 | "lng": {
1984 | "type": "number",
1985 | "format": "double"
1986 | }
1987 | }
1988 | },
1989 | "XtpApiDtos.Google.BigStepDto": {
1990 | "type": "object",
1991 | "properties": {
1992 | "fullInstructions": {
1993 | "type": "string"
1994 | },
1995 | "htmlInstructions": {
1996 | "type": "string"
1997 | },
1998 | "distance": {
1999 | "type": "string"
2000 | },
2001 | "duration": {
2002 | "type": "string"
2003 | },
2004 | "shortName": {
2005 | "type": "string"
2006 | },
2007 | "fullName": {
2008 | "type": "string"
2009 | },
2010 | "points": {
2011 | "uniqueItems": false,
2012 | "type": "array",
2013 | "items": {
2014 | "$ref": "#/components/schemas/XtpApiDtos.Google.LocationDto"
2015 | }
2016 | },
2017 | "innerSteps": {
2018 | "uniqueItems": false,
2019 | "type": "array",
2020 | "items": {
2021 | "$ref": "#/components/schemas/XtpApiDtos.Google.InnerStepDto"
2022 | }
2023 | },
2024 | "travelMode": {
2025 | "type": "string",
2026 | "enum": [
2027 | "Walking",
2028 | "Bus",
2029 | "Subway"
2030 | ]
2031 | },
2032 | "headsign": {
2033 | "type": "string"
2034 | },
2035 | "numberOfStops": {
2036 | "type": "integer",
2037 | "format": "int32"
2038 | },
2039 | "startLocation": {
2040 | "$ref": "#/components/schemas/XtpApiDtos.Google.LocationDto"
2041 | }
2042 | }
2043 | },
2044 | "XtpApiDtos.Google.InnerStepDto": {
2045 | "type": "object",
2046 | "properties": {
2047 | "fullInstructions": {
2048 | "type": "string"
2049 | },
2050 | "htmlInstructions": {
2051 | "type": "string"
2052 | },
2053 | "distance": {
2054 | "type": "string"
2055 | },
2056 | "duration": {
2057 | "type": "string"
2058 | }
2059 | }
2060 | },
2061 | "XtpApiDtos.TinyPassenger.RouteDto": {
2062 | "type": "object",
2063 | "properties": {
2064 | "id": {
2065 | "type": "integer",
2066 | "format": "int32"
2067 | },
2068 | "routeNumber": {
2069 | "type": "string"
2070 | },
2071 | "name": {
2072 | "type": "string"
2073 | },
2074 | "isPublicVisible": {
2075 | "type": "boolean"
2076 | },
2077 | "timestamp": {
2078 | "type": "string",
2079 | "format": "date-time"
2080 | }
2081 | }
2082 | },
2083 | "XtpApiDtos.TinyPassenger.FullRouteDto": {
2084 | "type": "object",
2085 | "properties": {
2086 | "isCirc": {
2087 | "type": "boolean"
2088 | },
2089 | "variants": {
2090 | "uniqueItems": false,
2091 | "type": "array",
2092 | "items": {
2093 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.VariantDto"
2094 | }
2095 | },
2096 | "id": {
2097 | "type": "integer",
2098 | "format": "int32"
2099 | },
2100 | "routeNumber": {
2101 | "type": "string"
2102 | },
2103 | "name": {
2104 | "type": "string"
2105 | },
2106 | "isPublicVisible": {
2107 | "type": "boolean"
2108 | },
2109 | "timestamp": {
2110 | "type": "string",
2111 | "format": "date-time"
2112 | }
2113 | }
2114 | },
2115 | "XtpApiDtos.TinyPassenger.VariantDto": {
2116 | "type": "object",
2117 | "properties": {
2118 | "id": {
2119 | "type": "integer",
2120 | "format": "int32"
2121 | },
2122 | "variantNumber": {
2123 | "type": "integer",
2124 | "format": "int32"
2125 | },
2126 | "isActive": {
2127 | "type": "boolean"
2128 | },
2129 | "upItinerary": {
2130 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ItineraryDto"
2131 | },
2132 | "downItinerary": {
2133 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ItineraryDto"
2134 | },
2135 | "circItinerary": {
2136 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ItineraryDto"
2137 | }
2138 | }
2139 | },
2140 | "XtpApiDtos.TinyPassenger.ItineraryDto": {
2141 | "type": "object",
2142 | "properties": {
2143 | "id": {
2144 | "type": "integer",
2145 | "format": "int32"
2146 | },
2147 | "type": {
2148 | "type": "string",
2149 | "enum": [
2150 | "Asc",
2151 | "Desc",
2152 | "Circ"
2153 | ]
2154 | },
2155 | "connections": {
2156 | "uniqueItems": false,
2157 | "type": "array",
2158 | "items": {
2159 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.ConnectionDto"
2160 | }
2161 | },
2162 | "shape": {
2163 | "type": "string"
2164 | }
2165 | }
2166 | },
2167 | "XtpApiDtos.TinyPassenger.ConnectionDto": {
2168 | "type": "object",
2169 | "properties": {
2170 | "id": {
2171 | "type": "integer",
2172 | "format": "int32"
2173 | },
2174 | "distance": {
2175 | "type": "number",
2176 | "format": "float"
2177 | },
2178 | "orderNum": {
2179 | "type": "integer",
2180 | "format": "int32"
2181 | },
2182 | "busStop": {
2183 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.BusStopDto"
2184 | }
2185 | }
2186 | },
2187 | "XtpApiDtos.TinyPassenger.SGOVehicleStatusDto": {
2188 | "type": "object",
2189 | "properties": {
2190 | "vehiclePlate": {
2191 | "type": "string"
2192 | },
2193 | "routeNumber": {
2194 | "type": "string"
2195 | },
2196 | "plateNumber": {
2197 | "type": "string"
2198 | },
2199 | "direction": {
2200 | "type": "string"
2201 | },
2202 | "lastStopOnVoyageId": {
2203 | "type": "integer",
2204 | "format": "int32"
2205 | },
2206 | "lastStopOnVoyageName": {
2207 | "type": "string"
2208 | },
2209 | "parkingStopId": {
2210 | "type": "integer",
2211 | "format": "int32"
2212 | },
2213 | "parkingStopName": {
2214 | "type": "string"
2215 | },
2216 | "driverNumber": {
2217 | "type": "string"
2218 | },
2219 | "lat": {
2220 | "type": "number",
2221 | "format": "double"
2222 | },
2223 | "lng": {
2224 | "type": "number",
2225 | "format": "double"
2226 | }
2227 | }
2228 | },
2229 | "XtpApiDtos.TinyPassenger.ScheduleDto": {
2230 | "type": "object",
2231 | "properties": {
2232 | "dayId": {
2233 | "type": "integer",
2234 | "format": "int32"
2235 | },
2236 | "seasonId": {
2237 | "type": "integer",
2238 | "format": "int32"
2239 | },
2240 | "dayName": {
2241 | "type": "string"
2242 | },
2243 | "seasonName": {
2244 | "type": "string"
2245 | },
2246 | "stopTimes": {
2247 | "uniqueItems": false,
2248 | "type": "array",
2249 | "items": {
2250 | "$ref": "#/components/schemas/XtpApiDtos.TinyPassenger.StopTimeDto"
2251 | }
2252 | }
2253 | }
2254 | },
2255 | "XtpApiDtos.TinyPassenger.StopTimeDto": {
2256 | "type": "object",
2257 | "properties": {
2258 | "stopId": {
2259 | "type": "integer",
2260 | "format": "int32"
2261 | },
2262 | "routeNumber": {
2263 | "type": "string"
2264 | },
2265 | "direction": {
2266 | "type": "string"
2267 | },
2268 | "time": {
2269 | "type": "string"
2270 | }
2271 | }
2272 | },
2273 | "XtpApiDtos.TinyPassenger.VehicleStatusDto": {
2274 | "type": "object",
2275 | "properties": {
2276 | "busNumber": {
2277 | "type": "integer",
2278 | "format": "int32"
2279 | },
2280 | "state": {
2281 | "type": "string",
2282 | "enum": [
2283 | "On",
2284 | "Off",
2285 | "Standby",
2286 | "BetweenVoyages",
2287 | "InVoyage",
2288 | "Undefined",
2289 | "Unknown"
2290 | ]
2291 | },
2292 | "lastGpsTime": {
2293 | "type": "string",
2294 | "format": "date-time"
2295 | },
2296 | "lastReportTime": {
2297 | "type": "string",
2298 | "format": "date-time"
2299 | },
2300 | "lat": {
2301 | "type": "number",
2302 | "format": "double"
2303 | },
2304 | "lng": {
2305 | "type": "number",
2306 | "format": "double"
2307 | },
2308 | "routeNumber": {
2309 | "type": "string"
2310 | },
2311 | "direction": {
2312 | "type": "string"
2313 | },
2314 | "plateNumber": {
2315 | "type": "string"
2316 | },
2317 | "timeStamp": {
2318 | "type": "string",
2319 | "format": "date-time"
2320 | },
2321 | "dataServico": {
2322 | "type": "string",
2323 | "format": "date-time"
2324 | },
2325 | "previousReportTime": {
2326 | "type": "string",
2327 | "format": "date-time"
2328 | },
2329 | "previousLatitude": {
2330 | "type": "number",
2331 | "format": "double"
2332 | },
2333 | "previousLongitude": {
2334 | "type": "number",
2335 | "format": "double"
2336 | }
2337 | }
2338 | },
2339 | "body": {
2340 | "required": [
2341 | "token",
2342 | "type"
2343 | ],
2344 | "type": "object",
2345 | "properties": {
2346 | "token": {
2347 | "type": "string"
2348 | },
2349 | "type": {
2350 | "type": "string"
2351 | }
2352 | }
2353 | }
2354 | },
2355 | "securitySchemes": {
2356 | "Authorization": {
2357 | "type": "http",
2358 | "scheme": "bearer",
2359 | "bearerFormat": "JWT"
2360 | }
2361 | }
2362 | }
2363 | }
--------------------------------------------------------------------------------
3 |