vasystem-api-grpc 0.1.17

VASystem API gRPC
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982

�
vasystem/api/v2/airlines.protovasystem.api.v2"
ListAirlinesRequest"L
ListAirlinesResponse4
airlines (2.vasystem.api.v2.AirlineRairlines"�
Airline
id (	Rid
	icao_code (	RicaoCode
	iata_code (	RiataCode*
display_icao_code (	RdisplayIcaoCode*
display_iata_code (	RdisplayIataCode
name (	Rname2p
AirlinesService]
ListAirlines$.vasystem.api.v2.ListAirlinesRequest%.vasystem.api.v2.ListAirlinesResponse"J�
0




+
 Retrieve airline information.





I List airlines




&

1E
i
^ The ListAirlinesRequest message defines the request parameters for the
 ListAirlines method.




l
` The ListAirlinesResponse message defines the response parameters for the
 ListAirlines method.





 









8
0, An Airline resource represents an airline.




1
$ Unique identifier for the airline.




	


=
0 The ICAO airline code. Unique.
 Example: `UAL`




	


N
A The IATA airline code. This field is not unique.
 Example: `UA`




	


�
&� The ICAO airline display code. This is the code that is displayed to
 users and is usually the same as the ICAO code. However, some airlines
 have different display codes when they are a subsidiary of another airline,
 but use the same ICAO code as their parent company. As such, this field
 may not be unique.
 Example: `UAL`


&

&	

&
�
+� The IATA airline display code. This is the code that is displayed to
 users and is usually the same as the IATA code. Currently, this will
 always be the same as the IATA code.
 Example: `UA`


+

+	

+
<
// The airline name.
 Example: `United Airlines`


/

/	

/bproto3
�
vasystem/api/v2/aircraft.protovasystem.api.v2vasystem/api/v2/airlines.proto"l
AircraftType
id (	Rid
	icao_code (	RicaoCode
	iata_code (	RiataCode
name (	Rname"�

AircraftModel
id (	RidB

aircraft_type (2.vasystem.api.v2.AircraftTypeRaircraftType2
airline (2.vasystem.api.v2.AirlineRairline
name (	RnameJ�	
!




	
(
s
g An AircraftType resource represents a type of aircraft, irrespective of the airline that operates it.




6
	) Unique identifier of the aircraft type.


	

		

	
D
7 The ICAO aircraft type code. Unique.
 Example: `B738`




	


;
. The IATA aircraft type code.
 Example: `738`




	


H
; The name of the aircraft type.
 Example: `Boeing 737-800`




	


�
!� An AircraftModel resource represents a model of aircraft. An aircraft model is an aircraft type linked
 to an airline and its configuration (usually seating configuration).




7
* Unique identifier of the aircraft model.




	


$
! The type of aircraft.






 
<
/ The airline that operates the aircraft model.


	





N
 A The name of the aircraft model.
 Example: `	Boeing 737-824(WL)`


 

 	

 bproto3
�
vasystem/api/v2/airports.protovasystem.api.v2"S
Airport
id (	Rid
	icao_code (	RicaoCode
	iata_code (	RiataCodeJ�






8

, An Airport resource represents an airport.




4
' The unique identifier of the airport.




	


3

& The ICAO airport identifier. Unique.






	



E
8 The IATA airport identifier. This field is not unique.




	

bproto3
�
vasystem/api/v2/dayofweek.protovasystem.api.v2*�
	DayOfWeek
DAY_OF_WEEK_UNSPECIFIED
DAY_OF_WEEK_MONDAY
DAY_OF_WEEK_TUESDAY
DAY_OF_WEEK_WEDNESDAY
DAY_OF_WEEK_THURSDAY
DAY_OF_WEEK_FRIDAY
DAY_OF_WEEK_SATURDAY
DAY_OF_WEEK_SUNDAYJ�	

*
�

� Copyright 2016 Google Inc.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.



'
* Represents a day of week.




+
 The unspecified day-of-week.





)
 The day-of-week of Monday.





*
 The day-of-week of Tuesday.





,
 The day-of-week of Wednesday.





+
  The day-of-week of Thursday.


 

 
)
# The day-of-week of Friday.


#

#
+
& The day-of-week of Saturday.


&

&
)
) The day-of-week of Sunday.


)

)bproto3
�%
google/protobuf/duration.protogoogle.protobuf":
Duration
seconds (Rseconds
nanos (RnanosB�
com.google.protobufB
DurationProtoPZ1google.golang.org/protobuf/types/known/durationpb��GPB�Google.Protobuf.WellKnownTypesJ�#
s
�
2� Protocol Buffers - Google's data interchange format
 Copyright 2008 Google Inc.  All rights reserved.
 https://developers.google.com/protocol-buffers/

 Redistribution and use in source and binary forms, with or without
 modification, are permitted provided that the following conditions are
 met:

     * Redistributions of source code must retain the above copyright
 notice, this list of conditions and the following disclaimer.
     * Redistributions in binary form must reproduce the above
 copyright notice, this list of conditions and the following disclaimer
 in the documentation and/or other materials provided with the
 distribution.
     * Neither the name of Google Inc. nor the names of its
 contributors may be used to endorse or promote products derived from
 this software without specific prior written permission.

 THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
 A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
 LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


 

";
	
%";

#
	
#

$H
	
$H

%,
	
%,

&.
	
&.

'"
	

'"

(!
	
$(!
�
fs� A Duration represents a signed, fixed-length span of time represented
 as a count of seconds and fractions of seconds at nanosecond
 resolution. It is independent of any calendar and concepts like "day"
 or "month". It is related to Timestamp in that the difference between
 two Timestamp values is a Duration and it can be added or subtracted
 from a Timestamp. Range is approximately +-10,000 years.

 # Examples

 Example 1: Compute Duration from two Timestamps in pseudo code.

     Timestamp start = ...;
     Timestamp end = ...;
     Duration duration = ...;

     duration.seconds = end.seconds - start.seconds;
     duration.nanos = end.nanos - start.nanos;

     if (duration.seconds < 0 && duration.nanos > 0) {
       duration.seconds += 1;
       duration.nanos -= 1000000000;
     } else if (duration.seconds > 0 && duration.nanos < 0) {
       duration.seconds -= 1;
       duration.nanos += 1000000000;
     }

 Example 2: Compute Timestamp from Timestamp + Duration in pseudo code.

     Timestamp start = ...;
     Duration duration = ...;
     Timestamp end = ...;

     end.seconds = start.seconds + duration.seconds;
     end.nanos = start.nanos + duration.nanos;

     if (end.nanos < 0) {
       end.seconds -= 1;
       end.nanos += 1000000000;
     } else if (end.nanos >= 1000000000) {
       end.seconds += 1;
       end.nanos -= 1000000000;
     }

 Example 3: Compute Duration from datetime.timedelta in Python.

     td = datetime.timedelta(days=3, minutes=10)
     duration = Duration()
     duration.FromTimedelta(td)

 # JSON Mapping

 In JSON format, the Duration type is encoded as a string rather than an
 object, where the string ends in the suffix "s" (indicating seconds) and
 is preceded by the number of seconds, with nanoseconds expressed as
 fractional seconds. For example, 3 seconds with 0 nanoseconds should be
 encoded in JSON format as "3s", while 3 seconds and 1 nanosecond should
 be expressed in JSON format as "3.000000001s", and 3 seconds and 1
 microsecond should be expressed in JSON format as "3.000001s".





f
�
j� Signed seconds of the span of time. Must be from -315,576,000,000
 to +315,576,000,000 inclusive. Note: these bounds are computed from:
 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years


j

j

j
�
r� Signed fractions of a second at nanosecond resolution of the span
 of time. Durations less than one second are represented with a 0
 `seconds` field and a positive or negative `nanos` field. For durations
 of one second or more, a non-zero value for the `nanos` field must be
 of the same sign as the `seconds` field. Must be from -999,999,999
 to +999,999,999 inclusive.


r

r

rbproto3
�
vasystem/api/v2/timeofday.protovasystem.api.v2"k
	TimeOfDay
hours (Rhours
minutes (Rminutes
seconds (Rseconds
nanos (RnanosJ�

"
�
� Copyright 2019 Google LLC.

 Licensed under the Apache License, Version 2.0 (the "License");
 you may not use this file except in compliance with the License.
 You may obtain a copy of the License at

     http://www.apache.org/licenses/LICENSE-2.0

 Unless required by applicable law or agreed to in writing, software
 distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License.




v
"j Represents a time of day. The date and time zone are either not significant
 or are specified elsewhere.




�
� Hours of day in 24 hour format. Should be from 0 to 23. An API may choose
 to allow the value "24:00:00" for scenarios like business closing time.







<
/ Minutes of hour of day. Must be from 0 to 59.







�
z Seconds of minutes of the time. Must normally be from 0 to 59. An API may
 allow the value 60 if it allows leap-seconds.







R
!E Fractions of seconds in nanoseconds. Must be from 0 to 999,999,999.


!

!

!bproto3
�#
vasystem/api/v2/routes.protovasystem.api.v2google/protobuf/duration.protovasystem/api/v2/aircraft.protovasystem/api/v2/airlines.protovasystem/api/v2/airports.protovasystem/api/v2/dayofweek.protovasystem/api/v2/timeofday.proto"�
ListRoutesRequest

airline_id (	R	airlineId%
departure_icao (	R
departureIcao!
arrival_icao (	RarrivalIcao,
icao_flight_number (	RicaoFlightNumber)
include_archived (RincludeArchived
	page_size (RpageSize

page_token (	R	pageToken"l
ListRoutesResponse.
routes (2.vasystem.api.v2.RouteRroutes&
next_page_token (	R
nextPageToken"�
Route
id (	Rid2
airline (2.vasystem.api.v2.AirlineRairline,
icao_flight_number (	RicaoFlightNumber6
	departure (2.vasystem.api.v2.AirportR	departure2
arrival (2.vasystem.api.v2.AirportRarrivalA
departure_time (2.vasystem.api.v2.TimeOfDayR
departureTime=
arrival_time (2.vasystem.api.v2.TimeOfDayRarrivalTime5
duration	 (2.google.protobuf.DurationRduration9

days_flown
 (2.vasystem.api.v2.DayOfWeekR	daysFlownG
aircraft_models (2.vasystem.api.v2.AircraftModelRaircraftModels
archived (Rarchived2h

RoutesServiceW

ListRoutes".vasystem.api.v2.ListRoutesRequest#.vasystem.api.v2.ListRoutesResponse"J�
Y




	
(
	
(
	
(
	
(
	
)
	
	)
)
 Retrieve route information.




9
C, List routes. This is a paginated endpoint.




"

-?
f
)Z The ListRoutesRequest message defines the request parameters for the
 ListRoutes method.




H
; Filter by airline.
 Example: `01gevxx0g090m0a78xmvhtfre4`




	


<
/ Filter by departure airport.
 Example: `KJFK`




	


:
- Filter by arrival airport.
 Example: `YSSY`




	


d
 W Filter by the flight number. This does not include the airline code.
 Example: `1234`




	


E
"8 Whether to include archived routes. Defaults to false.


"

"

"
Y
%L The maximum number of results to return. Defaults to 100. Maximum is 1000.


%

%	

%
�
(� The next_page_token value returned from a previous List request, if any.
 If used, all other parameters must match the call that provided the token.


(

(	

(
h
-7\ The ListRoutesResponse message defines the response parameters for the
 ListRoutes method.



-
"
/ The list of routes.


/


/

/

/
�
6� The next_page_token value to include in a subsequent List request. When
 paginating, all other parameters provided to List must match the call that
 provided the page token.
 When this field is empty, there are no more results. However, if the
 field is non-empty, there may not be any more results on the next page.


6

6	

6
S
:YG A Route represents a regularly scheduled flight between two airports.



:
3
<& The unique identifier for the route.


<

<	

<
4
?' The airline that operates this route.


?	

?


?
G
B : This does not include the airline code.
 Example: `1234`


B

B	

B
%
E The departure airport.


E	

E


E
#
G The arrival airport.


G	

G


G
,
J The departure time is in UTC.


J

J

J
*
L The arrival time is in UTC.


L

L

L
�
O(� The duration of this flight. This field is purely provided for convenience and can also
 be calculated from the departure and arrival times.


O

O#

O&'
>
R%1 The days of the week that this flight operates.


R


R

R

R"$
;
	U.. The aircraft models that operate this route.


	U


	U

	U(

	U+-
\

XO Whether this route is archived. An archived route cannot be booked by pilots.



X


X


Xbproto3
�

&vasystem/api/v2/virtual_airlines.protovasystem.api.v2"
GetVirtualAirlineRequest"e
GetVirtualAirlineResponseH
virtual_airline (2.vasystem.api.v2.VirtualAirlineRvirtualAirline"6
VirtualAirline
name (	Rname
url (	Rurl2�
VirtualAirlinesServicel
GetVirtualAirline).vasystem.api.v2.GetVirtualAirlineRequest*.vasystem.api.v2.GetVirtualAirlineResponse"J�





3
	' Retrieve virtual airline information.




]
XP Get virtual airline information.
 This method does not require authentication.




0

;T
t

#i The GetVirtualAirlineRequest message contains the request parameters for the
 GetVirtualAirline method.




 
w
k The GetVirtualAirlineResponse message contains the response parameters for the
 GetVirtualAirline method.



!

%



 

#$
�
v A VirtualAirline resource represents a virtual airline. All methods in the API
 operate on a single virtual airline.




Q
D The name of the virtual airline.
 Example: `Star Alliance Virtual`




	


g
Z The main website URL of the virtual airline.
 Example: `https://staralliancevirtual.org`




	

bproto3