/
swagger.json
12574 lines (12574 loc) · 386 KB
/
swagger.json
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.3",
"info": {
"title": "Cloud4Log API",
"version": "1.4.0",
"description": "The documented API is used by the frontend hosted on cloud4log.com. If you have valid login credentials you can start right away by using the button \"Authorize\". You can then start to call the API. The login request will respond with a organisation side-ID. You need this and ID for most of the requests, for example upload a delivery note into the sites delivery note pool: POST /organization-sites/{organizationSiteKey}/delivery-notes/pdf/{fileName}. Endpoints can appear multiple times, when they have more than one tag. See this Github repository to import the API directly into swagger and to see releases and changelogs: https://github.com/JR-2022/C4L"
},
"servers": [
{
"url": "/api/v2"
}
],
"security": [
{
"ApiKeyAuth": []
}
],
"paths": {
"/organizations/{organizationKey}/load-carrier-templates": {
"get": {
"description": "Get all permitted load carrier templates of this organization.\n",
"summary": "Get all load carrier templates of organization",
"operationId": "getLoadCarrierTemplates",
"x-dls-requiredOrganizationPermission": "loadcarrier_templates_read",
"tags": [
"load carrier templates"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"responses": {
"200": {
"description": "Load carrier types",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GetLoadCarrierTemplatesResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/organization-sites/{organizationSiteKey}/consignor/delivery-note-bundles/signature-pads/checkout": {
"post": {
"summary": "Create signature pad for checkout",
"description": "Create new signature pad for checkout.\n",
"operationId": "postConsignorSignaturePad",
"x-dls-requiredOrganizationSitePermission": "signature_pads_create",
"tags": [
"signature pads"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostConsignorSignaturePad"
}
}
}
},
"responses": {
"200": {
"description": "One signature pad instance. Valid for 10 minutes.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSignaturePadResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/organization-sites/{organizationSiteKey}/consignee/checkins/{checkinKey}/signature-pads": {
"post": {
"summary": "Create signature pad for checkin",
"description": "Create new signature pad for checkin.\n",
"operationId": "postConsigneeSignaturePad",
"x-dls-requiredOrganizationSitePermission": "signature_pads_create",
"tags": [
"signature pads"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/checkinKeyParam"
}
],
"responses": {
"200": {
"description": "One signature pad instance. Valid for 10 minutes.",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/CreateSignaturePadResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/organization-sites/{organizationSiteKey}/consignor/delivery-note-bundles/{deliveryNoteBundleKey}/signature-pads/checkout/signature": {
"get": {
"summary": "Get signature pad for checkout",
"description": "Get a signature from a signature pad for checkout.\nThe token is the getToken from the signature pad creation request.\n",
"operationId": "getConsignorSignatureFromSignaturePad",
"x-dls-requiredOrganizationSitePermission": "signature_pads_read",
"tags": [
"signature pads"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/deliveryNoteBundleKeyParam"
},
{
"$ref": "#/components/parameters/TokenTypeParam"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PNGFileResponse"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/organization-sites/{organizationSiteKey}/consignee/checkins/{checkinKey}/signature-pads/signature": {
"get": {
"summary": "Get signature pad for checkin",
"description": "Get a signature from a signature pad for checkin.\nThe token is the getToken from the signature pad creation request.\n",
"operationId": "getConsigneeSignatureFromSignaturePad",
"x-dls-requiredOrganizationSitePermission": "signature_pads_read",
"tags": [
"signature pads"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/checkinKeyParam"
},
{
"$ref": "#/components/parameters/TokenTypeParam"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/PNGFileResponse"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/api-keys": {
"post": {
"deprecated": true,
"summary": "creates a API key",
"description": "Deprecated: Please use /administration/organizations/{organizationKey}/api-users-keys\nCreates an API user for the specified organization sites with\nthe specified permissions.\nReturns a sessionId that can't received a second time.\n",
"operationId": "createApiKeyForOrganizationSites",
"x-dls-requiredOrganizationPermission": "api_keys_create",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUserRequest"
}
}
}
},
"responses": {
"200": {
"description": "API key successful created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostApiUserResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"get": {
"summary": "Get list of all API keys for organization",
"description": "Get a list of all API keys for the given organization\n",
"operationId": "getApiKeysForOrganization",
"x-dls-requiredOrganizationPermission": "api_keys_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"responses": {
"200": {
"description": "result from operation",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUsers"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/api-users-keys": {
"post": {
"summary": "creates a API key",
"description": "Create a new api user and add this api user to the organization and the given organization sites\nand equip the new api user with permissions according to the given roles for each site.\nThe requesting user must have access to the organization the api new user is added.\nReturns a sessionId that can't received a second time.\n",
"operationId": "createApiKeyForOrganizationSitesWithRoles",
"x-dls-requiredOrganizationPermission": "api_keys_create",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUserForOrganizationAdminRequest"
}
}
}
},
"responses": {
"200": {
"description": "API key successful created",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostApiUserResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/api-keys/{userKey}": {
"put": {
"deprecated": true,
"summary": "Set new permissions for API key",
"description": "Deprecated: Please use /administration/organizations/{organizationKey}/api-users-keys/{userKey}\nNew permissions are set based on the given roles and organization sites.\nYou can also edit the API key user properties.\n",
"operationId": "putApiKeyForOrganization",
"x-dls-requiredOrganizationPermission": "api_keys_modify",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
},
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUserRequest"
}
}
}
},
"responses": {
"204": {
"description": "API key successfully patched"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/api-users-keys/{userKey}": {
"put": {
"summary": "Set new permissions for API key",
"description": "New permissions are set based on the given roles and organization sites.\nYou can also edit the API key user properties.\n",
"operationId": "putApiKeyForOrganizationWithRoles",
"x-dls-requiredOrganizationPermission": "api_keys_modify",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
},
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ApiUserForOrganizationAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "API key successfully patched"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}/load-carriers/reports/csv": {
"get": {
"summary": "Get load carriers report as csv for provided organization site",
"description": "Get report as CSV for all load carrier exchanges for all delivery notes\nat the provied organization site.\nConstrain: from <= timestamp < to, from and to must have millisecond\nresolution. Allowed time range is 35 days.\nAll times are in UTC.\n",
"operationId": "getAdministrationLoadCarriersReportsCsv",
"x-dls-requiredOrganizationSitePermission": "administration_report_load_carriers_csv_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/FromTimestampTypeParam"
},
{
"$ref": "#/components/parameters/ToTimestampTypeParam"
}
],
"responses": {
"200": {
"$ref": "#/components/responses/CSVFileResponse"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/organization-sites": {
"post": {
"summary": "Create new organization site",
"description": "Create a new organization site, which belongs to {organizationKey}\nAll organization admins (which have the role 'organization_admin')\ngain the roles organization_admin and site_admin\non the new create organization site\n",
"operationId": "postAdministrationOrganizationSite",
"x-dls-requiredOrganizationPermission": "administration_organization_sites_create",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostPatchOrganizationSiteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Created organization site",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationSite"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"get": {
"summary": "Get all organization sites of the organization.",
"description": "Get all organization sites of the organization.\nAlso returns archived sites and the date when the site was archived.\n",
"operationId": "getAdministrationOrganizationSites",
"x-dls-requiredOrganizationPermission": "administration_organization_sites_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"responses": {
"200": {
"description": "Created organization site",
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/OrganizationSite"
}
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}": {
"patch": {
"summary": "Modify organization site",
"description": "Modify an existing organization site.\nCurrently all properties are required.\nIn a later update all properties become optional.\n",
"operationId": "patchAdministrationOrganizationSite",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_modify",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostPatchOrganizationSiteRequest"
}
}
}
},
"responses": {
"200": {
"description": "Modified organization site",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationSite"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"delete": {
"summary": "Archive organization site",
"description": "Archives an organization site. After this request, the site is marked as archived.\nOnly read operations are possible after archive.\nTODO: A delete job will delete the site, if the site is no longer needs in supply chains and other.\n",
"operationId": "archiveAdministrationOrganizationSite",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_archive",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"responses": {
"200": {
"description": "Archived organization site",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/OrganizationSite"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}/remote-accesses": {
"post": {
"summary": "share remote access to another site",
"description": "Share remote access to another site. The users of the remote site\ncan have the remote_* roles. The shared organization site must have\nenabled the flag allowRemoteAccess.\n",
"operationId": "postAdministrationRemoteAccessToSite",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_remote_access_create",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PostAdministrationOrganizationSitesRemoteAccessRequest"
}
}
}
},
"responses": {
"204": {
"description": "Remote site access is authorized."
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"get": {
"summary": "Get all remote site accesses",
"description": "Get all remote site accesses\n",
"operationId": "getAdministrationRemoteAccesses",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_remote_access_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"responses": {
"200": {
"description": "List of all organization sites that have access to the site",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/RemoteAccessOrganizationSites"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}/remote-accesses/{targetOrganizationSiteKey}": {
"delete": {
"summary": "remove the remote access of an organization site",
"description": "Remove the remote access of an organization site.\n",
"operationId": "deleteAdministrationRemoteAccessToSite",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_remote_access_delete",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/targetOrganizationSiteKeyParam"
}
],
"responses": {
"204": {
"description": "Remote site access is unauthorized."
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/users": {
"get": {
"summary": "Get organization users information",
"description": "Return all users of an organization. The organization must\nbelong to the calling user.\nUsers Permissions are returned.\n",
"operationId": "getAdministrationOrganizationUsers",
"x-dls-requiredOrganizationPermission": "administration_users_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"responses": {
"200": {
"description": "All users of the requested organization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdministrationUsersInformation"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"post": {
"summary": "Create new user",
"description": "Create a new user and add this user to the organization and the given organization sites\nand equip the new user with permissions according to the given roles.\nThe requesting user must have access to the organization the new user is added.\n",
"operationId": "postAdministrationOrganizationUser",
"x-dls-requiredOrganizationPermission": "administration_users_create",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserForOrganizationAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "The user was create and added to the organization"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organizations/{organizationKey}/users/{userKey}": {
"get": {
"summary": "Get information details for one organization user",
"description": "Return one user of an organization. The organization must\nbelong to the calling user.\nUsers, Org and Sites Permissions are returned.\n",
"operationId": "getAdministrationOrganizationUser",
"x-dls-requiredOrganizationPermission": "administration_users_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
},
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"responses": {
"200": {
"description": "All users of the requested organization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdministrationUserDetails"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"put": {
"summary": "Edit user with new site roles/permissions",
"description": "Edit a existing user and add this user to the given organization sites\nand equip the new user with permissions according to the given roles.\nThe requesting user must have access to the organization the user is added.\nAll previously set permissions and linked sites are removed.\nAll sites and roles to be set must be passed.\nThe optional submitted password is ignored.\n",
"operationId": "putAdministrationOrganizationUser",
"x-dls-requiredOrganizationPermission": "administration_users_modify",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationKeyParam"
},
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserForOrganizationAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "The user was edited and got new permissions"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}/users": {
"get": {
"summary": "Get all users with roles of a orgnaization site",
"description": "Get all assigned users from organization site with\nall roles for the organization site.\n",
"operationId": "getAdministrationOrganizationSiteUsers",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_users_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"responses": {
"200": {
"description": "Assigned users to organization site",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdministrationUsersInformation"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"post": {
"deprecated": true,
"summary": "Create new user for organization site",
"description": "Deprecated: Please use POST /administration/organization-sites/users\nCreate a new user and add this user to the organization for the specified organization site\nand equip the new user with the rights according to the specified roles.\nThe requesting user must have access to the organization site to which the new user is to be added.\nThe new user can have only the roles carrier, consignee, consignor, site_admin.\n",
"operationId": "postAdministrationOrganizationSiteUser",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_users_create",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserForOrganizationSiteAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "The user was create and added to the organization"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/users": {
"post": {
"summary": "Create new user for organization sites",
"description": "Create a new user and add this user to the organization for the specified organization sites\nand equip the new user with the rights according to the specified roles.\nThe requesting user must have access to the organization sites to which the new user is to be added.\nThe new user can have only the roles carrier, consignee, consignor, site_admin.\n",
"operationId": "postAdministrationOrganizationSitesUser",
"tags": [
"administration"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserForOrganizationSitesAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "The user was create and added to the organization"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/users/{userKey}": {
"put": {
"summary": "Edit user with new site roles/permissions",
"description": "Edit a existing user and add this user to the given organization sites\nand equip the new user with permissions according to the given roles.\nThe requesting user must have access to the organization sites the user is added.\nAll previously set permissions and linked sites are removed.\nAll sites and roles to be set must be passed.\nThe optional submitted password is ignored.\nThe user can have only the roles carrier, consignee, consignor, site_admin.\n",
"operationId": "putAdministrationOrganizationSitesUser",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UserForOrganizationSitesAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "The user was edited and got new permissions"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}/users/{userKey}": {
"patch": {
"deprecated": true,
"summary": "Modify user for organization site",
"description": "Deprecated: Please use PUT /administration/organization-sites/users/{userKey}\nModify a user and for the given organization site and equip the\nuser with permissions according to the given roles.\nThe requesting user must have access to the organization site where the user is in.\nThe edited user can only have the roles site_admin, carrier, consignor, consignee.\nYou can't edit users with roles organization_admin\n",
"operationId": "patchAdministrationOrganizationSiteUser",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_users_modify",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchUserForOrganizationSiteAdminRequest"
}
}
}
},
"responses": {
"204": {
"description": "The user was create and added to the organization"
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
},
"get": {
"summary": "Get information details for one organization site user",
"description": "Return one user of an organization site. The organization site must\nbelong to the calling user.\nPermissions are returned.\n",
"operationId": "getAdministrationOrganizationSiteUser",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_users_read",
"tags": [
"administration"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
},
{
"$ref": "#/components/parameters/userKeyParam"
}
],
"responses": {
"200": {
"description": "Returns the user details of the requested user for the specified organization",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AdministrationUserDetails"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}
}
},
"/administration/organization-sites/{organizationSiteKey}/self-checkin": {
"put": {
"summary": "Customize the display of the self service configuration during the checkin process for an organization site.",
"description": "This endpoint provides the option to specify which self-service\ncheckin information should be presented during the check-in process\nfor an organization site.\n\nSet the notificationEmailAddress to the email address where notifications should be sent.\n\nSet the scanner flag to true or false to enable or disable the scanner.\n\nSpecify the selfCheckinData elements to be displayed during the\ncheckin process and omit the ones you don't want to display,\ne.g.: 'selfCheckinData': [ \"NAME\", \"PAGER_NUMBER\", \"REFERENCE_NUMBER\"].\nHere, the name, pager number, and reference number will be displayed,\nwhereas the license plate number, phone number, waiting number, booking number\nand time slot booking number will not be displayed. You can choose from the\nfollowing elements:\n\"NAME\", \"LICENSE_PLATE_NUMBER\", \"PHONE_NUMBER\", \"PAGER_NUMBER\",\n\"REFERENCE_NUMBER\", \"WAITING_NUMBER\", \"BOOKING_NUMBER\",\n\"TIME_SLOT_BOOKING_NUMBER\".\nHowever, the maximum number of elements selected at the same time must not exceed 5.\n\nDuplicates in the selfCheckinData array are not allowed and will result in an error.\n",
"operationId": "putSelfServiceConfigCheckin",
"x-dls-requiredOrganizationSitePermission": "administration_organization_sites_self_checkin_config_modify",
"tags": [
"administration - self service checkin"
],
"parameters": [
{
"$ref": "#/components/parameters/organizationSiteKeyParam"
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfServiceConfigCheckinRequest"
}
}
}
},
"responses": {
"200": {
"description": "Self service configuration",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SelfServiceConfigCheckinResponse"
}
}
}
},
"default": {
"$ref": "#/components/responses/DefaultErrorResponse"
}
}