-
Notifications
You must be signed in to change notification settings - Fork 2
/
AVAL-Spec.yml
861 lines (850 loc) · 32.5 KB
/
AVAL-Spec.yml
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
swagger: "2.0"
info:
description: |
AvaL specification file.
This specification contains descriptions for all AvaL related API operations.
Furthermore any API implementer has to provide all of the mandatory functions of this spec file. Optional
operations are indicated by HTTP response code 501. Optional attribute are not listed within the tag named
'required'.
The spec contains two types of AvaL matchings.
* AvaL Matching (see definition _AvalMatching_) without contract information
* AvaL __2__ Matching (see definition _Aval2Matching_) with contract information
Your API must support at least AvaL Matchings, supporting AvaL 2 Matching is optional. All orders are processed
via so-called AvaL Transactions (see definiton _AvalTransaction_), regardless of their matching type.
API levels:
* basic: The API supports handling of the AvaL Matching type
* comfort: The API supports handling of __both__ AvaL Matching types
* extended: _to be defined_
Further information:
* [AvaL Documents](https://www.avalstandard.de/download/dokumente) (written in German language)
* [AvaL Organization on Github](https://github.com/Entwicklung-AvaL-Standard)
Contact:
* [Contact form](https://www.avalstandard.de/kontaktformular)
* [Contact persons](https://www.avalstandard.de/kontakt/ansprechpartner)
version: "1.3.0"
title: "AvaL API specification"
termsOfService: "https://www.avalstandard.de/impressum"
contact:
email: "[email protected]"
license:
name: "Apache 2.0"
url: "http://www.apache.org/licenses/LICENSE-2.0.html"
tags:
- name: "AvaL API"
description: "AvaL API"
externalDocs:
description: "Find out more about AvaL"
url: "https://www.avalstandard.de/"
schemes:
- "https"
securityDefinitions:
OAuth2:
type: oauth2
description: |
The OpenID Connect/OIDC procedure (based on OAuth2) is mandatory to provide authentication to an AvaL API. The use of the central AvaL OAuth2 Server (ZSAvaL) is not mandatory.
You can also use established OIDC-SaaS solutions (e.g. Azure AD, AWS Cognito, etc.) or on-premise solutions like Keycloak.
A detailed description of the use of OIDC and OAuth2 within AvaL is described here: [AvaL Standard 4.3 Webservice und Serverdienste Partnerverzeichnis und Authentifizierung](https://www.avalstandard.de/files/content/downloads/teil4-webservices-objekte-funktionen/AvaL%20Standard%20Teil%204.3%20Webservice%20und%20Serverdienste%20Partnerverzeichnis%20und%20Authentifizierung%202022-03-09.pdf) (currently only available in German)
The token type used is JWT tokens (see jwt.io and RFC7519).
- The validity of the tokens is 5 minutes
- No refresh tokens are offered/used
- The grant type “urn:ietf:params:oauth:grant-type:uma-ticket” including the “audience” claim is to be used. The “audience” claim is one known to the central server recipient identification entered.
- Additional parameters such as “scope” are not supported.
- Authorization URL: "https://auth.avalstandard.de/auth/realms/avalstandard/protocol/openid-connect/auth"
- Token URL: "https://auth.avalstandard.de/auth/realms/avalstandard/protocol/openid-connect/token"
For further and detailed information on how to connect your API client to the OIDC / OAuth2 server and communicate with it, please also take a look at the following project: [oauth2-samples](https://github.com/entwicklung-AvaL-Standard/oauth2-samples)
repository. And also take a look into (RFC6749)[https://datatracker.ietf.org/doc/html/rfc6749], especially section 4.4 and 4.5.
***Alternative configuration:***
If you are use your own OIDC / OAuth2 server (on-premise or SaaS), then you have to specify the ***Authorization URL*** and ***Token URL*** accordingly.
In this case, you can agree with your partner on the alternative grant type ***client_credentials***. All other parameters and specifications, in particular the “audience” specification, must match the JWT token definition above.
flow: application
tokenUrl: "https://auth.avalstandard.de/auth/realms/avalstandard/protocol/openid-connect/token"
paths:
/avalmatchings:
post:
tags:
- "AvaL Matchings"
summary: "Create a new AvaL Matching"
description: ""
operationId: "createAvalMatching"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "AvaL matching which should be created"
required: true
schema:
$ref: "#/definitions/AvalMatching"
responses:
200:
description: "Successful operation."
400:
description: "The provided AvaL Matching does not fulfill the specifications. Required parameters missing or provided AvaL state is invalid. Details may be included within the response body."
409:
description: "Provided AvaL Matching ID is already in use."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/avalmatchings/{avalId}:
patch:
tags:
- "AvaL Matchings"
summary: "Update an existing AvaL Matching"
description: ""
operationId: "updateAvalMatching"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL Matching that needs to be updated"
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "AvaL Matching which should be updated."
required: true
schema:
$ref: "#/definitions/AvalMatching"
responses:
200:
description: "Successful operation."
400:
description: "Provided AvaL Matching ID of the request body does not correspond to the matching ID within the URI path."
404:
description: "AvaL Matching not found."
405:
description: "Validation exception because of incorrect state transition."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/avalmatchings/{avalId}/extendedInformation:
post:
tags:
- "AvaL Matchings"
summary: "Update an existing AvaL Matching with new Extended Information."
description: ""
operationId: "postAvalMatchingExtendedInformation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL Matching to which the Extended Information should be assigned."
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "Extended Information in the form of an AdditionalContent object."
required: true
schema:
type: object
additionalProperties:
$ref: "#/definitions/AdditionalContent"
responses:
200:
description: "Successful operation."
400:
description: "Provided Extended Information does not fulfill the specifications. Required parameters missing or invalid. Details may be included within the response body."
404:
description: "AvaL Matching not found."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/aval2matchings:
post:
tags:
- "AvaL 2 Matchings"
summary: "Create a new AvaL 2 Matching"
description: |
For creating a new aval-matching beside for the required parameters according to Aval2Matching it is required to provide the following fields:
* taskSite
* groupId
* period
* service
* cycleInterval
* serviceUom
* requiredDeviationDocuments
* requiredDocuments
* needServiceResponse
* needPurchaseOrder
operationId: "createAval2Matching"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- in: "body"
name: "body"
description: "AvaL 2 Matching which should be created"
required: true
schema:
$ref: "#/definitions/Aval2Matching"
responses:
200:
description: "Successful operation."
400:
description: "The provided AvaL Matching does not fulfill the specifications. Required parameters missing or provided AvaL state is invalid. Details may be included within the response body."
409:
description: "Provided AvaL Matching ID is already in use."
500:
description: "An unexpected error occurred. Details may be included within the response body."
501:
description: "The processing of 'AvaL2Matching' entities is optional and not yet implemented for this API."
/aval2matchings/{avalId}:
patch:
tags:
- "AvaL 2 Matchings"
summary: "Update an existing AvaL 2 Matching"
description: ""
operationId: "updateAval2Matching"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL 2 Matching that needs to be updated"
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "AvaL 2 Matching which should be updated. It is only allowed to update the state and the end of the period of an existing Aval2Matching - in all other cases a new Aval2Matching needs to be performed"
required: true
schema:
$ref: "#/definitions/Aval2Matching"
responses:
200:
description: "Successful operation."
400:
description: "Provided AvaL 2 Matching ID of the request body does not correspond to the matching ID within the URI path."
404:
description: "AvaL 2 Matching not found."
405:
description: "Validation exception because of incorrect state transition."
500:
description: "An unexpected error occurred. Details may be included within the response body."
501:
description: "The processing of 'AvaL2Matching' entities is optional and not yet implemented for this API."
/aval2matchings/{avalId}/extendedInformation:
post:
tags:
- "AvaL 2 Matchings"
summary: "Update an existing AvaL 2 Matching with new Extended Information."
description: ""
operationId: "postAval2MatchingExtendedInformation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL 2 Matching to which the Extended Information should be assigned."
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "Extended Information in the form of an AdditionalContent object."
required: true
schema:
type: object
additionalProperties:
$ref: "#/definitions/AdditionalContent"
responses:
200:
description: "Successful operation."
400:
description: "Provided Extended Information does not fulfill the specifications. Required parameters missing or invalid. Details may be included within the response body."
404:
description: "AvaL 2 Matching not found."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/avalmatchings/{avalId}/avaltransactions:
post:
tags:
- "AvaL Transactions"
summary: "Transactions of an AvaL Matching (regardless of matching type)"
description: ""
operationId: "createAvalTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of the AvaL Matching for the AvaL Transactions."
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "AvaL Transaction which should be created."
required: true
schema:
$ref: "#/definitions/AvalTransaction"
responses:
200:
description: "Successful operation."
400:
description: "The provided AvaL Transaction does not fulfill the specifications. This may happen because the related AvaL Matching is not in a corresponding state. Details may be included within the response body."
409:
description: "Provided AvaL Transaction ID is already in use."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/avalmatchings/{avalId}/avaltransactions/{transactionId}:
patch:
tags:
- "AvaL Transactions"
summary: "Update an existing AvaL Transaction"
description: ""
operationId: "updateAvalTransaction"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL Matching which owns the AvaL Transaction"
required: true
type: "string"
format: "uuid"
- name: "transactionId"
in: "path"
description: "ID of AvaL Transaction which should be updated"
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "AvaL Transaction which should be updated."
required: true
schema:
$ref: "#/definitions/AvalTransaction"
responses:
200:
description: "Successful operation."
400:
description: "Invalid state (wrong number), missing attributes or something else."
404:
description: "AvaL Transaction not found."
405:
description: "Validation exception because of incorrect state transition."
422:
description: "The provided transaction is valid in content, but was rejected by the receiving API. One of the reasons for this may be that the underlying ERP system has refused to execute or continue the transaction. Details may be included within the response body."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/avalmatchings/{avalId}/avaltransactions/{transactionId}/avaldocuments:
post:
tags:
- "AvaL Documents"
summary: "Add a document to an existing AvaL Transaction"
description: "See https://tools.ietf.org/html/rfc7578 for further information about the multipart content type."
operationId: "postAvalDocument"
consumes:
- "multipart/form-data"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL Matching which owns the AvaL Transaction"
required: true
type: "string"
format: "uuid"
- name: "transactionId"
in: "path"
description: "ID of AvaL Transaction which should be updated"
required: true
type: "string"
format: "uuid"
- in: "formData"
name: "documentId"
type: "string"
format: "uuid"
required: true
- in: "formData"
name: "filename"
type: "string"
required: true
description: "The full filename including any file ending / extension"
- in: "formData"
name: "documentType"
type: "string"
required: true
description: "Only IDs from AvaL document type reference list are allowed here (e.g. 'AD.1.101' for 'Leistungsschein'). See https://www.avalstandard.de/aval-stammdaten-webapi/catalog for more information."
- in: "formData"
name: "file"
type: "file"
required: true
responses:
200:
description: "Document successfully uploaded."
400:
description: "The provided AvaL Document does not fulfill the specifications. Details may be included within the response body."
409:
description: "Provided AvaL Document ID is already in use."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/avalmatchings/{avalId}/avaltransactions/{transactionId}/extendedInformation:
post:
tags:
- "AvaL Transactions"
summary: "Update an existing AvaL Transaction with new Extended Information."
description: ""
operationId: "postAvalTransactionExtendedInformation"
consumes:
- "application/json"
produces:
- "application/json"
parameters:
- name: "avalId"
in: "path"
description: "ID of AvaL Transaction to which the Extended Information should be assigned."
required: true
type: "string"
format: "uuid"
- name: "transactionId"
in: "path"
description: "ID of AvaL Transaction which should be updated"
required: true
type: "string"
format: "uuid"
- in: "body"
name: "body"
description: "Extended Information in the form of an AdditionalContent object."
required: true
schema:
type: object
additionalProperties:
$ref: "#/definitions/AdditionalContent"
responses:
200:
description: "Successful operation."
400:
description: "Provided Extended Information does not fulfill the specifications. Required parameters missing or invalid. Details may be included within the response body."
404:
description: "AvaL Transaction not found."
500:
description: "An unexpected error occurred. Details may be included within the response body."
/info:
get:
tags:
- "AvaL API information"
summary: "Provides information about this specific API implementation"
operationId: "getInfo"
consumes:
- application/json
produces:
- application/json
responses:
200:
description: "Successfully retrieved information."
schema:
$ref: '#/definitions/ApiInformation'
500:
description: "An unexpected error occurred. Details may be included within the response body."
definitions:
AvalMatching:
type: "object"
required:
- id
- state
properties:
id:
type: "string"
format: "uuid"
state:
type: "integer"
format: "int32"
example: 1
client:
$ref: "#/definitions/Client"
supplier:
$ref: "#/definitions/Supplier"
extendedInformation:
type: object
additionalProperties:
$ref: '#/definitions/AdditionalContent'
Client:
type: object
properties:
contractPartner:
type: "string"
material:
type: "string"
example: "Papier"
containerType:
type: "string"
example: "MGB 1100 cbm"
serviceType:
type: "string"
example: "Austausch"
performancePlace:
type: "string"
example: "Musterstraße 43, 22041 Hamburg"
materialUnit:
type: "string"
example: "to"
serviceUnit:
type: "string"
example: "S"
cycleInformation:
type: "boolean"
description: |
Indicates if this specific matching is bound to a cycle. If it is (=true), please use the attribute _cycleRythm_
for details on how often the job should be done.
example: true
cycleRhythm:
type: "string"
description: |
Describes the cycle for this AvaL Matching. Use free-text or free-text in combination with a AvaL reference list ID
from here https://www.avalstandard.de/aval-stammdaten-webapi/catalog/AZ.1/entries. Please use the following
pattern if referencing to the AvaL list: _freetext#avalid_. Be aware that the handling of the ID is always optional.
There is no garantuee that it will be handled by the API.
example: "'Jede 2. Woche' or 'Jede 2. Woche#AZ.20.2.2.1'"
Supplier:
type: "object"
properties:
contractPartner:
type: "string"
example: "Mustermann GmbH"
material:
type: "string"
example: "Papier"
containerType:
type: "string"
example: "MGB 1100 cbm"
serviceType:
type: "string"
example: "Austausch"
performancePlace:
type: "string"
example: "Musterstr. 43, D-22041 Hamburg"
materialUnit:
type: "string"
example: "to"
serviceUnit:
type: "string"
example: "S"
cycleInformation:
type: "boolean"
description: |
Indicates if this specific matching is bound to a cycle. If it is (=true), please use the attribute _cycleRythm_
for details on how often the job should be done.
example: true
cycleRhythm:
type: "string"
description: |
Describes the cycle for this AvaL Matching. Use free-text or free-text in combination with a AvaL reference list ID
from here https://www.avalstandard.de/aval-stammdaten-webapi/catalog/AZ.1/entries. Please use the following
pattern if referencing to the AvaL list: _freetext#avalid_. Be aware that the handling of the ID is always optional.
There is no garantuee that it will be handled by the API.
example: "'Jede 2. Woche' or 'Jede 2. Woche#AZ.20.2.2.1'"
Aval2Matching:
type: "object"
required:
- id
- state
properties:
id:
type: "string"
format: "uuid"
state:
type: "string"
enum: [ NEW, ACCEPTED, REJECTED, ENDED ]
example: "NEW"
taskSite:
# Leistungsort/Anfallstelle
$ref: "#/definitions/Site"
custSite:
# Customer(group) for the taskSite
$ref: "#/definitions/Site"
billSite:
# Invoice to
$ref: "#/definitions/Site"
disposalSite:
# Location to deliver material to
$ref: "#/definitions/Site"
baseContract:
type: "string"
example: "HORNBACH"
description: "As agreed upon in a base contract, may define conditions/prices/..."
groupId:
type: "string"
format: "uuid"
description: "allows for grouping of aval-ids,e.g. provisioning, rent, disposal or decomission"
period:
$ref: "#/definitions/Period"
service:
type: "string"
example: "AL.1.13.19.0"
description: "AvaL-ID of the service"
serviceUom:
type: "string"
example: "AE.1.400"
description: "AvaL-ID of the UOM (example: pieces)"
material:
type: "string"
example: "AS.1.91.150106.0.0"
description: "AvaL-ID of the material"
ewc:
type: string
example: "150106"
description: |
"EWC" stands for the European Waste Catalogue, which categorizes waste using a 6-digit key number. In Germany,
this European standard is implemented through the “Abfallverzeichnis-Verordnung” (AVV for short).
localEwc:
type: string
example: "DE-170203"
description: |
Use this attribute to specify a country-specific EWC description or number. To identify the country to which
the localEwc belongs, it must be prefixed with the ISO-3166-1 alpha-2 country code (DE, FR, ..)
followed by a hyphen.
materialUom:
type: "string"
example: "AE.1.103"
description: "AvaL-ID of the UOM (example: tons)"
container:
type: "string"
example: "AB.1.11.2500.0"
description: "AvaL-ID of the container"
containerAmount:
type: "integer"
format: "int32"
example: 2
cycleInterval:
type: "string"
description: "Only AvaL IDs from https://www.avalstandard.de/aval-stammdaten-webapi/catalog/AZ.1/entries are allowed here."
example: "AZ.1.02.0.0.0"
cyclePeriod:
$ref: "#/definitions/Period"
requiredDocuments:
type: "array"
description: "document types as defined in AvalDocuments/documentType; those documents must be made available before the transaction state goes to 9"
example: [ "AD.1.1.101", "AD.1.9.901"]
items:
type: "string"
requiredDeviationDocuments:
type: "array"
description: "document types as defined in AvalDocuments/documentType; those documents must be made available before the transaction state goes to 10"
example: [ "AD.1.1.101", "AD.1.9.901"]
items:
type: "string"
gracePeriod:
type: "integer"
example: "5"
description: "time for execution in working days after sending AvalTransaction or number of (working) days before rent payment starts. Can be omitted if there is a baseContract"
needServiceResponse:
type: "boolean"
example: "true"
description: "is sending back a Service Response (Rückmeldung, status=9/10) required?"
needPurchaseOrder:
type: "boolean"
example: "true"
description: "is there a 'Beauftragung' by the AG?"
priceReference:
type: "string"
example: "SERVICE"
enum: [ SERVICE, MATERIAL, CONTAINER, FLAT ]
price:
type: "number"
description: "price in priceCurrency per priceReference"
priceCurrency:
type: "string"
example: "EUR"
description: "currency code according to ISO 4217 (3 letter)"
logisticComment:
type: "string"
example: "Wenn Tor verschlossen: 777 anrufen"
description: "comment for logistic special-handling"
extendedInformation:
type: object
additionalProperties:
$ref: '#/definitions/AdditionalContent'
Site:
type: "object"
required:
- name
- street
- postalCode
- city
- country
- referenceSource
- siteReference
properties:
name:
type: "string"
example: "Mustermann GmbH"
street:
type: "string"
example: "Stollwerckstr. 9"
postalCode:
type: "string"
example: "50996"
city:
type: "string"
example: "Köln"
country:
type: "string"
example: "DE"
description: "2 Character ISO Code"
siteDescription:
type: "string"
example: "Tor 2"
geoLongitude:
type: "number"
format: "float"
minimum: -180
maximum: 180
description: "Geo-Cordinate for longitude in WGS84 reference system in decimal degree (DDD.DDDDD°)"
geoLatitude:
type: "number"
format: "float"
minimum: -90
maximum: 90
description: "Geo-Cordinate for latitude in WGS84 reference system in decimal degree (DDD.DDDDD°)"
governmentNumber:
type: "string"
description: "In Germany: EANV"
referenceSource:
type: "string"
enum: [ GLN, AVAL, SENDER ]
example: "SENDER"
siteReference:
type: "string"
example: "244377"
description: "reference number according to the referenceSource; if SENDER=internal to the sending system, for the receiver to lookup in a sender-specific lookup table. For AVAL/EANV/GLN to be further detailed"
AvalTransaction:
type: "object"
required:
- id
- state
properties:
id:
type: "string"
format: "uuid"
state:
type: "integer"
format: "int32"
maximum: 10
minimum: -1
example: 1
description: "Use the defined states (1 to 10) as specified in the technical documentation. Please be aware of that there is no state with value “0”. It is allowed to use “-1” as an indicator state to abort the synchronization process at any time."
avalId:
type: "string"
format: "uuid"
operationPeriod:
$ref: '#/definitions/Period'
fulfillmentTimestamp:
type: "string"
format: "date-time"
plannedFulfillmentPeriod:
$ref: '#/definitions/Period'
serviceAmount:
type: "integer"
format: "int32"
example: 1
containerAmount:
type: "integer"
format: "int32"
example: 2
materialAmount:
type: "number"
format: "double"
example: 0.256
isUnderMeasureThreshold:
type: "boolean"
example: false
serviceNoteNumber:
type: "string"
example: "DL-4711"
measureNoteNumber:
type: "string"
example: "WS-0815"
governmentalAssetNumber:
description: "The governmental asset number, in german 'Behördliche Anlagennummer', is a crucial part of the german 'Entsorgungsnachweis' process. Use this attribute while exchanging or documenting critical or dangerous waste using AvaL."
type: "string"
governmentalCarrierNumber:
description: "The governmental carrier number, in german 'Behördliche Beförderernummer', is a crucial part of the german 'Entsorgungsnachweis' process. Use this attribute while exchanging or documenting critical or dangerous waste using AvaL."
type: "string"
orderNumberSupplier:
type: "string"
example: "LFS_123456"
orderNumberClient:
type: "string"
example: "ERP_987654"
logisticComments:
type: "string"
example: "Bitte hinter dem Gebäude herum fahren!"
cancellationReason:
type: "string"
example: "Tor verschlossen"
complaintReason:
type: "string"
description: "Only AvaL IDs from https://www.avalstandard.de/aval-stammdaten-webapi/catalog/AV.1/entries are allowed here."
example: "AV.1.104"
variationNotes:
type: "string"
alternateAvalId:
description: "This attribute is currently not used. It may be removed in one of the next versions."
type: "string"
format: "uuid"
alternateMatchedAvalId:
description: "Use this attribute if you want to signal to the client in the response (AvaL state 10 only) that there is a better matching for this transaction. For example, the emptying of a container with mixed scrap was agreed upon during matching. However, steel scrap was actually disposed of and a valid matching already exists for this. This is exactly what you pass as “alternateMatchedAvalId”."
type: "string"
format: "uuid"
extendedInformation:
type: object
additionalProperties:
$ref: '#/definitions/AdditionalContent'
Period:
type: "object"
properties:
start:
type: "string"
format: "date-time"
example: "2019-07-01T14:00:00Z"
end:
type: "string"
format: "date-time"
example: "2019-07-01T18:00:00Z"
AdditionalContent:
type: "object"
properties:
type:
type: "string"
example: "Behälternummer"
content:
type: "string"
example: "A 123 987 456"
ApiInformation:
type: "object"
required:
- level
properties:
level:
type: "string"
enum: [ basic, comfort, extended ]
description: |
The level defines the supported AvaL function level (German: AvaL Standard Stufe) as defined
at [www.avalstandard.de](https://www.avalstandard.de/services/auftrags-leistungsdaten).
- _basic_: Report the provisioning of services for existing orders. Use the 'AvalMatching' while supporting the level 'basic'.
- _comfort_: Functionality as in 'basic' with additional use of master data catalogs for the identification of containers, wastes, etc. Use the 'Aval2Matching' type if your API supports the level 'comfort'.
- _extended_: Functionality as in 'comfort' with additional use of partner management including authentication.
example: "basic"
vendorVersion:
type: "string"
description: "This attribute contains the version of your API. This may be useful for monitoring or debugging purpose."
example: "21.2.4"
externalDocs:
description: "Find out more about Swagger"
url: "http://swagger.io"