-
Notifications
You must be signed in to change notification settings - Fork 1
/
backend.yaml
4239 lines (4237 loc) · 125 KB
/
backend.yaml
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
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
title: 'Backend API'
contact:
name: 'Jiri Vosecek'
url: 'https://www.freebike.com'
email: [email protected]
version: '1.0'
servers:
- url: 'https://tkhs-integration.azurewebsites.net/Services/Api'
description: 'Backend address'
tags:
- name: Service Module
description: Requires Service User checkbox on for user using these endpoints.
- name: Service Module Tasks
description: Requires Service User checkbox on for user using these endpoints. Work with Tasks
- name: Service Module Repairs
description: Requires Service User checkbox on for user using these endpoints. Work with Repairs
- name: Service Module Spare Parts
description: Requires Service User checkbox on for user using these endpoints. Work with Spare Parts
- name: Customer Operation
description: Endpoints for operation available for all customers, requires Bearer token authorization. The identity of the customer for which the data should be operated is inferred from authentication information.
- name: General
description: General system info, public
- name: Map data
description: Public available map data and location detail. Provides all information for show map with bikes, locations, areas
- name: Authorization
description: Create Bearer token for authorized operations
- name: Call Center Operation
description: Special endpoints for operations available only for users with specific permission in Backend
- name: Rentals
description: "Rent bike endpoints, same for Service Users and regular customers <img src='rent-return-bike.png' alt='Rent/return bike' /><figcaption>Rent/return bike flow: (<a target='_blank' href='./rent-return-bike.png'>full scale</a>)</figcaption></figure>"
- name: Reports
description: Anonymized statistics
paths:
/ExternalService/AddCreditEx:
post:
tags:
- Call Center Operation
summary: Add credit for given user
description: Users need to have permission for External web service – AddCreditEx to be able to invoke this function.
parameters:
- $ref: '#/components/parameters/lang'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
title: TKAccountActivity
properties:
CustomerID:
type: number
example: 1123
ActivityTypeExternalID:
type: string
example: EXT_WS_CREDIT_CARD
Amount:
type: number
default: 0
example: 10
DepositAmount:
type: number
default: 0
example: 0
BonusAmount:
type: number
default: 0
example: 0
Currency:
type: number
description: id of used currency, not necessary
EPaymentOrderID:
type: string
description: id of payment
Note:
type: string
ExternalID:
type: string
example: x10
description: custom id
responses:
204:
description: credit added
400:
description: Invalid value, error described
/report-rental-daily:
get:
tags:
- Reports
summary: Rentals for given day
description: Anonymized data about rentals for given day
parameters:
- $ref: '#/components/parameters/lang'
- name: dataDate
in: query
required: true
schema:
type: string
format: date
example: '2021-06-05'
responses:
200:
description: csv file to download
/Location/Map/Extended:
get:
tags:
- Map data
summary: Full map data
description: Complete map data without bikes locked outside of location, use also GetBikesOutOfLocation endpoint. Data might be filtered using latitude and longitude parameters to get reduced data
parameters:
- $ref: '#/components/parameters/lang'
- name: latitude1
in: query
description: square for limit retrieved data
required: false
schema:
type: number
example: 50.10
- name: longitude1
in: query
description: square for limit retrieved data
required: false
schema:
type: number
example: 15.70
- name: latitude2
in: query
description: square for limit retrieved data
required: false
schema:
type: number
example: 50.07
- name: longitude2
in: query
description: square for limit retrieved data
required: false
schema:
type: number
example: 16.00
responses:
'200':
description: 'Info about map data'
content:
application/json:
schema:
$ref: '#/components/schemas/TKMapData'
'404':
description: 'Unknown path, fix parameters name'
content:
application/json:
schema:
$ref: '#/components/schemas/TKNotFoundException'
'/{type}':
get:
tags:
- General
summary: 'Get articles'
description: Returns articles for given type
parameters:
- $ref: '#/components/parameters/pageNumber'
- name: type
in: path
description: 'News type'
required: true
schema:
type: string
enum:
- News
- Faqs
- Infos
- Contacts
example: News
- name: lang
in: query
description: 'Localized version of News is available, otherwise return News in default lang'
required: true
schema:
type: string
example: en
- name: externalClientId
in: query
description: 'Type of client, case insensitive'
required: true
schema:
default: iphone
enum:
- web
- android
- iphone
responses:
'200':
description: 'News for given parameters'
content:
application/json:
schema:
$ref: '#/components/schemas/TKInfos'
'404':
description: 'Unknown path, fix parameters name'
content:
application/json:
schema:
$ref: '#/components/schemas/TKNotFoundException'
'405':
description: 'Incorrect page number, try pageNumber=1'
content:
application/json:
schema:
$ref: '#/components/schemas/TKServiceException'
/Bike/GetBikesAtLocation:
get:
tags:
- 'Map data'
summary: 'Bikes in this location (not in hardware lock)'
description: Bike position ought to be showed on its coords if are available and not exactly on the location marker
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/locationId'
responses:
'200':
description: 'Bikes returned to Location and not in Hardware Lock'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TKBike'
'404':
description: 'Unknown path, fix parameters name'
content:
application/json:
schema:
$ref: '#/components/schemas/TKNotFoundException'
/Bike/GetBikesOutOfLocation:
get:
tags:
- Map data
summary: Bikes locked out of any Location
description: All bikes available for rent locked out of location
parameters:
- $ref: '#/components/parameters/lang'
responses:
'200':
description: 'Bikes returned to coordinates'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TKBike'
'404':
description: 'Unknown path, fix parameters name'
content:
application/json:
schema:
$ref: '#/components/schemas/TKNotFoundException'
/Setting:
get:
tags:
- General
summary: System setting
description: Backend system configuration
responses:
'200':
description: 'Backend setting'
content:
application/json:
schema:
type: array
items:
allOf: [
{ $ref: '#/components/schemas/TKSetting_RENTAL_ALLOW_EXTERNAL_RENTAL' },
{ $ref: '#/components/schemas/TKSetting_RENTAL_ALLOW_EXTERNAL_RETURN' },
{ $ref: '#/components/schemas/TKSetting_RENTAL_EXTERNAL_MAX_LOCATION_DISTANCE' },
{ $ref: '#/components/schemas/TKSetting_RENTAL_ALLOW_EXTERNAL_RENTAL_ANYWHERE' },
{ $ref: '#/components/schemas/TKSetting_RENTAL_ALLOW_EXTERNAL_RETURN_ANYWHERE' },
{ $ref: '#/components/schemas/TKSetting_RENTAL_EXTERNAL_CONFIRMATION_REQUIRE' },
{ $ref: '#/components/schemas/TKSetting_RENTAL_EXTERNAL_MAX_BIKE_DISTANCE_METRES' },
{ $ref: '#/components/schemas/TKSetting_RESERVATION_PREAUTH_DISTANCE' },
{ $ref: '#/components/schemas/TKSetting_ACTIVE_SEASON_START' },
{ $ref: '#/components/schemas/TKSetting_ACTIVE_SEASON_END' },
{ $ref: '#/components/schemas/TKSetting_ACTIVE_FREEBIKE_COUNT' },
{ $ref: '#/components/schemas/TKSetting_GBFS_URL' },
{ $ref: '#/components/schemas/TKSetting_GBFS_FREEBIKE_BATTERY_RANGE_CORRECTION' },
{ $ref: '#/components/schemas/TKSetting_GBFS_MAX_RANGE_METERS' },
{ $ref: '#/components/schemas/TKSetting_GBFS_IOS_DISCOVERY_URI' },
{ $ref: '#/components/schemas/TKSetting_GBFS_ANDROID_DISCOVERY_URI' },
{ $ref: '#/components/schemas/TKSetting_GBFS_ANDROID_STORE_URI' },
{ $ref: '#/components/schemas/TKSetting_GBFS_IOS_STORE_URI' },
{ $ref: '#/components/schemas/TKSetting_GBFS_EMAIL' },
{ $ref: '#/components/schemas/TKSetting_GBFS_TELEPHONE' },
{ $ref: '#/components/schemas/TKSetting_RESERVATION_PREAUTH_TIMEOUT' }
]
/Setting/Timezone:
get:
tags:
- General
summary: System Timezone
description: 'Returns information about the time zone currently used by the server. Contains standardized ID, Windows ID and current offset from UTC in seconds.'
responses:
'200':
description: 'Timezone settings for system'
content:
application/json:
schema:
$ref: '#/components/schemas/Timezone'
/Area:
get:
tags:
- Map data
summary: Areas
description: Data about areas in system, ought to be painted as polygons. Colors for Geofence areas are defined in Frontend endpoint /setting.
parameters:
- $ref: '#/components/parameters/lang'
responses:
'200':
description: 'List of Areas with points'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TKArea'
/EBikeProfiles:
get:
tags:
- Map data
summary: EBike Profiles
description: Attributes CpuVersion, GPSMessageInterval, ServiceMessageInterval, BlockTime, ServerTimeout and RetryCount are always null if non-authorized.
parameters:
- $ref: '#/components/parameters/lang'
responses:
'200':
description: 'List of EBike Profiles'
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TKEBikeProfile'
/Token:
post:
tags:
- Authorization
summary: Authorization request
description: 'Get new token for Authorized requests. User Body for new Token, use query params for renew token.'
parameters:
- name: grant_type
in: query
description: 'Value ''refresh_token'' must be provided'
schema:
type: string
default: refresh_token
- name: refresh_token
in: query
description: 'refresh token retrieved from /Token earlier'
schema:
type: string
example: 8a9f70ab98844fb88a381c974627c0c0
- name: client_id
in: query
description: 'provided client_id'
schema:
type: string
example: iphone
- name: client_secret
in: query
description: 'provided client_secret'
schema:
type: string
example: qImYrunr0+1pT4KatZHYWYCS82FE8bIzZZpw6IZT6pKNDjd2soth25J6ovoajUL9+yOtE
- $ref: '#/components/parameters/lang'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
properties:
grant_type:
description: 'Value ''password'' must be provided'
type: string
example: password
username:
description: 'card number'
type: string
example: '44587'
password:
description: 'card pin'
type: string
example: '10001'
client_id:
description: 'provided client_id'
type: string
example: iphone
client_secret:
description: 'provided client_secret'
type: string
example: qImYrunr0+1pT4KatZHYWYCS82FE8bIzZZpw6IZT6pKNDjd2soth25J6ovoajUL9+yOtE
lang:
description: 'lang for localised response'
type: string
example: cs
type: object
responses:
'200':
description: 'Access token'
content:
application/json:
schema:
$ref: '#/components/schemas/KITEToken'
'400':
description: 'Incorrect card number or card pin or invalid client_id or client_secret'
content:
application/json:
schema:
$ref: '#/components/schemas/TKErrorException'
/Users/RemoveCreditEx:
put:
tags:
- Call Center Operation
summary: Subtract credit of the customer.
description: The function only allow one of parameters amount, depositAmount or bonusAmount at a time. Users need to have permission External web service – RemoveCreditEx to be able to invoke this function.
parameters:
- $ref: '#/components/parameters/lang'
- name: activityType
in: query
schema:
type: string
description: Account activity types
example: CREDIT_DEBIT
required: true
- name: amount
in: query
schema:
nullable: true
type: number
description: Amount
example: 10
required: true
- name: depositAmount
in: query
schema:
type: number
nullable: true
description: Deposit Amount
example: null
required: true
- name: bonusAmount
in: query
schema:
type: number
nullable: true
description: Bonus Amount
example: null
required: true
- name: currency
in: query
schema:
type: string
description: Currency
example: CZK
required: true
- name: customerID
in: query
schema:
type: integer
description: Customer ID
required: true
- name: note
in: query
schema:
nullable: true
type: string
description: Note
example: null
required: true
- $ref: '#/components/parameters/SparePartExternalId'
responses:
'200':
description: 'Customer data detail'
content:
application/json:
schema:
$ref: '#/components/schemas/TKCustomer'
'400':
description: 'Problem with detail information'
content:
application/json:
schema:
$ref: '#/components/schemas/TKServiceException'
/User:
get:
tags:
- Customer Operation
summary: Get customer data
parameters:
- $ref: '#/components/parameters/lang'
responses:
'200':
description: 'Customer data detail'
content:
application/json:
schema:
$ref: '#/components/schemas/TKCustomer'
put:
tags:
- Customer Operation
summary: Update customer data
description: The JSON-serialized User object should be put in the request body and the request content type should be set to application/json
parameters:
- $ref: '#/components/parameters/lang'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/TKCustomer'
responses:
'204':
description: 'Account updated, response is empty'
'404':
description: 'Unknown path, fix parameters name'
content:
application/json:
schema:
$ref: '#/components/schemas/TKNotFoundException'
'409':
description: 'The data were concurrently updated by another user. Use GET /User to retrieve user data.'
content:
application/json:
schema:
$ref: '#/components/schemas/TKServiceException'
/Bike/BikeTypes:
get:
tags:
- Map data
summary: get list of bike types
description: array of BikeType to show in help section and optionally custom bike detail image and map icon
parameters:
- $ref: '#/components/parameters/lang'
responses:
200:
description: bike types list
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TKBikeType'
/Bike/QR:
get:
tags:
- Map data
summary: Get Bike info by QR
description: Load bike detail based on its BikeIdentifier
parameters:
- $ref: '#/components/parameters/lang'
- name: bikeIdentifier
in: query
schema:
type: string
responses:
200:
description: Bike info
content:
application/json:
schema:
$ref: '#/components/schemas/TKBike'
/User/Bike/OpenBox:
get:
tags:
- IoT Bike communication
summary: Open bike box to remove battery
description: Send request for IoT message to bike to open battery box, user have to be Service user
parameters:
- name: bikeIdentifier
in: query
schema:
type: string
responses:
200:
description: OK
/User/Bike/GetInfo:
get:
tags:
- IoT Bike communication
summary: Get bike info
description: Send request for IoT message to bike to return bike status data, user have to be Service user
parameters:
- name: bikeIdentifier
in: query
schema:
type: string
responses:
200:
description: json data from bike
/User/Bike/RegisterCard:
get:
tags:
- Customer Operation
summary: 'Register new RFID card to user'
description: "<h2>Diagram</h2><img src='register-card.png' alt='Register card bike' /><figcaption>Register card bike flow: (<a target='_blank' href='./register-card.png'>full scale</a>)</figcaption></figure>"
parameters:
- name: bikeIdentifier
description: qr code of bike
in: query
schema:
type: string
- name: pin
in: query
description: current card pin
schema:
type: integer
- name: cardNumber
in: query
description: current card number
schema:
type: integer
responses:
'200':
description: 'Register process started, bike should be blinking blue light'
/Bike:
get:
tags:
- Service Module
summary: Get Bike detail
description: Technical details of bike
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/bikeId'
responses:
200:
description: Technical bike details
content:
application/json:
schema:
$ref: '#/components/schemas/TKBikeServiceData'
/AllBikes:
get:
summary: Get all bikes
description: Returns bikes in all states
tags:
- Service Module
parameters:
- $ref: '#/components/parameters/lang'
responses:
200:
description: list of all bikes
content:
application/json:
schema:
$ref: '#/components/schemas/TKBikeAllBikes'
/Task:
get:
tags:
- Service Module Tasks
summary: Task for user, filterable
description: Show all available task for current user, assigned to this user or available to read
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/pageNumber'
- name: ID
in: query
schema:
type: integer
- name: TaskTypeID
in: query
schema:
type: integer
- name: StateID
in: query
schema:
type: integer
- name: CreatedForm
in: query
schema:
type: string
format: date-time
- name: CreatedUntil
in: query
schema:
type: string
format: date-time
- name: AssignedToID
in: query
schema:
type: integer
- name: EquipmentTypeID
in: query
schema:
type: integer
- name: EquipmentID
in: query
schema:
type: integer
- name: PriorityID
in: query
schema:
type: integer
- name: LocationID
in: query
schema:
type: integer
responses:
200:
description: list of service tasks
content:
application/json:
schema:
type: object
properties:
PageNumber:
title: 'Current page number'
type: integer
example: 2
PageTotal:
title: 'Total pages'
type: integer
example: 4
ServiceTasks:
title: 'List of tasks'
type: array
items:
$ref: '#/components/schemas/TKServiceTask'
/User/Groups:
get:
tags:
- Customer Operation
summary: get list of available user groups
description: retrieve list of groups, needed for registration system to assign user to some group in registration process
parameters:
- $ref: '#/components/parameters/lang'
responses:
200:
description: list of groups
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/TKUserGroup'
/User/Task:
get:
tags:
- Service Module Tasks
summary: Service tasks for user
description: Requires Service User permissions, filtering not available, user `/Task` endpoint for filtering
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/pageNumber'
responses:
200:
description: list of service tasks
content:
application/json:
schema:
type: object
properties:
PageNumber:
title: 'Current page number'
type: integer
example: 2
PageTotal:
title: 'Total pages'
type: integer
example: 4
ServiceTasks:
title: 'List of tasks'
type: array
items:
$ref: '#/components/schemas/TKServiceTask'
/User/Task/{id}:
get:
tags:
- Service Module Tasks
summary: Get service task detail by `id`
parameters:
- name: id
in: path
description: task id
required: true
schema:
type: integer
responses:
200:
description: list of service tasks
content:
application/json:
schema:
$ref: '#/components/schemas/TKServiceTask'
/Task/Update:
put:
summary: Update task
tags:
- Service Module Tasks
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/tasktypeId'
- $ref: '#/components/parameters/stateId'
- $ref: '#/components/parameters/Task_priorityId'
- $ref: '#/components/parameters/Task_assignedtoId'
- $ref: '#/components/parameters/SparePart_EquipmentTypeId'
- $ref: '#/components/parameters/Task_equipmentId'
- $ref: '#/components/parameters/Task_additionalinfo'
- $ref: '#/components/parameters/locationId'
- $ref: '#/components/parameters/Task_note'
- $ref: '#/components/parameters/Task_escalate'
- name: id
description: task id
in: query
required: true
schema:
type: integer
responses:
200:
description: changed service task
content:
application/json:
schema:
$ref: '#/components/schemas/TKServiceTask'
/Task/Create:
post:
summary: Create new service task
tags:
- Service Module Tasks
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/stateId'
- $ref: '#/components/parameters/SparePart_EquipmentTypeId'
- $ref: '#/components/parameters/locationId'
- $ref: '#/components/parameters/Task_assignedtoId'
- $ref: '#/components/parameters/tasktypeId'
- $ref: '#/components/parameters/Task_priorityId'
- $ref: '#/components/parameters/Task_equipmentId'
- $ref: '#/components/parameters/Task_additionalinfo'
- $ref: '#/components/parameters/Task_note'
- $ref: '#/components/parameters/Task_escalate'
responses:
200:
description: created service task
content:
application/json:
schema:
$ref: '#/components/schemas/TKServiceTask'
/Roles:
get:
summary: Available roles
tags:
- Service Module
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/pageNumber'
responses:
200:
description: List of roles
content:
application/json:
schema:
properties:
PageNumber:
title: 'Current page number'
type: integer
example: 2
PageTotal:
title: 'Total pages'
type: integer
example: 4
ServiceTasks:
type: array
items:
$ref: '#/components/schemas/UserRole'
/Users:
get:
summary: Return the list of users
description: The caller user must have the permission Users = 33 to call.
tags:
- Service Module
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/pageNumber'
- name: isServiceMan
in: query
schema:
type: boolean
responses:
200:
description: List of users
content:
application/json:
schema:
properties:
PageNumber:
title: 'Current page number'
type: integer
example: 2
PageTotal:
title: 'Total pages'
type: integer
example: 4
List:
type: array
items:
$ref: '#/components/schemas/User'
/Task/Repair:
get:
tags:
- Service Module Repairs
summary: Get list of repairs
description: filtering by a lot of ids
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/pageNumber'
- $ref: '#/components/parameters/TaskTaskID'
- $ref: '#/components/parameters/Task_equipmentTypeID'
- name: repairID
in: query
required: false
schema:
type: integer
- name: faultTypeID
in: query
required: false
schema:
type: integer
- name: stateID
in: query
required: false
schema:
type: integer
- name: equipmentID
in: query
required: false
schema:
type: integer
- name: maintenanceOperationID
in: query
required: false
schema:
type: integer
responses:
200:
description: List of repaires
content:
application/json:
schema:
properties:
PageNumber:
title: 'Current page number'
type: integer
example: 2
PageTotal:
title: 'Total pages'
type: integer
example: 4
ServiceTasks:
type: array
format: array
items:
$ref: '#/components/schemas/ExtendedTKRepair'
/Task/Repair/Create:
post:
tags:
- Service Module Repairs
summary: Create repair
parameters:
- $ref: '#/components/parameters/lang'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/TKRepair'
responses:
204:
description: Created repair
content:
application/json:
schema:
$ref: '#/components/schemas/ExtendedTKRepair'
/Task/Repair/RemoveSparePart:
delete:
tags:
- Service Module Repairs
summary: Remove spare part from repair
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/SparePartID'
- $ref: '#/components/parameters/repairID'
responses:
204:
description: OK
/Task/Repair/AddSparePart:
post:
summary: Add spare part to repair
tags:
- Service Module Repairs
parameters:
- $ref: '#/components/parameters/lang'
- $ref: '#/components/parameters/SparePartID'
- $ref: '#/components/parameters/repairID'
- name: count
required: false
in: query
description: number of this spare parts used in this repair, default 1