{ "openapi": "3.0.3", "info": { "title": "ZEDAL API", "description": "Public REST facade for the gRPC backends of the ZEDAL platform.\n\n## Authentication\n\nZEDAL uses a three-stage token flow:\n\n1. **Login** via \u0060AuthApi.IssueRefreshToken\u0060 \u2014 the client sends credentials (\u0060UsernameCredentials\u0060 for users or \u0060ClientIdCredentials\u0060 for automated processes) plus an \u0060app_token\u0060 issued by the provider and receives a long-lived **RefreshToken** (JWT).\n2. **Request AccessToken** via \u0060AuthApi.RequestAccess\u0060 with the RefreshToken in the \u0060Authorization: Bearer \u003C\u2026\u003E\u0060 header (security scheme \u0060RefreshToken\u0060). Response: a short-lived **AccessToken** plus a **new RefreshToken**. The previous RefreshToken is thereby invalidated (**token rotation**) \u2014 clients must use the new one for the next \u0060RequestAccess\u0060 call.\n3. **API calls** with the AccessToken in the \u0060Authorization: Bearer \u003C\u2026\u003E\u0060 header (security scheme \u0060AccessToken\u0060, default for all operations).\n\nSome operations additionally require **scopes** (e.g. \u0060usermgt\u0060 for the AuthApi management operations). Scopes are determined at login time via the \u0060app_token\u0060 and the subscriber assignment, and are carried in the AccessToken claim.\n\nFor detailed service documentation and tutorials see [docs.live.zedal.de](https://docs.live.zedal.de).", "contact": { "name": "Zedal Support", "url": "https://www.zedal.de", "email": "support@zedal.de" }, "version": "1.0.0", "x-logo": { "url": "https://www.zedal.de/typo3conf/ext/zedal_sitepackage/Resources/Public/Images/zedal.svg", "altText": "ZEDAL", "href": "https://www.zedal.de" } }, "servers": [ { "url": "https://openapi.live.zedal.de/", "description": "production systems" }, { "url": "https://openapi.preview.zedal.de/", "description": "staging and beta systems" }, { "url": "https://openapi.test.zedal.de/", "description": "test and integration systems" }, { "url": "https://openapi.dev.zedal.de/", "description": "development systems" } ], "paths": { "/infotech.namespaced_notifier.v1.api.RegisteredGroupAuthApi/Login": { "post": { "tags": [ "RegisteredGroupAuthApi" ], "operationId": "RegisteredGroupAuthApi_Login", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/LoginResponse" } } } } } } }, "/infotech.namespaced_notifier.v1.api.RegisteredGroupAuthApi/RegisterGroup": { "post": { "tags": [ "RegisteredGroupAuthApi" ], "operationId": "RegisteredGroupAuthApi_RegisterGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RegisterGroupResponse" } } } } } } }, "/infotech.namespaced_notifier.v1.api.RegisteredGroupAuthApi/UnregisterGroup": { "post": { "tags": [ "RegisteredGroupAuthApi" ], "operationId": "RegisteredGroupAuthApi_UnregisterGroup", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnregisterGroupRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/UnregisterGroupResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/GetDocument": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "GetDocument", "description": "Retrieves the current state of a waste shipment document in the full DIWASS retrieval format. Returns the complete document representation including all submitted data blocks (notification, decision, acknowledgements, movement records) together with the list of follow-up intents that are currently valid for this document. The follow-up intents reflect the regulatory lifecycle position of the document under Regulation (EU) 2024/1157 and determine which authority actions (RPCs) may be executed next.", "operationId": "AuthorityDocumentApi_GetDocument", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/ReplyToRequestForChangeAfterConsent": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "ReplyToRequestForChangeAfterConsent", "description": "Records the competent authority\u0027s response to a notifier\u0027s request to modify a consented notification. Under Regulation (EU) 2024/1157, once consent has been granted, the notifier may request changes such as an adjusted transport route, a different carrier, or a corrected waste quantity within the permitted range. The competent authority may accept the change, accept it with conditions, or reject it. If rejected, the original consent terms continue to apply and the notifier must either comply with the existing conditions or submit a new notification.", "operationId": "AuthorityDocumentApi_ReplyToRequestForChangeAfterConsent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyToRequestForChangeAfterConsentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ReplyToRequestForChangeAfterConsentResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SetByIntent": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SetByIntent", "description": "Generic mutation operation intended for UI clients. Rather than calling a dedicated typed RPC, the caller submits the full retrieval document together with an explicit intent value. The server identifies the correct sub-document type, extracts the relevant section, and executes the corresponding regulatory action (e.g. SetDecision, SubmitAcknowledgement) on behalf of the authority user. This endpoint is functionally equivalent to the individual typed RPCs but is optimised for form-based UIs that operate on the full document state rather than isolated mutation types. Movement documents are explicitly excluded and must always use the dedicated movement RPCs.", "operationId": "AuthorityDocumentApi_SetByIntent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetByIntentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetByIntentResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SetDecision": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SetDecision", "description": "Records the competent authority\u0027s formal decision on a prior written notification. Under Regulation (EU) 2024/1157, competent authorities of destination, dispatch, and transit must issue a reasoned decision \u2014 consent, consent with conditions, or objection \u2014 within the prescribed time limits after acknowledgement of receipt. A consent decision activates the notification and permits the notifier to begin individual shipments within the validity period. A conditional consent attaches requirements to the transport route, financial guarantee, or treatment operation. An objection prevents the shipment from proceeding as notified and must state the regulatory grounds.", "operationId": "AuthorityDocumentApi_SetDecision", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDecisionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDecisionResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SetMovementTakeBack": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SetMovementTakeBack", "description": "Records a competent authority take-back order for a transboundary waste shipment. Under Regulation (EU) 2024/1157, competent authorities must order take-back when a shipment cannot be completed as notified (e.g. the consignee or facility refuses the waste, or the shipment is found to be illegal). The notifier is obliged to arrange return of the waste to the country of dispatch within 90 days, or such other period as agreed with the competent authorities, at the notifier\u0027s expense. The take-back order is recorded against the individual movement and triggers corresponding obligations on all parties.", "operationId": "AuthorityDocumentApi_SetMovementTakeBack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMovementTakeBackApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMovementTakeBackResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SetRequestInformation": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SetRequestInformation", "description": "Issues a formal request from the competent authority to the notifier for additional information or documentation. Under Regulation (EU) 2024/1157, competent authorities may suspend the decision time limit by requesting supplementary information when the notification dossier is incomplete or unclear. The time limit resumes only when the notifier has provided the requested information in full. Repeated requests are possible if the submitted response is still insufficient. All requests and responses are tracked in the DIWASS system as part of the notification lifecycle.", "operationId": "AuthorityDocumentApi_SetRequestInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRequestInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRequestInformationResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SubmitAcknowledgement": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SubmitAcknowledgement", "description": "Issues the competent authority\u0027s formal acknowledgement of receipt for a notification or a movement document. Under Regulation (EU) 2024/1157, the competent authority of destination must acknowledge receipt of a complete notification dossier within the prescribed period, thereby starting the decision time limits. Acknowledgement does not constitute consent; the notifier may not commence shipments until a consent decision has been issued. For movement documents, acknowledgement confirms that the authority has received and registered the movement data in the DIWASS system.", "operationId": "AuthorityDocumentApi_SubmitAcknowledgement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAcknowledgementRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitAcknowledgementResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SubmitMovementSignal": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SubmitMovementSignal", "description": "Submits a competent authority signal at the level of an individual shipment movement. While the notification defines the overall consent, each physical transport event is tracked as a separate movement record. Movement-level signals allow authorities to confirm, reject, or annotate specific movement documents independently of the parent notification state. Typical signals include: confirmation that a movement complies with the consent conditions, rejection where the movement document is incomplete or the shipment deviates from the notified details, and corrections where the authority requires amended movement data.", "operationId": "AuthorityDocumentApi_SubmitMovementSignal", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitMovementSignalApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitMovementSignalResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.AuthorityDocumentApi/SubmitNotificationSignal": { "post": { "tags": [ "AuthorityDocumentApi" ], "summary": "SubmitNotificationSignal", "description": "Submits a competent authority signal at the notification level as defined in Art. 27(1) of Regulation (EU) 2024/1157. Signals represent binding authority actions that change the lifecycle state of a notification, including: cancellation of a consent (e.g. where consent conditions are persistently violated), closure of a notification (confirming that all permitted shipments have been completed and recovery/disposal certificates received), and revalidation (extending the validity period of a consent where permitted). Each signal type carries specific downstream effects on the DIWASS notification record and notifier obligations.", "operationId": "AuthorityDocumentApi_SubmitNotificationSignal", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitNotificationSignalRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SubmitNotificationSignalResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/CreateAnnex7": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "CreateAnnex7", "description": "Creates a new Annex VII document for a green-listed (non-hazardous) waste shipment subject to the general information procedure under Art. 18 of Regulation (EU) 2024/1157. Green-listed waste destined for recovery within the EU does not require prior written notification and consent, but must be accompanied by the Annex VII information document throughout the shipment. The document must identify the waste, its origin and destination, the intended recovery operation (R-code), and the carrier. No doc_xml is required; the server generates the document from the provided typed announcement data.", "operationId": "CompanyDocumentApi_CreateAnnex7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnex7Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateAnnex7Response" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/CreateMovementTemplate": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "CreateMovementTemplate", "description": "Creates the movement document template for an individual shipment under a consented prior written notification. Under Regulation (EU) 2024/1157, each physical transport event within a consented notification requires a separate movement document specifying the actual waste quantity, carrier, transport date, and route for that specific shipment. The movement template must correspond to the consented notification details; deviations beyond the permitted tolerances require a change request or a new notification. No doc_xml is required; the server generates the movement document from the provided typed template data.", "operationId": "CompanyDocumentApi_CreateMovementTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMovementTemplateApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateMovementTemplateResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/CreateSubmission": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "CreateSubmission", "description": "Initiates a new prior written notification (notified / amber-listed waste shipment) under Regulation (EU) 2024/1157. This is the first step in the notification procedure: the notifier prepares the notification dossier with waste identification, quantities, origin, transport route, consignee, recovery or disposal facility, financial guarantee details, and Annex II information. The call creates a new DIWASS document record and returns the generated document together with the initial set of valid follow-up intents. No doc_xml is required for this initial creation; the server generates the XML skeleton from the provided typed submission data.", "operationId": "CompanyDocumentApi_CreateSubmission", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubmissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CreateSubmissionResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/GetAnnex7": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "GetAnnex7", "description": "Retrieves the current state of a green-listed (Annex VII) waste shipment document under Art. 18 of Regulation (EU) 2024/1157 in the zewass AnnexViiDocument format. The response contains the announcement, carrier transfers, consignee and facility receipt certificates, certificate of completion, and any take-back records, together with the ZEDAL-side metadata and the currently valid follow-up intents.", "operationId": "CompanyDocumentApi_GetAnnex7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnnex7Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAnnex7Response" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/GetDocument": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "GetDocument (deprecated)", "description": "Deprecated. Use GetNotification, GetAnnex7, or GetMovement instead. Retrieves the current state of a waste shipment document wrapped in the generic Document container, together with the list of follow-up intents currently valid under Regulation (EU) 2024/1157.", "operationId": "CompanyDocumentApi_GetDocument", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/GetMovement": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "GetMovement", "description": "Retrieves the current state of an individual movement document for a notified waste shipment under Regulation (EU) 2024/1157 in the zewass MovementDocument format. The response contains the movement template, carrier transport data, consignee and facility reception certificates, completion certificate, take-back orders and signals, together with the ZEDAL-side metadata and the currently valid follow-up intents.", "operationId": "CompanyDocumentApi_GetMovement", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMovementRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetMovementResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/GetNotification": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "GetNotification", "description": "Retrieves the current state of a notified (amber-listed) waste shipment dossier under Regulation (EU) 2024/1157 in the zewass NotificationDocument format. The response contains the complete notification block (submission, request-information exchange, decision, change-request flow, signals, Art. 15 completion certificate) together with the ZEDAL-side metadata (addresses, Zusatzdaten, file attachments) and the currently valid follow-up intents. Use this endpoint when the caller already knows that the underlying document is a notification.", "operationId": "CompanyDocumentApi_GetNotification", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotificationResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetAnnex7": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetAnnex7", "description": "Updates or corrects an existing Annex VII document for a green-listed waste shipment under Art. 18 of Regulation (EU) 2024/1157. The server determines from the document state whether to apply a submission intent (initial filing) or a correction intent (amending already-filed Annex VII data). Corrections may be required where waste quantities, composition, or transport details change after the document was first created. The updated document must accurately reflect the actual waste shipment at the time of transport.", "operationId": "CompanyDocumentApi_SetAnnex7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7Response" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetAnnex7CarrierTransfer": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetAnnex7CarrierTransfer", "description": "Records a carrier transfer certificate within an Annex VII document for a green-listed waste shipment. When custody of the waste changes from one carrier to another during transport, the outgoing carrier must certify the handover and the incoming carrier assumes responsibility for the shipment. Under Regulation (EU) 2024/1157, all carrier handovers must be documented in the Annex VII record to maintain full traceability of the waste from the point of dispatch to the consignee.", "operationId": "CompanyDocumentApi_SetAnnex7CarrierTransfer", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7CarrierTransferRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7CarrierTransferResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetAnnex7CertificateOfCompletion": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetAnnex7CertificateOfCompletion", "description": "Submits the recovery facility\u0027s certificate of completion of recovery for a green-listed waste shipment under Annex VII of Regulation (EU) 2024/1157. Once the recovery operation (R-code) has been completed, the facility must certify completion, specifying the actual recovery method, the quantities treated, and the date of completion. This certificate must be issued within 30 days of completing recovery and no later than one calendar year after receipt of the waste. Submission of this certificate formally closes the Annex VII document lifecycle in DIWASS.", "operationId": "CompanyDocumentApi_SetAnnex7CertificateOfCompletion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7CertificateOfCompletionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7CertificateOfCompletionResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetAnnex7ConsigneeCertificate": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetAnnex7ConsigneeCertificate", "description": "Submits the consignee\u0027s certificate of waste receipt for a green-listed waste shipment under Annex VII of Regulation (EU) 2024/1157. The consignee must confirm receipt of the waste within three working days of acceptance, specifying the date and location of receipt, the actual waste quantities received, and any discrepancies from the Annex VII document. This certificate is a mandatory step in the Annex VII lifecycle and is required before the recovery facility can issue its own reception and completion certificates.", "operationId": "CompanyDocumentApi_SetAnnex7ConsigneeCertificate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7ConsigneeCertificateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7ConsigneeCertificateResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetAnnex7FacilityCertificate": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetAnnex7FacilityCertificate", "description": "Submits the recovery facility\u0027s certificate of waste receipt for a green-listed waste shipment under Annex VII of Regulation (EU) 2024/1157. Where the consignee and the recovery facility are not the same entity, the facility separately confirms that it has received the waste, stating the date, quantity, and intended recovery operation (R-code). This certificate must be issued within three working days of acceptance and is a prerequisite for subsequently issuing the certificate of completion of recovery.", "operationId": "CompanyDocumentApi_SetAnnex7FacilityCertificate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7FacilityCertificateRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7FacilityCertificateResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetAnnex7TakeBack": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetAnnex7TakeBack", "description": "Initiates a take-back of a green-listed waste shipment that was shipped under Annex VII of Regulation (EU) 2024/1157. Take-back is required where the consignee refuses the waste, the shipment cannot be completed as planned, or the shipment is found to constitute an illegal transboundary movement. The person who arranged the shipment must arrange return of the waste to the country of dispatch and update the Annex VII record to reflect the take-back, ensuring traceability is maintained throughout the return journey.", "operationId": "CompanyDocumentApi_SetAnnex7TakeBack", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7TakeBackRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetAnnex7TakeBackResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetByIntent": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetByIntent", "description": "Generic mutation operation intended for UI clients interacting with notified or Annex VII waste shipment documents. Rather than calling a dedicated typed RPC, the caller submits the full DIWASS retrieval document together with an explicit intent value. The server identifies the correct sub-document type, extracts the relevant section, and executes the corresponding regulatory step (e.g. CreateSubmission, SetAnnex7, SetConsigneeReception) on behalf of the company user. This endpoint is functionally equivalent to the individual typed RPCs but is optimised for form-based UIs that operate on the full document state rather than isolated mutation types. Movement documents are explicitly excluded and must always use the dedicated movement RPCs.", "operationId": "CompanyDocumentApi_SetByIntent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetByIntentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetByIntentResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetCarrierTransport": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetCarrierTransport", "description": "Records the carrier\u0027s transport data for an individual shipment under a consented prior written notification. Under Regulation (EU) 2024/1157, the carrier must complete the movement document with the actual departure date, transport route, vehicle details, and a declaration that the waste is correctly packaged and labelled. Where multiple carriers are involved, each carrier completes a carrier transfer section when taking custody of the shipment. The movement document must accompany the waste throughout transport and be presented to authorities upon request.", "operationId": "CompanyDocumentApi_SetCarrierTransport", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCarrierTransportApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetCarrierTransportResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetConsigneeReception": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetConsigneeReception", "description": "Submits the consignee\u0027s certificate of waste receipt for a notified waste shipment under Regulation (EU) 2024/1157. The consignee must confirm receipt within three working days of accepting the waste, stating the date and location of receipt, the quantities received, and any discrepancies from the movement document. A signed copy of the movement document with this confirmation must be sent to the notifier and all competent authorities of export, destination, and transit that were involved in the notification procedure.", "operationId": "CompanyDocumentApi_SetConsigneeReception", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetConsigneeReceptionApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetConsigneeReceptionResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetFacilityCompletion": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetFacilityCompletion", "description": "Submits the recovery or disposal facility\u0027s certificate of completion for a notified waste shipment under Regulation (EU) 2024/1157. Once the recovery or disposal operation has been carried out, the facility must certify completion, specifying the actual operation performed (R-code or D-code), quantities treated, and the date of completion. This certificate must be issued within 30 days of completing the operation and no later than one calendar year after receipt. A signed copy must be sent to the notifier and all competent authorities involved. Receipt of this certificate by all competent authorities of destination enables them to release the financial guarantee held against the notification.", "operationId": "CompanyDocumentApi_SetFacilityCompletion", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFacilityCompletionApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFacilityCompletionResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetFacilityCompletionUnderArticle15": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetFacilityCompletionUnderArticle15", "description": "Submits the recovery facility\u0027s certificate of completion for notified waste shipments destined for pre-consented facilities, as required by Art. 15 in conjunction with Art. 27(1)(a)(xii) of Regulation (EU) 2024/1157. Pre-consented facilities (Annex VI) benefit from a shortened notification procedure and a reduced decision time limit. Upon completion of the recovery operation, the facility must issue this certificate to confirm environmentally sound management and to formally close the notification dossier in DIWASS. The certificate must be submitted within 30 days of completing the recovery operation and no later than one calendar year after receipt of the waste.", "operationId": "CompanyDocumentApi_SetFacilityCompletionUnderArticle15", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFacilityCompletionUnderArticle15Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFacilityCompletionUnderArticle15Response" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetFacilityReception": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetFacilityReception", "description": "Submits the recovery or disposal facility\u0027s certificate of waste receipt for a notified waste shipment under Regulation (EU) 2024/1157. Where the consignee and the treatment facility are distinct entities, the facility separately certifies receipt, confirming the date of acceptance, waste quantities, and the intended recovery or disposal operation (R-code or D-code). This certificate must be issued within three working days of acceptance and transmitted to the notifier and all relevant competent authorities to update the movement record in DIWASS.", "operationId": "CompanyDocumentApi_SetFacilityReception", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFacilityReceptionApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFacilityReceptionResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetMovementTemplate": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetMovementTemplate", "description": "Updates an existing movement document template for a notified waste shipment. May be used to correct transport dates, carrier details, or waste quantities prior to the movement commencing. Once the carrier has taken custody of the waste and issued the first carrier transfer certificate, changes to the movement template require authority involvement.", "operationId": "CompanyDocumentApi_SetMovementTemplate", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMovementTemplateApiRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetMovementTemplateResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetReplyToRequestInformation": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetReplyToRequestInformation", "description": "Submits the notifier\u0027s response to a competent authority\u0027s request for additional information. Under Regulation (EU) 2024/1157, competent authorities may suspend the decision time limit by requesting supplementary data (e.g. clarification of waste composition, revised transport route, updated financial guarantee documentation). The notifier must provide a complete and accurate response; the decision time limit resumes only upon submission. Incomplete responses may lead to further requests or ultimately to an objection decision.", "operationId": "CompanyDocumentApi_SetReplyToRequestInformation", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetReplyToRequestInformationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetReplyToRequestInformationResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetRequestForChangeAfterConsent": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetRequestForChangeAfterConsent", "description": "Submits a formal request from the notifier to modify a notification that has already received consent from all competent authorities. Under Regulation (EU) 2024/1157, changes such as a substituted carrier, an adjusted transport route, or a revised waste quantity within the consented range require explicit authority approval before they take effect. Shipments must continue under the existing consent terms until the change request has been accepted. If the requested change fundamentally alters the notified shipment, authorities may require a new notification to be submitted.", "operationId": "CompanyDocumentApi_SetRequestForChangeAfterConsent", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRequestForChangeAfterConsentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetRequestForChangeAfterConsentResponse" } } } } } } }, "/infotech.zedal.bxa.diwass.v1.api.CompanyDocumentApi/SetSubmission": { "post": { "tags": [ "CompanyDocumentApi" ], "summary": "SetSubmission", "description": "Updates the notification dossier of an existing prior written notification or submits a correction to a previously filed notification. The server determines automatically from the document state whether to apply a submission intent (first filing) or a correction intent (amending a notification that has already been received by the competent authorities). Under Regulation (EU) 2024/1157, corrections to a notification that has not yet been acknowledged are treated as a replacement; corrections to an acknowledged notification require explicit authority acceptance and may restart time limits.", "operationId": "CompanyDocumentApi_SetSubmission", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSubmissionRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetSubmissionResponse" } } } } } } }, "/infotech.zedal.core.preview.api.PreviewApi/ListTransportDocument": { "get": { "tags": [ "PreviewApi" ], "summary": "ListTransportDocument", "description": "Lists the transport documents with condition sort and page wise.", "operationId": "PreviewApi_ListTransportDocument", "parameters": [ { "name": "qpar.mask", "in": "query", "description": "fieldmask", "schema": { "type": "string", "format": "field-mask" } }, { "name": "qpar.pageStart", "in": "query", "description": "paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "qpar.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransportDocumentResponse" } } } } } } }, "/infotech.zedal.core.preview.api.PreviewApi/ListTransportTemplates": { "get": { "tags": [ "PreviewApi" ], "summary": "ListTransportTemplates", "description": "Lists the templates for transport documents", "operationId": "PreviewApi_ListTransportTemplates", "parameters": [ { "name": "qpar.mask", "in": "query", "description": "fieldmask", "schema": { "type": "string", "format": "field-mask" } }, { "name": "qpar.pageStart", "in": "query", "description": "paging", "schema": { "type": "integer", "format": "int32" } }, { "name": "qpar.pageSize", "in": "query", "schema": { "type": "integer", "format": "int32" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListTransportTemplatesResponse" } } } } } } }, "/infotech.zedal.core.v1.api.AuthApi/ChangePassword": { "post": { "tags": [ "AuthApi" ], "summary": "ChangePassword", "description": "Changes the password of an account. The caller is authenticated by the current credentials supplied in the request body \u2014 no AccessToken needed, which means an account can rotate its password even after losing all active tokens.\n\nRequires scope \u0060usermgt\u0060 only when changing the password of an account other than the calling one.", "operationId": "AuthApi_ChangePassword", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangePasswordResponse" } } } } } } }, "/infotech.zedal.core.v1.api.AuthApi/IssueClientId": { "post": { "tags": [ "AuthApi" ], "summary": "IssueClientId", "description": "Issues a \u0060client_id\u0060 / \u0060client_secret\u0060 pair for the calling account, intended for automated processing (machine-to-machine logins via \u0060ClientIdCredentials\u0060 in \u0060IssueRefreshToken\u0060).\n\nRequires scope \u0060usermgt\u0060.", "operationId": "AuthApi_IssueClientId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueClientIdRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueClientIdResponse" } } } } } } }, "/infotech.zedal.core.v1.api.AuthApi/IssueRefreshToken": { "post": { "tags": [ "AuthApi" ], "summary": "IssueRefreshToken", "description": "Initial login. Exchanges credentials (\u0060UsernameCredentials\u0060 or \u0060ClientIdCredentials\u0060) plus a provider-issued \u0060app_token\u0060 for a long-lived RefreshToken in JWT format. The returned RefreshToken is the input for \u0060RequestAccess\u0060, which exchanges it for short-lived AccessTokens.\n\nCalled unauthenticated.", "operationId": "AuthApi_IssueRefreshToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueRefreshTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/IssueRefreshTokenResponse" } } } } }, "security": [ {} ] } }, "/infotech.zedal.core.v1.api.AuthApi/ListClientIds": { "get": { "tags": [ "AuthApi" ], "summary": "ListClientIds", "description": "Lists every active \u0060client_id\u0060 issued for the calling account. Returned without the \u0060client_secret\u0060 (which is only visible at \u0060IssueClientId\u0060 time).\n\nRequires scope \u0060usermgt\u0060.", "operationId": "AuthApi_ListClientIds", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListClientIdsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.AuthApi/ListSessions": { "get": { "tags": [ "AuthApi" ], "summary": "ListSessions", "description": "Lists every active session (RefreshToken family) of the calling account. Useful for self-service \u0022sign out everywhere\u0022 flows: list, then revoke via \u0060RevokeRefreshToken\u0060.\n\nRequires scope \u0060usermgt\u0060.", "operationId": "AuthApi_ListSessions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListSessionsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.AuthApi/RequestAccess": { "post": { "tags": [ "AuthApi" ], "summary": "RequestAccess", "description": "Exchanges the presented RefreshToken for a short-lived AccessToken and a **new RefreshToken**. The presented RefreshToken is invalidated by this call (token rotation); the client must persist the new RefreshToken and use it for the next \u0060RequestAccess\u0060.\n\nAuthenticates via the RefreshToken in the \u0060Authorization\u0060 header \u2014 the only operation that uses the \u0060RefreshToken\u0060 security scheme instead of the default \u0060AccessToken\u0060.", "operationId": "AuthApi_RequestAccess", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestAccessRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RequestAccessResponse" } } } } }, "security": [ { "RefreshToken": [] } ] } }, "/infotech.zedal.core.v1.api.AuthApi/RevokeClientId": { "post": { "tags": [ "AuthApi" ], "summary": "RevokeClientId", "description": "Revokes a \u0060client_id\u0060 and cascades the revocation to every RefreshToken that was minted using this client_id \u2014 any active session of that machine client is terminated.\n\nRequires scope \u0060usermgt\u0060.", "operationId": "AuthApi_RevokeClientId", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeClientIdRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeClientIdResponse" } } } } } } }, "/infotech.zedal.core.v1.api.AuthApi/RevokeRefreshToken": { "post": { "tags": [ "AuthApi" ], "summary": "RevokeRefreshToken", "description": "Invalidates a RefreshToken \u2014 effectively logs out a session. Authenticates via the RefreshToken to be revoked (no AccessToken required), so it works even after a session has lost AccessToken capability.\n\nRequires scope \u0060usermgt\u0060 only when revoking a token family that doesn\u0027t belong to the calling account (i.e. admin-style revocation of another user).", "operationId": "AuthApi_RevokeRefreshToken", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeRefreshTokenRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeRefreshTokenResponse" } } } } }, "security": [ { "RefreshToken": [] } ] } }, "/infotech.zedal.core.v1.api.CommonApi/GetGlobalParameter": { "get": { "tags": [ "CommonApi" ], "summary": "GetGlobalParameter", "description": "Gets the value of a subscriber wide set parameter. Requests the value for a subscriber based global parameter.", "operationId": "CommonApi_GetGlobalParameter", "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetGlobalParameterResponse" } } } } } } }, "/infotech.zedal.core.v1.api.CommonApi/SetGlobalParameter": { "put": { "tags": [ "CommonApi" ], "summary": "SetGlobalParameter", "description": "Sets a parameter that is persistend per subscriber. \u003Cbr\u003ESets a subscriber based global value. May be used in order to e.g. hold counter values independent from single machines.", "operationId": "CommonApi_SetGlobalParameter", "parameters": [ { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "value", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetGlobalParameterResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/AcknowledgeTransportDocument": { "get": { "tags": [ "DocumentApi" ], "summary": "AcknowledgeTransportDocument", "description": "Sets a document delivery entry as acknowledged by the receiver.The receiver may add status info and a descriptive text for the sender.See [PeekNextAcknowledgableTransportDocument](#tag/DocumentApi/operation/DocumentApi_PeekNextAcknowledgableTransportDocument).", "operationId": "DocumentApi_AcknowledgeTransportDocument", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "logId.id", "in": "query", "schema": { "type": "string" } }, { "name": "result", "in": "query", "schema": { "type": "integer", "format": "enum" } }, { "name": "message", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AcknowledgeTransportDocumentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/ApplyInboxFilter": { "patch": { "tags": [ "DocumentApi" ], "summary": "ApplyInboxFilter", "description": "Executes the inbox filter rules. \u003Cbr\u003EApplies all automatic filters configured in the ZEDAL portal.", "operationId": "DocumentApi_ApplyInboxFilter", "parameters": [ { "name": "onlyUnread.value", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ApplyInboxFilterResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/ChangeDocumentPrivacyLevel": { "patch": { "tags": [ "DocumentApi" ], "summary": "ChangeDocumentPrivacyLevel", "description": "Changes the documents privacy level.", "operationId": "DocumentApi_ChangeDocumentPrivacyLevel", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "privacyLevel", "in": "query", "schema": { "type": "integer", "format": "enum" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ChangeDocumentPrivacyLevelResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/ExportCurrentDocument": { "get": { "tags": [ "DocumentApi" ], "summary": "ExportCurrentDocument", "description": "Get a document\u0027s binary representation.Forms the current view up to lastident from the document protocol and returns the resulting data as a binary block of data.If lastident is left empty all historical data will be used. \u003Cbr\u003E \u003Cbr\u003EThe export format depends on the format the document is held in. If the document is in IKS format no signatures will be exported.", "operationId": "DocumentApi_ExportCurrentDocument", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "lastLogId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportCurrentDocumentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/GetDocumentByIdent": { "get": { "tags": [ "DocumentApi" ], "summary": "GetDocumentByIdent", "description": "Find a document identifier by other identifiers, e.g. from the document\u0027s content.", "operationId": "DocumentApi_GetDocumentByIdent", "parameters": [ { "name": "idType", "in": "query", "schema": { "type": "integer", "format": "enum" } }, { "name": "idValue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentByIdentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/GetDocumentParameter": { "get": { "tags": [ "DocumentApi" ], "summary": "GetDocumentParameter", "description": "Request a documents parameter value.Gets the value of a subscriber defined key on document.", "operationId": "DocumentApi_GetDocumentParameter", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "onlyPrivate", "in": "query", "description": "Determines wether just private or both public and private values are to be considered.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentParameterResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/GetDocumentParticipant": { "get": { "tags": [ "DocumentApi" ], "summary": "GetDocumentParticipant", "description": "Get address and id information about the last editing party of the documentDetermines the data of the participating parties of a document.This data contains the postal address and the numbers assigned by the authorities as far as they are available", "operationId": "DocumentApi_GetDocumentParticipant", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "logId.id", "in": "query", "schema": { "type": "string" } }, { "name": "participantType", "in": "query", "schema": { "type": "integer", "format": "enum" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetDocumentParticipantResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/GetNotificationMonitoringData": { "get": { "tags": [ "DocumentApi" ], "summary": "GetNotificationMonitoringData", "description": "Gets master and current aggregated data, e.g. when a transport document is about to be updated.Notification based monitoring includes weight, validity date and number of transport monitoring.Additionally some specialized jurisdiction regulations are monitored.", "operationId": "DocumentApi_GetNotificationMonitoringData", "parameters": [ { "name": "documentFormat", "in": "query", "schema": { "type": "string" } }, { "name": "notificationNo", "in": "query", "schema": { "type": "string" } }, { "name": "generatorNo", "in": "query", "schema": { "type": "string" } }, { "name": "wasteCode", "in": "query", "schema": { "type": "string" } }, { "name": "transportDate.value", "in": "query", "description": "The date value, formated as YYYY-MM-DD", "schema": { "type": "string" } }, { "name": "executionConfig.executeNotificationBasedMonitoring.value", "in": "query", "schema": { "type": "boolean" } }, { "name": "executionConfig.executeSmallAndSmallestAmountMonitoring.value", "in": "query", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetNotificationMonitoringDataResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/GetTransportDocumentByIdent": { "get": { "tags": [ "DocumentApi" ], "summary": "GetTransportDocumentByIdent", "description": "Find a document identifier by other identifiers, e.g. from the document\u0027s content. Limited to transport documents.Determines the document identifier by comparison of the typical functional identifier of a transport document.If a caller knows e.g. the transport document number he can determine wether or not the document is in the distribution.If it is the document identifier is returned for further operations. \u003Cbr\u003E \u003Cbr\u003ENot finding a document for the given searching parameters is not an error. An empty value will be returned instead.", "operationId": "DocumentApi_GetTransportDocumentByIdent", "parameters": [ { "name": "idType", "in": "query", "schema": { "type": "integer", "format": "enum" } }, { "name": "idValue", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetTransportDocumentByIdentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/ListDocumentsByParameters": { "get": { "tags": [ "DocumentApi" ], "summary": "ListDocumentsByParameters", "description": "Lists all documents with specific key value pairs.Determines the documents that have a parameter of a given value.", "operationId": "DocumentApi_ListDocumentsByParameters", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDocumentsByParametersResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/ListInbox": { "get": { "tags": [ "DocumentApi" ], "summary": "ListInbox", "description": "List the documents of the inbox. \u003Cbr\u003EThe selection may be limited by the condition parameter.If no condition parameter is given all unread documents without any time based constrains will be listed. \u003Cbr\u003E \u003Cbr\u003EOnly documents the user has access to will be listed.", "operationId": "DocumentApi_ListInbox", "parameters": [ { "name": "unread.value", "in": "query", "schema": { "type": "boolean" } }, { "name": "from", "in": "query", "schema": { "type": "string", "format": "date-time" } }, { "name": "to", "in": "query", "schema": { "type": "string", "format": "date-time" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListInboxResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/PeekNextAcknowledgableTransportDocument": { "get": { "tags": [ "DocumentApi" ], "summary": "PeekNextAcknowledgableTransportDocument", "description": "Get identifiers of the next document that has to be acknowledged.", "operationId": "DocumentApi_PeekNextAcknowledgableTransportDocument", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeekNextAcknowledgableTransportDocumentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/PeekNextFileAreaDocument": { "get": { "tags": [ "DocumentApi" ], "summary": "PeekNextFileAreaDocument", "description": "List the next file area document delivered by the distribution module.See [SetFileAreaDocumentReceived](#tag/DocumentApi/operation/DocumentApi_SetFileAreaDocumentReceived).", "operationId": "DocumentApi_PeekNextFileAreaDocument", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeekNextFileAreaDocumentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/PeekNextTransportDocument": { "get": { "tags": [ "DocumentApi" ], "summary": "PeekNextTransportDocument", "description": "List the next transport document delivered by the distribution module.\u003Cbr\u003EThis function returns the same result as [GetTransportDocument](), but it does not remove the document from the list. \u003Cbr\u003EIn order to remove it, see [SetTransportDocumentReceived](#tag/DocumentApi/operation/DocumentApi_SetTransportDocumentReceived)", "operationId": "DocumentApi_PeekNextTransportDocument", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/PeekNextTransportDocumentResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/RemoveDocumentsFromInbox": { "delete": { "tags": [ "DocumentApi" ], "summary": "RemoveDocumentsFromInbox", "description": "Removes a document from the inbox.Only after calling this function documents are removed from the inbox.", "operationId": "DocumentApi_RemoveDocumentsFromInbox", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RemoveDocumentsFromInboxResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/SetDocumentParameter": { "patch": { "tags": [ "DocumentApi" ], "summary": "SetDocumentParameter", "description": "Assigns a subscriber defined key value pair to a document. \u003Cbr\u003ESets a parameter for the document the same ways that parameters can be set for files.Specific predefined parameter names allow changing the facility numbers without changing the document itself.Those numbers are part of the user management and influence the access permissions for accounts.", "operationId": "DocumentApi_SetDocumentParameter", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "key", "in": "query", "schema": { "type": "string" } }, { "name": "value", "in": "query", "schema": { "type": "string" } }, { "name": "isPublic", "in": "query", "description": "Determines wether or not the set parameter is public or private.", "schema": { "type": "boolean" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetDocumentParameterResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/SetFileAreaDocumentReceived": { "patch": { "tags": [ "DocumentApi" ], "summary": "SetFileAreaDocumentReceived", "description": "Confirms that the delivery of a file area document has been received.See [PeekNextFileAreaDocument](#tag/DocumentApi/operation/DocumentApi_PeekNextFileAreaDocument).", "operationId": "DocumentApi_SetFileAreaDocumentReceived", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "logId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetFileAreaDocumentReceivedResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/SetInboxDocumentsRead": { "patch": { "tags": [ "DocumentApi" ], "summary": "SetInboxDocumentsRead", "description": "Sets the \u0022read\u0022 flag on documents of the inbox.Marks the given documents as read so they no longer show up as unread in the inbox. \u003Cbr\u003EThe documents remain in the inbox.", "operationId": "DocumentApi_SetInboxDocumentsRead", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetInboxDocumentsReadResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentApi/SetTransportDocumentReceived": { "patch": { "tags": [ "DocumentApi" ], "summary": "SetTransportDocumentReceived", "description": "Confirms that the delivery of a transport document has been received. \u003Cbr\u003EThis function confirms that the user has received the document properly.The parameters have been returned by [PeekNextTransportDocument](#tag/DocumentApi/operation/DocumentApi_PeekNextTransportDocument) before.Only after calling this function, the next document in the list of unreceived documents will be availablethrough [PeekNextTransportDocument](#tag/DocumentApi/operation/DocumentApi_PeekNextTransportDocument).", "operationId": "DocumentApi_SetTransportDocumentReceived", "parameters": [ { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "logId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetTransportDocumentReceivedResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentTemplateApi/DeleteFileareaTemplate": { "delete": { "tags": [ "DocumentTemplateApi" ], "summary": "DeleteFileareaTemplate", "description": "Deletes a file area document template.", "operationId": "DocumentTemplateApi_DeleteFileareaTemplate", "parameters": [ { "name": "templateId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFileareaTemplateResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentTemplateApi/DeleteTransportTemplate": { "delete": { "tags": [ "DocumentTemplateApi" ], "summary": "DeleteTransportTemplate", "description": "Deletes the transport document template with the given number.", "operationId": "DocumentTemplateApi_DeleteTransportTemplate", "parameters": [ { "name": "templateId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteTransportTemplateResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentTemplateApi/ExportFileareaTemplate": { "get": { "tags": [ "DocumentTemplateApi" ], "summary": "ExportFileareaTemplate", "description": "Exports a binary representation for a file area template.", "operationId": "DocumentTemplateApi_ExportFileareaTemplate", "parameters": [ { "name": "templateId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportFileareaTemplateResponse" } } } } } } }, "/infotech.zedal.core.v1.api.DocumentTemplateApi/ExportTransportTemplate": { "get": { "tags": [ "DocumentTemplateApi" ], "summary": "ExportTransportTemplate", "description": "Exports a binary representation for a transport template.", "operationId": "DocumentTemplateApi_ExportTransportTemplate", "parameters": [ { "name": "templateId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ExportTransportTemplateResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/CancelSubmission": { "delete": { "tags": [ "FileApi" ], "summary": "CancelSubmission", "description": "Cancel an opened submission. The submission is finished after this call. \u003Cbr\u003ETemporary permissions gained by the submission will be removed. \u003Cbr\u003EWhether or not this function succeeds depends on the current submission state.", "operationId": "FileApi_CancelSubmission", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } }, { "name": "comment", "in": "query", "description": "A comment to send along. Not all transport ways allow a comment, it may be ignored.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CancelSubmissionResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/CompleteSubmission": { "patch": { "tags": [ "FileApi" ], "summary": "CompleteSubmission", "description": "Complete an opened submission.\u003Cbr\u003ESet a submission into \u0022processed\u0022 state. \u003Cbr\u003EMay only be called by the receiving subscriber. \u003Cbr\u003EThe destination subscriber permanently gains the permission of this submission. \u003Cbr\u003EWhether or not this function succeeds depends on the current submission state.", "operationId": "FileApi_CompleteSubmission", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } }, { "name": "comment", "in": "query", "description": "A comment to send along. Not all transport ways allow a comment, it may be ignored.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/CompleteSubmissionResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/DeleteDocumentFromFile": { "delete": { "tags": [ "FileApi" ], "summary": "DeleteDocumentFromFile", "description": "Removes a document from a file and places it into an area for deleted documents.", "operationId": "FileApi_DeleteDocumentFromFile", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } }, { "name": "docId.id", "in": "query", "schema": { "type": "string" } }, { "name": "comment", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteDocumentFromFileResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/DeleteFile": { "delete": { "tags": [ "FileApi" ], "summary": "DeleteFile", "description": "Deletes an existing file.", "operationId": "FileApi_DeleteFile", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DeleteFileResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/DiscardFinishedSubmission": { "delete": { "tags": [ "FileApi" ], "summary": "DiscardFinishedSubmission", "description": "Removes a file from the list of completed or rejected submissions.See [ListCompletedSubmissions](#tag/FileApi/operation/FileApi_ListCompletedSubmissions) or [ListRejectedSubmissions](#tag/FileApi/operation/FileApi_ListRejectedSubmissions)", "operationId": "FileApi_DiscardFinishedSubmission", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/DiscardFinishedSubmissionResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/GetFileByRefId": { "get": { "tags": [ "FileApi" ], "summary": "GetFileByRefId", "description": "Gets the id for the file that has the given ref-id.Determines the file that the given user defined reference is a assigned to. \u003Cbr\u003ESee [AssignRefIdToFile](#tag/FileApi/operation/FileApi_AssignRefIdToFile)", "operationId": "FileApi_GetFileByRefId", "parameters": [ { "name": "refId", "in": "query", "description": "A user defined string that is attached to a file.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetFileByRefIdResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/ListAllSubmissions": { "get": { "tags": [ "FileApi" ], "summary": "ListAllSubmissions", "description": "Lists all submissions. \u003Cbr\u003EFetches a list of all currently submitted files.", "operationId": "FileApi_ListAllSubmissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAllSubmissionsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/ListCompletedSubmissions": { "get": { "tags": [ "FileApi" ], "summary": "ListCompletedSubmissions", "description": "Lists all completed submissions. \u003Cbr\u003EDetermines all submission that have been finished (CompleteSubmission) and that have not beenremove from this list by calling [DiscardFinishedSubmission](#tag/FileApi/operation/FileApi_DiscardFinishedSubmission).", "operationId": "FileApi_ListCompletedSubmissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListCompletedSubmissionsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/ListDocuments": { "get": { "tags": [ "FileApi" ], "summary": "ListDocuments", "description": "Lists the documents contained in the file.", "operationId": "FileApi_ListDocuments", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListDocumentsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/ListNewSubmissions": { "get": { "tags": [ "FileApi" ], "summary": "ListNewSubmissions", "description": "Lists all new submissions. \u003Cbr\u003EFetches a list of all newly submitted files. \u003Cbr\u003ENewly submitted files are not held yet. By holding the submission the file is removed from this list.", "operationId": "FileApi_ListNewSubmissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListNewSubmissionsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/ListRejectedSubmissions": { "get": { "tags": [ "FileApi" ], "summary": "ListRejectedSubmissions", "description": "Lists all rejected submissions. \u003Cbr\u003EDetermines all submission that have been rejected (RejectSubmission) and that have not beenbeen remove from this list by calling [DiscardFinishedSubmission](#tag/FileApi/operation/FileApi_DiscardFinishedSubmission).", "operationId": "FileApi_ListRejectedSubmissions", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListRejectedSubmissionsResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/RevokeAccessFromFile": { "delete": { "tags": [ "FileApi" ], "summary": "RevokeAccessFromFile", "description": "Revoke previously granted access to a file.The function removes the share to that subscriber completely.", "operationId": "FileApi_RevokeAccessFromFile", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } }, { "name": "receiverAddressee.address", "in": "query", "schema": { "type": "string" } }, { "name": "receiverAddressee.subaddress", "in": "query", "schema": { "type": "string" } }, { "name": "comment", "in": "query", "description": "A comment to send along.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RevokeAccessFromFileResponse" } } } } } } }, "/infotech.zedal.core.v1.api.FileApi/SetLocalSubmission": { "put": { "tags": [ "FileApi" ], "summary": "SetLocalSubmission", "description": "Sets the account that has the local submission for a file. \u003Cbr\u003ETemporary local submission of a file to an account of the same subscriber. \u003Cbr\u003EThis account gains access to the file until the local submission is modified or finished. \u003Cbr\u003E This function does not create a protocol entry. \u003Cbr\u003E This function may e.g. be used for an internal workflow, where the next employee receives a local submission by the previous one. \u003Cbr\u003EThe local submission may be used by any account with access to the file.This means that an account that received a local submission is able to issue a new local submission on its own. \u003Cbr\u003EWhen a new file is created the creating account automatically receives a local submission.", "operationId": "FileApi_SetLocalSubmission", "parameters": [ { "name": "fileId.id", "in": "query", "schema": { "type": "string" } }, { "name": "receiverAccount", "in": "query", "description": "The account that is to receive the local submission.", "schema": { "type": "string" } }, { "name": "comment", "in": "query", "description": "A comment to send along.", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SetLocalSubmissionResponse" } } } } } } }, "/infotech.zedal.core.v1.api.MasterdataApi/ListAddresses": { "get": { "tags": [ "MasterdataApi" ], "summary": "ListAddresses", "description": "Lists all addresses.", "operationId": "MasterdataApi_ListAddresses", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListAddressesResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.AttachmentApi/GetAttachment": { "post": { "tags": [ "AttachmentApi" ], "summary": "GetAttachment", "description": "Retrieves a binary attachment from the DiWaSS central system by identifier.", "operationId": "AttachmentApi_GetAttachment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentGetAttachmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentGetAttachmentResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.AttachmentApi/SubmitAttachment": { "post": { "tags": [ "AttachmentApi" ], "summary": "SubmitAttachment", "description": "Submits a binary attachment to the DiWaSS central system.", "operationId": "AttachmentApi_SubmitAttachment", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentSubmitAttachmentRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AttachmentSubmitAttachmentResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.AuthorityApi/FindAuthorityActivity": { "post": { "tags": [ "AuthorityApi" ], "summary": "FindAuthorityActivity", "description": "Finds authority activities using search criteria.", "operationId": "AuthorityApi_FindAuthorityActivity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityFindAuthorityActivityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityFindAuthorityActivityResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.AuthorityApi/GetAuthority": { "post": { "tags": [ "AuthorityApi" ], "summary": "GetAuthority", "description": "Gets authorities by internal authority ID.", "operationId": "AuthorityApi_GetAuthority", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGetAuthorityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGetAuthorityResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.AuthorityApi/GetAuthorityActivityUpdates": { "post": { "tags": [ "AuthorityApi" ], "summary": "GetAuthorityActivityUpdates", "description": "Gets authority activity updates for synchronization.", "operationId": "AuthorityApi_GetAuthorityActivityUpdates", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGetAuthorityActivityUpdatesRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGetAuthorityActivityUpdatesResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.AuthorityApi/GetAuthorityByActivity": { "post": { "tags": [ "AuthorityApi" ], "summary": "GetAuthorityByActivity", "description": "Gets authorities by internal authority activity ID.", "operationId": "AuthorityApi_GetAuthorityByActivity", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGetAuthorityByActivityRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/AuthorityGetAuthorityByActivityResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.OperatorApi/FindOperator": { "post": { "tags": [ "OperatorApi" ], "summary": "FindOperator", "description": "Finds diwass operators.", "operationId": "OperatorApi_FindOperator", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindOperatorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/FindOperatorResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.OperatorApi/GetOperator": { "post": { "tags": [ "OperatorApi" ], "summary": "GetOperator", "description": "Gets diwass operators.", "operationId": "OperatorApi_GetOperator", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOperatorRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetOperatorResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.RetrievalApi/GetAllAnnex7": { "post": { "tags": [ "RetrievalApi" ], "summary": "GetAllAnnex7", "description": "Gets all Annex VII documents within a date range.", "operationId": "RetrievalApi_GetAllAnnex7", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalGetAllAnnex7Request" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalGetAllAnnex7Response" } } } } } } }, "/infotech.zedal.diwass.v1.api.RetrievalApi/GetAllMovements": { "post": { "tags": [ "RetrievalApi" ], "summary": "GetAllMovements", "description": "Gets all movements for a given notification.", "operationId": "RetrievalApi_GetAllMovements", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalGetAllMovementsRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalGetAllMovementsResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.RetrievalApi/LookupEventList": { "post": { "tags": [ "RetrievalApi" ], "summary": "LookupEventList", "description": "Looks up the event list for waste notifications, movements and annex7 documents.", "operationId": "RetrievalApi_LookupEventList", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalLookupEventListRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalLookupEventListResponse" } } } } } } }, "/infotech.zedal.diwass.v1.api.RetrievalApi/LookupSyncNotification": { "post": { "tags": [ "RetrievalApi" ], "summary": "LookupSyncNotification", "description": "Looks up notification modification details for synchronization.", "operationId": "RetrievalApi_LookupSyncNotification", "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalLookupSyncNotificationRequest" } } }, "required": true }, "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/RetrievalLookupSyncNotificationResponse" } } } } } } }, "/infotech.zedal.provider_discovery.v1.api.DiscoveryApi/ListProvider": { "get": { "tags": [ "DiscoveryApi" ], "summary": "ListProvider", "description": "lists all provider. Can be used to select the provider to login", "operationId": "DiscoveryApi_ListProvider", "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListProviderResponse" } } } } }, "security": [ {} ], "x-codeSamples": [ { "lang": "cURL", "label": "CLI", "source": "curl https:///test-api.zedal.de/openapi/infotech.zedal.provider_discovery.v1.api.DiscoveryApi/ListProvider\n" } ] } }, "/infotech.signer.v2.api.VerifyApi/VerifyPdf": { "post": { "operationId": "VerifyApi_VerifyPdf", "tags": [ "infotech.signer.v2.api.VerifyApi" ], "responses": { "200": { "description": "OK" } } } }, "/infotech.signer.v2.api.VerifyApi/VerifyXml": { "post": { "operationId": "VerifyApi_VerifyXml", "tags": [ "infotech.signer.v2.api.VerifyApi" ], "responses": { "200": { "description": "OK" } } } }, "/infotech.signer.v2.api.VerifyApi/VerifyCert": { "post": { "operationId": "VerifyApi_VerifyCert", "tags": [ "infotech.signer.v2.api.VerifyApi" ], "responses": { "200": { "description": "OK" } } } }, "/infotech.signer.v2.api.VerifyApi/VerifyP7": { "post": { "operationId": "VerifyApi_VerifyP7", "tags": [ "infotech.signer.v2.api.VerifyApi" ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "AccountId": { "type": "object", "properties": { "subscriberId": { "type": "string" }, "accountId": { "type": "string" } } }, "AcknowledgeTransportDocumentResponse": { "type": "object", "properties": {} }, "AcknowledgementDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "notificationId": { "$ref": "#/components/schemas/StringField" }, "acknowledgement": { "$ref": "#/components/schemas/AcknowledgementType" }, "competentAuthority": { "$ref": "#/components/schemas/CompetentAuthorityType" }, "competentAuthoritySignature": { "$ref": "#/components/schemas/SignatureType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Authority acknowledgement that a notification has been received and the completeness check passed. Distinct from a Decision: an acknowledgement does not imply consent." }, "AcknowledgementResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationId": { "$ref": "#/components/schemas/StringField" }, "acknowledgementId": { "$ref": "#/components/schemas/StringField" } }, "description": "Response returned when a competent-authority acknowledgement of a notification submission is recorded. Carries the validation outcome, the NotificationId and the server-assigned AcknowledgementId." }, "AcknowledgementType": { "type": "object", "properties": { "receiptDate": { "$ref": "#/components/schemas/TimestampField" }, "sentDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Acknowledgement issued by a competent authority confirming that a notification submission has been received and registered. Records both the receipt date (when it arrived) and the sent date (when the acknowledgement was dispatched)." }, "AdditionalPropertiesItem": { "type": "object", "properties": { "schemaOrReference": { "$ref": "#/components/schemas/SchemaOrReference" }, "boolean": { "type": "boolean" } } }, "Address": { "type": "object", "properties": { "name1": { "type": "string" }, "name2": { "type": "string" }, "name3": { "type": "string" }, "name4": { "type": "string" }, "department": { "type": "string" }, "street": { "type": "string" }, "housenumber": { "type": "string" }, "postcode": { "type": "string" }, "city": { "type": "string" }, "country": { "type": "string" }, "tohandson": { "$ref": "#/components/schemas/Contact" } } }, "AddressBaseType": { "type": "object", "properties": { "street": { "$ref": "#/components/schemas/StringField" }, "city": { "$ref": "#/components/schemas/CityDescriptorBaseType" }, "postalCodeExtension": { "$ref": "#/components/schemas/StringField" }, "longitude": { "$ref": "#/components/schemas/DoubleField" }, "latitude": { "$ref": "#/components/schemas/DoubleField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Postal address used by the DIWASS operator directory. Couples a free-form street with a structured \u0060city\u0060 reference and optional geo-coordinates. The \u0060internalId\u0060 identifies an address already persisted in the directory." }, "AddressEntry": { "type": "object", "properties": { "id": { "type": "string" }, "corporation": { "$ref": "#/components/schemas/StreetAddress" }, "site": { "$ref": "#/components/schemas/StreetAddress" }, "partyIds": { "type": "array", "items": { "$ref": "#/components/schemas/PartyId" } } }, "description": "single entry corporation and site with international registration numbers" }, "AddressIndexType": { "type": "object", "properties": { "street": { "$ref": "#/components/schemas/StringField" }, "city": { "$ref": "#/components/schemas/CityDescriptorType" }, "postalCodeExtension": { "$ref": "#/components/schemas/StringField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "---------------------------------------------------------------------\r\n AddressIndexType (dircommon:AddressIndexType)\r\n ---------------------------------------------------------------------\r\n XSD: dircommon:AddressIndexType\r\n - Street: xs:string\r\n - City: dirgeocity:CityDescriptorType\r\n - PostalCodeExtension: xs:token (optional)\r\n - @internalID: xs:long (optional)" }, "AddressType": { "type": "object", "properties": { "countryId": { "$ref": "#/components/schemas/StringField" }, "postcode": { "$ref": "#/components/schemas/StringField" }, "cityName": { "$ref": "#/components/schemas/StringField" }, "addressDetails": { "$ref": "#/components/schemas/StringField" }, "latitude": { "$ref": "#/components/schemas/DoubleField" }, "longitude": { "$ref": "#/components/schemas/DoubleField" } }, "description": "Postal address with optional geographic coordinates. All fields are optional; coordinate values are clamped to valid latitude/longitude ranges (\u00B190 / \u00B1180)." }, "Annex7CertificateOfCompletionType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/DeclarationType" }, "interimFacility": { "$ref": "#/components/schemas/BoolField" }, "facilityTypeCode": { "$ref": "#/components/schemas/StringField" }, "recoveryLaboratoryParty": { "$ref": "#/components/schemas/WasteOperatorType" }, "completionDate": { "$ref": "#/components/schemas/TimestampField" }, "reusedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "recoveredQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "wasteDesignationCompositionDescription": { "$ref": "#/components/schemas/DescriptionType" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "additionalInformation": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Annex7CertificateOfCompletionType (annex7.xsd)" }, "Annex7CertificateOfWasteReceiptType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/CertificateOfWasteReceiptBaseType" }, "interimFacility": { "$ref": "#/components/schemas/BoolField" }, "facilityTypeCode": { "$ref": "#/components/schemas/StringField" }, "wasteDesignationCompositionDescription": { "$ref": "#/components/schemas/DescriptionType" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "acceptedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "rejectedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "rejectionDescription": { "$ref": "#/components/schemas/DescriptionType" }, "recoveryLaboratoryApproximateDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Annex7CertificateOfWasteReceiptType (annex7.xsd)" }, "Annex7ConcernedCountryType": { "type": "object", "properties": { "countryId": { "$ref": "#/components/schemas/StringField" } } }, "Annex7DocumentResponseType": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "annexViiDocumentNo": { "$ref": "#/components/schemas/StringField" } }, "description": "Response wrapper returned by Create/Update Annex VII document operations. Contains the underlying WasteWebServiceResponse (status, validation errors) and the assigned Annex VII document number." }, "Annex7FacilityType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/WasteOperatorType" }, "operationalIndicators": { "$ref": "#/components/schemas/FacilityOperationalIndicatorsType" }, "wasteFacilityNameConfidential": { "$ref": "#/components/schemas/BoolField" }, "confidentialityLegalExplanation": { "$ref": "#/components/schemas/DescriptionType" } } }, "Annex7InformationType": { "type": "object", "properties": { "announcement": { "$ref": "#/components/schemas/GetWasteAnnex7DocumentType" }, "transport": { "type": "array", "items": { "$ref": "#/components/schemas/GetWasteAnnex7TransportType" } }, "consigneeCertificateOfReception": { "type": "array", "items": { "$ref": "#/components/schemas/GetConsigneeAnnex7CertificateOfWasteReceiptType" } }, "facilityCertificateOfReception": { "type": "array", "items": { "$ref": "#/components/schemas/GetFacilityAnnex7CertificateOfWasteReceiptType" } }, "certificateOfCompletion": { "type": "array", "items": { "$ref": "#/components/schemas/GetWasteAnnex7CertificateOfWasteCompletionType" } }, "takeBackMovements": { "type": "array", "items": { "$ref": "#/components/schemas/GetWasteAnnex7TakeBackType" } } }, "description": "Aggregate retrieval view of an Annex VII shipment of non-notifiable waste: the announcement document plus all derived transport, consignee/facility receipt, completion and take-back documents." }, "Annex7MovementDocumentIdentifierType": { "type": "object", "properties": { "annexViiDocumentNo": { "$ref": "#/components/schemas/StringField" }, "documentNo": { "$ref": "#/components/schemas/StringField" } }, "description": "Annex7MovementDocumentIdentifierType" }, "Annex7MovementDocumentResponseType": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "movement": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" } }, "description": "Response wrapper returned by Annex VII movement-related operations (transport announcement create/update, receipt and completion certificates, take-back). Contains the underlying WasteWebServiceResponse and the movement document identifier." }, "Annex7SignalDocumentType": { "type": "object", "properties": { "annexViiDocumentNo": { "$ref": "#/components/schemas/StringField" }, "statement": { "$ref": "#/components/schemas/SignalStatementDocumentType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Out-of-band signal attached to an Annex VII shipment by an authority (e.g. customs/border interception, illegal-activity alert). Used to communicate enforcement actions that are not part of the standard shipment lifecycle." }, "Annex7TransportAnnouncementType": { "type": "object", "properties": { "arranger": { "$ref": "#/components/schemas/WasteOperatorType" }, "consignee": { "$ref": "#/components/schemas/WasteOperatorType" }, "actualQuantity": { "$ref": "#/components/schemas/NotificationMassVolumeMeasureType" }, "actualDateOfShipment": { "$ref": "#/components/schemas/TimestampField" }, "containerIdentification": { "$ref": "#/components/schemas/StringField" }, "shipmentOriginLocation": { "$ref": "#/components/schemas/ShipmentOriginAddressType" }, "shipmentLocationResponsiblePerson": { "$ref": "#/components/schemas/ContactType" }, "carrier": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierType" } }, "wasteProducer": { "type": "array", "items": { "$ref": "#/components/schemas/WasteOperatorType" } }, "recoveryLaboratoryFacility": { "type": "array", "items": { "$ref": "#/components/schemas/RecoveryLaboratoryFacilityType" } }, "recoveryDisposalTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "usualDescriptionOfTheWaste": { "$ref": "#/components/schemas/DescriptionType" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "commodityCode": { "$ref": "#/components/schemas/CustomsCodesType" }, "exportCountry": { "$ref": "#/components/schemas/Annex7ConcernedCountryType" }, "importCountry": { "$ref": "#/components/schemas/Annex7ConcernedCountryType" }, "transitCountry": { "type": "array", "items": { "$ref": "#/components/schemas/Annex7ConcernedCountryType" } } } }, "AnnexViiDocument": { "type": "object", "properties": { "specificationVersion": { "$ref": "#/components/schemas/StringField" }, "blockId": { "$ref": "#/components/schemas/StringField" }, "receivedTimestamp": { "$ref": "#/components/schemas/TimestampField" }, "vendorId": { "$ref": "#/components/schemas/StringField" }, "diwassMessage": { "$ref": "#/components/schemas/DiwassAnnexViiMessageType" }, "zedal": { "$ref": "#/components/schemas/ZedalAnnexViiType" } } }, "Any": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/GoogleProtobufAny" }, "yaml": { "type": "string" } } }, "AnyOrExpression": { "type": "object", "properties": { "any": { "$ref": "#/components/schemas/Any" }, "expression": { "$ref": "#/components/schemas/Expression" } } }, "ApplyInboxFilterResponse": { "type": "object", "properties": {} }, "AssignedResponsibleAuthoritiesType": { "type": "object", "properties": { "authority": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityType" } } }, "description": "List of competent authorities that are responsible for a given operator. Returned as part of the v2 operator detail view to expose which authorities oversee the operator\u0027s permits, reports and other regulated activities." }, "AttachInfoType": { "type": "object", "properties": { "attachmentIdentifier": { "$ref": "#/components/schemas/StringField" }, "attachmentType": { "$ref": "#/components/schemas/StringField" }, "fileName": { "$ref": "#/components/schemas/StringField" }, "containsPersonalData": { "$ref": "#/components/schemas/BoolField" } }, "description": "Metadata for a binary attachment linked to a retrieval document (submission, decision, acknowledgement, signal, ...). Carries the DIWASS attachment id, the codelist-bound classification and the original file name plus a flag whether the file contains personal data." }, "AttachmentBinaryObjectType": { "type": "object", "properties": { "value": { "type": "string", "format": "bytes" }, "typeId": { "$ref": "#/components/schemas/StringField" }, "mimeCode": { "$ref": "#/components/schemas/StringField" }, "filename": { "$ref": "#/components/schemas/StringField" }, "containsPersonalData": { "$ref": "#/components/schemas/BoolField" } }, "description": "Binary attachment carried inline as base64 bytes, classified by a \u0060type_id\u0060 from the AttachmentClassificationCode codelist (e.g. \u0060Decision\u0060, \u0060FacilityPermit\u0060, \u0060PowerOfAttorney\u0060). Includes MIME code, filename and a personal-data flag." }, "AttachmentGetAttachmentRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/AttachmentGetRequestType" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "AttachmentGetAttachmentResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/AttachmentGetResponseType" } } }, "AttachmentGetRequestType": { "type": "object", "properties": { "attachmentIdentifier": { "$ref": "#/components/schemas/AttachmentIdentifierType" } }, "description": "XSD: attach:AttachmentGetRequestType" }, "AttachmentGetResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "attachment": { "$ref": "#/components/schemas/AttachmentType" }, "attachmentIdentifier": { "$ref": "#/components/schemas/AttachmentIdentifierType" }, "encodingCode": { "$ref": "#/components/schemas/StringField" } }, "description": "XSD: attach:AttachmentGetResponseType" }, "AttachmentIdentifierType": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/StringField" } }, "description": "XSD: attach:AttachmentIdentifierType" }, "AttachmentSubmissionRequestType": { "type": "object", "properties": { "attachment": { "$ref": "#/components/schemas/AttachmentType" } }, "description": "XSD: attach:AttachmentSubmissionRequestType" }, "AttachmentSubmissionResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "attachmentIdentifier": { "$ref": "#/components/schemas/AttachmentIdentifierType" } }, "description": "XSD: attach:AttachmentSubmissionResponseType" }, "AttachmentSubmitAttachmentRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/AttachmentSubmissionRequestType" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "AttachmentSubmitAttachmentResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/AttachmentSubmissionResponseType" } } }, "AttachmentType": { "type": "object", "properties": { "attach": { "$ref": "#/components/schemas/AttachmentBinaryObjectType" } }, "description": "XSD: attach:AttachmentType" }, "AuthorityActivityDescriptorType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "code": { "$ref": "#/components/schemas/StringField" }, "unLocode": { "$ref": "#/components/schemas/StringField" }, "role": { "$ref": "#/components/schemas/CodeType" }, "address": { "$ref": "#/components/schemas/AddressType" }, "internalAuthorityActivityId": { "$ref": "#/components/schemas/Int64Field" }, "internalAuthorityId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Lightweight descriptor of an authority activity used inside other documents (e.g. as \u0060responsibleAuthorityActivity\u0060 of a waste operator). Contains just enough information to render the authority and link back to the directory." }, "AuthorityActivityIndexType": { "type": "object", "properties": { "authorityName": { "$ref": "#/components/schemas/StringField" }, "authorityAddress": { "$ref": "#/components/schemas/AddressIndexType" }, "role": { "$ref": "#/components/schemas/CodeType" }, "code": { "$ref": "#/components/schemas/CodeType" }, "status": { "$ref": "#/components/schemas/StringField" }, "unLocode": { "$ref": "#/components/schemas/CodeType" }, "appliedClassificationSectionChapter": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "appliedClassificationSection": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "appliedSuperiorAuthorityActivityId": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } }, "appliedRegionId": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } }, "appliedDocumentTypePermission": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityDomainDocumentType" } }, "controlledLocationType": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "superiorAuthorityActivityInternalId": { "$ref": "#/components/schemas/Int64Field" }, "updateDateTime": { "$ref": "#/components/schemas/TimestampField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" }, "internalAuthorityId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Compact authority-activity entry returned by \u0060FindAuthorityActivity\u0060. Bundles the search-relevant attributes of both the parent authority (name, address) and the activity (role, status, classifications) into a single flat row optimised for listing views." }, "AuthorityActivitySyncType": { "type": "object", "properties": { "authorityStatus": { "$ref": "#/components/schemas/StringField" }, "authorityUpdateDateTime": { "$ref": "#/components/schemas/TimestampField" }, "status": { "$ref": "#/components/schemas/StringField" }, "updateDateTime": { "$ref": "#/components/schemas/TimestampField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" }, "internalAuthorityId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Lightweight delta-sync entry describing the current status of an authority activity and its parent authority. Returned by \u0060GetAuthorityActivityUpdates\u0060 to let clients incrementally update their local cache without re-fetching full authority records." }, "AuthorityActivityType": { "type": "object", "properties": { "role": { "$ref": "#/components/schemas/CodeType" }, "code": { "$ref": "#/components/schemas/CodeType" }, "status": { "$ref": "#/components/schemas/StringField" }, "unLocode": { "$ref": "#/components/schemas/StringField" }, "contactDetail": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityContactDetailType" } }, "appliedClassificationSectionChapter": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "appliedClassificationSection": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "appliedSuperiorAuthorityActivityId": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } }, "appliedRegionId": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } }, "appliedDocumentTypePermission": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityDomainDocumentType" } }, "controlledLocationType": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "superiorAuthorityActivityInternalId": { "$ref": "#/components/schemas/Int64Field" }, "updateDateTime": { "$ref": "#/components/schemas/TimestampField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Single competence/activity of an authority (e.g. an authority acting as Versand-CA \u0060WSRDISP\u0060 for a given region or document type). The optional applied lists narrow the competence to specific classifications, regions, document types or controlled locations." }, "AuthorityAddressType": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/AddressType" }, "main": { "$ref": "#/components/schemas/BoolField" } }, "description": "Address entry on an authority record. \u0060main=true\u0060 marks the official seat." }, "AuthorityContactDetailType": { "type": "object", "properties": { "contactDetail": { "$ref": "#/components/schemas/ContactDetailType" }, "main": { "$ref": "#/components/schemas/BoolField" } }, "description": "Contact entry (phone, email, fax, contact role) attached to an authority or one of its activities. \u0060main=true\u0060 marks the primary contact channel." }, "AuthorityDomainDocumentType": { "type": "object", "properties": { "type": { "$ref": "#/components/schemas/CodeType" }, "accessRights": { "$ref": "#/components/schemas/StringField" } }, "description": "Per-domain access control entry of a competent authority. Combines the domain type with the granted access level (R = read-only, RW = read/write) \u2014 used to express that an authority may read or fully manage operators/permits within that domain." }, "AuthorityFindAuthorityActivityRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/FindAuthorityActivityRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "AuthorityFindAuthorityActivityResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/FindAuthorityActivityResponse" } } }, "AuthorityGetAuthorityActivityUpdatesRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAuthorityActivityUpdatesRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "AuthorityGetAuthorityActivityUpdatesResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAuthorityActivityUpdatesResponse" } } }, "AuthorityGetAuthorityByActivityRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAuthorityByActivityRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "AuthorityGetAuthorityByActivityResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAuthorityByActivityResponse" } } }, "AuthorityGetAuthorityRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAuthorityRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "AuthorityGetAuthorityResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAuthorityResponse" } } }, "AuthorityId": { "type": "object", "properties": { "role": { "type": "integer", "format": "enum" }, "number": { "type": "string", "description": "The authority number." } }, "description": "Unique identification" }, "AuthorityNameQueryType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "matchMode": { "$ref": "#/components/schemas/StringField" } }, "description": "Search criterion targeting an authority\u0027s name. \u0060matchMode\u0060 \u0060PHRASE\u0060 keeps the exact word order; \u0060FULL_TEXT\u0060 performs a tokenised full-text match." }, "AuthorityType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "status": { "$ref": "#/components/schemas/StringField" }, "address": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityAddressType" } }, "contactDetail": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityContactDetailType" } }, "activity": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityActivityType" } }, "updateDateTime": { "$ref": "#/components/schemas/TimestampField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Full authority record returned by the authority directory: legal name, addresses, contacts and the list of authority activities (each describing a competence within the waste-shipment domain such as \u0060WSRDISP\u0060)." }, "BaseSubmissionDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "allOf": [ { "$ref": "#/components/schemas/StringField" } ], "description": "WARNING: in a CreateSubmissionRequest the client MUST NOT set this field \u2014\r\n if it is set, the server responds with BAD-REQUEST-NOTIFIER.\r\n For DecisionDocumentType (authority response) this warning does NOT apply \u2014 there the field is mandatory." }, "notificationId": { "$ref": "#/components/schemas/StringField" }, "takeBackIndication": { "$ref": "#/components/schemas/BoolField" }, "illegalActivityIndication": { "$ref": "#/components/schemas/BoolField" }, "referenceNotificationId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "submission": { "$ref": "#/components/schemas/SubmissionType" }, "declarationExporter": { "$ref": "#/components/schemas/DeclarationType" }, "declarationProducer": { "type": "array", "items": { "$ref": "#/components/schemas/DeclarationType" } } }, "description": "Common payload of a notification submission. Contains the substantive Submission and the mandatory exporter and producer declarations. The \u0060user_competent_authority_domain_id\u0060 field MUST NOT be set on a CreateSubmissionRequest (the server rejects with BAD-REQUEST-NOTIFIER); it is only required when wrapped in a DecisionDocumentType." }, "Betriebsnummern": { "type": "object", "properties": { "erzeuger": { "$ref": "#/components/schemas/StringField" }, "entsorger": { "$ref": "#/components/schemas/StringField" }, "exporteur": { "$ref": "#/components/schemas/StringField" }, "importeur": { "$ref": "#/components/schemas/StringField" } } }, "BoolField": { "type": "object", "properties": { "value": { "type": "boolean" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } }, "description": "Pairs the primitive type \u0060bool\u0060 with its meta information." }, "Callback": { "type": "object", "properties": { "path": { "type": "array", "items": { "$ref": "#/components/schemas/NamedPathItem" } }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "A map of possible out-of band callbacks related to the parent operation. Each value in the map is a Path Item Object that describes a set of requests that may be initiated by the API provider and the expected responses. The key value used to identify the callback object is an expression, evaluated at runtime, that identifies a URL to use for the callback operation." }, "CallbackOrReference": { "type": "object", "properties": { "callback": { "$ref": "#/components/schemas/Callback" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "CallbacksOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedCallbackOrReference" } } } }, "CancelSubmissionResponse": { "type": "object", "properties": {} }, "CarrierTransportDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "transport": { "$ref": "#/components/schemas/TransportType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Carrier transport document recorded by the carrier when picking up the waste at the shipment origin. Documents the actual transport leg (means, vehicle, transfer date, carrier declaration) for an existing movement." }, "CarrierType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/WasteOperatorType" }, "meansOfTransportCode": { "$ref": "#/components/schemas/StringField" } }, "description": "Carrier transporting the waste. Extends WasteOperatorType with the means of transport (\u0060A\u0060=air, \u0060R\u0060=road, \u0060S\u0060=sea, \u0060T\u0060=train, \u0060W\u0060=waterways)." }, "CertificateOfCompletionType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/DeclarationType" }, "actualSiteOfDisposalOrRecovery": { "$ref": "#/components/schemas/StringField" }, "interimFacility": { "$ref": "#/components/schemas/BoolField" }, "facilityTypeCode": { "$ref": "#/components/schemas/StringField" }, "recoveryDisposalParty": { "$ref": "#/components/schemas/WasteOperatorType" }, "completionDate": { "$ref": "#/components/schemas/TimestampField" }, "reusedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "recoveredQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "disposedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "additionalInformation": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Certificate confirming that the recovery/disposal operation has been completed (field 19 of the WSR movement document). Records reused, recovered and disposed quantities and the actual site/facility on which the operation took place." }, "CertificateOfWasteReceiptBaseType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/DeclarationType" }, "recipientParty": { "$ref": "#/components/schemas/WasteOperatorType" }, "receiptDate": { "$ref": "#/components/schemas/TimestampField" }, "additionalInformation": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Common base for waste receipt certificates: who received the waste (recipient party), when, plus optional additional information. Carries the signature of the recipient party via the embedded DeclarationType." }, "CertificateOfWasteReceiptType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/CertificateOfWasteReceiptBaseType" }, "actualSiteOfDisposalOrRecovery": { "$ref": "#/components/schemas/StringField" }, "interimFacility": { "$ref": "#/components/schemas/BoolField" }, "facilityTypeCode": { "$ref": "#/components/schemas/StringField" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "acceptedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "rejectedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "rejectionDescription": { "$ref": "#/components/schemas/DescriptionType" }, "recoveryDisposalApproximateDate": { "$ref": "#/components/schemas/TimestampField" }, "recoveryDisposalTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "recoveryDisposalDescription": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Certificate confirming receipt of waste at the recovery/disposal facility (field 18 of the WSR movement document). Records the actual site of recovery/disposal, accepted vs. rejected quantities, and the planned R-/D-codes." }, "ChangeDocumentPrivacyLevelResponse": { "type": "object", "properties": {} }, "ChangePasswordRequest": { "required": [ "account", "currentPassword", "newPassword", "appToken" ], "type": "object", "properties": { "account": { "$ref": "#/components/schemas/AccountId" }, "currentPassword": { "type": "string" }, "newPassword": { "type": "string" }, "appToken": { "type": "string", "description": "Identifies the user application. The app_token is issued by the API operators per client application." } }, "description": "Password rotation payload. Authenticated by the \u0060current_password\u0060 supplied here (not by AccessToken), so an account can recover even without active tokens. \u0060app_token\u0060 identifies the consuming application context." }, "ChangePasswordResponse": { "type": "object", "properties": {}, "description": "Empty acknowledgement that the password has been rotated. Existing RefreshTokens are not automatically invalidated by this call \u2014 use \u0060RevokeRefreshToken\u0060 separately if a full session reset is desired." }, "CityDescriptorBaseType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/TextType" }, "postalCode": { "$ref": "#/components/schemas/StringField" }, "countryId": { "$ref": "#/components/schemas/IDType" }, "region": { "type": "array", "items": { "$ref": "#/components/schemas/TextType" } }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "City reference used inside DIWASS operator addresses. Combines the localised city name with a postal code, the ISO country, and an optional list of regions. An optional \u0060internalId\u0060 allows referring to a city already known to the directory." }, "CityDescriptorType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/TextType" }, "postalCode": { "$ref": "#/components/schemas/StringField" }, "countryId": { "$ref": "#/components/schemas/IDType" }, "region": { "type": "array", "items": { "$ref": "#/components/schemas/TextType" } }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "XSD: dirgeocity:CityDescriptorType" }, "CityQueryType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "postalCode": { "$ref": "#/components/schemas/StringField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "XSD: dirgeocity:CityQueryType" }, "ClientIdCredentials": { "required": [ "clientId", "clientSecret" ], "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" } }, "description": "Machine credentials issued via \u0060IssueClientId\u0060. Used by automated/headless clients in \u0060IssueRefreshToken\u0060 instead of a username/password pair. The \u0060client_secret\u0060 is only ever shown once at issue time \u2014 store it securely." }, "CodeType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "listId": { "$ref": "#/components/schemas/StringField" }, "listAgencyId": { "$ref": "#/components/schemas/StringField" }, "listAgencyName": { "$ref": "#/components/schemas/StringField" }, "listName": { "$ref": "#/components/schemas/StringField" }, "listVersionId": { "$ref": "#/components/schemas/StringField" }, "name": { "$ref": "#/components/schemas/StringField" }, "languageId": { "$ref": "#/components/schemas/StringField" }, "listUri": { "$ref": "#/components/schemas/StringField" }, "listSchemeUri": { "$ref": "#/components/schemas/StringField" } }, "description": "UN/CEFACT Unqualified Data Type representing a coded value with metadata about the code list it belongs to (list ID, name, issuing agency, version). Used wherever a value comes from a controlled vocabulary." }, "CommPartner": { "type": "object", "properties": { "active": { "$ref": "#/components/schemas/BoolField" }, "type": { "$ref": "#/components/schemas/CommTypeField" }, "language": { "$ref": "#/components/schemas/StringField" }, "address": { "$ref": "#/components/schemas/StringField" }, "name": { "$ref": "#/components/schemas/StringField" }, "authority": { "$ref": "#/components/schemas/BoolField" } }, "description": "Communication partner (ZEDAL routing)." }, "CommTypeField": { "type": "object", "properties": { "value": { "type": "integer", "format": "enum" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } } }, "CompetentAuthorityType": { "type": "object", "properties": { "partyUuid": { "$ref": "#/components/schemas/StringField" }, "competentAuthorityId": { "$ref": "#/components/schemas/StringField" } }, "description": "National or regional competent authority responsible for processing the notification in its country (issuing decisions, acknowledgements, etc.). Identified by \u0060party_uuid\u0060 and the official competent authority id." }, "CompleteSubmissionResponse": { "type": "object", "properties": {} }, "Components": { "type": "object", "properties": { "schemas": { "$ref": "#/components/schemas/SchemasOrReferences" }, "responses": { "$ref": "#/components/schemas/ResponsesOrReferences" }, "parameters": { "$ref": "#/components/schemas/ParametersOrReferences" }, "examples": { "$ref": "#/components/schemas/ExamplesOrReferences" }, "requestBodies": { "$ref": "#/components/schemas/RequestBodiesOrReferences" }, "headers": { "$ref": "#/components/schemas/HeadersOrReferences" }, "securitySchemes": { "$ref": "#/components/schemas/SecuritySchemesOrReferences" }, "links": { "$ref": "#/components/schemas/LinksOrReferences" }, "callbacks": { "$ref": "#/components/schemas/CallbacksOrReferences" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Holds a set of reusable objects for different aspects of the OAS. All objects defined within the components object will have no effect on the API unless they are explicitly referenced from properties outside the components object." }, "ConcernedCountryType": { "type": "object", "properties": { "countryId": { "$ref": "#/components/schemas/StringField" }, "competentAuthority": { "$ref": "#/components/schemas/CompetentAuthorityType" } }, "description": "A country involved in a transboundary shipment (export, import or transit) together with its competent authority. Used as the base for ExportStateType, ImportStateType and TransitStateType." }, "ConsigneeReceptionDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/CertificateOfWasteReceiptBaseType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Consignee reception document recorded when the consignee receives the waste shipment (certificate of waste receipt, base variant \u2014 used when the consignee is not itself the recovery/disposal facility)." }, "Contact": { "type": "object", "properties": { "company": { "type": "string" }, "department": { "type": "string" }, "person": { "$ref": "#/components/schemas/ContactPerson" }, "address": { "$ref": "#/components/schemas/StreetAddress" } } }, "ContactDetailType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "type": { "$ref": "#/components/schemas/StringField" }, "name": { "$ref": "#/components/schemas/StringField" }, "verified": { "$ref": "#/components/schemas/BoolField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Single contact detail entry \u2014 phone, email, fax or similar \u2014 qualified by an optional \u0060type\u0060 (e.g. \u0060phone\u0060, \u0060email\u0060) and an optional \u0060name\u0060 to label the channel (e.g. \u0060\u0022Hotline\u0022\u0060)." }, "ContactPerson": { "type": "object", "properties": { "gender": { "type": "integer", "format": "enum" }, "title": { "type": "string" }, "firstname": { "type": "string" }, "lastname": { "type": "string" }, "phone": { "type": "string" }, "email": { "type": "string" } } }, "ContactType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "telephoneCompleteNumber": { "$ref": "#/components/schemas/StringField" }, "faxCompleteNumber": { "$ref": "#/components/schemas/StringField" }, "emailUri": { "$ref": "#/components/schemas/StringField" }, "websiteUri": { "$ref": "#/components/schemas/StringField" } }, "description": "Contact information for a person or organisation acting in a DIWASS workflow. \u0060name\u0060 is mandatory; phone, fax, email and website are all optional." }, "CountryCode": { "type": "object", "properties": { "alpha2": { "type": "string" } }, "description": "define different iso 3166-1 codes, EU data model requires nummeric format" }, "CreateAnnex7Request": { "type": "object", "properties": { "announcement": { "allOf": [ { "$ref": "#/components/schemas/WasteAnnex7DocumentType" } ], "description": "No doc_xml: initial document creation." } } }, "CreateAnnex7Response": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/Document" }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" } } }, "CreateMovementTemplateApiRequest": { "type": "object", "properties": { "movementTemplate": { "allOf": [ { "$ref": "#/components/schemas/MovementTemplateType" } ], "description": "No doc_xml: initial document creation." } } }, "CreateMovementTemplateResponse": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/Document" }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" } } }, "CreateSubmissionRequest": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/SubmissionDocumentType" } }, "description": "Request to create a new notification submission. The wrapped \u0060document\u0060 carries the full SubmissionDocumentType payload. Note: \u0060document.base.userCompetentAuthorityDomainId\u0060 must NOT be set on this request \u2014 DIWASS will reject it with BAD-REQUEST-NOTIFIER." }, "CreateSubmissionResponse": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/Document" }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" } } }, "CustomsCodesType": { "type": "object", "properties": { "commodityCodes": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } } }, "description": "Added 17.06.2026 by the EU" }, "DVCode": { "type": "object", "properties": { "erzeuger": { "$ref": "#/components/schemas/StringField" }, "entsorger": { "$ref": "#/components/schemas/StringField" }, "exporteur": { "$ref": "#/components/schemas/StringField" }, "importeur": { "$ref": "#/components/schemas/StringField" } } }, "Date": { "type": "object", "properties": { "value": { "type": "string", "description": "The date value, formated as YYYY-MM-DD" } }, "description": "A date with no built-in reference to a time zone. The time zone this date refers to is given by the context it is used in." }, "DateTimeRange": { "type": "object", "properties": { "from": { "$ref": "#/components/schemas/TimestampField" }, "to": { "$ref": "#/components/schemas/TimestampField" } }, "description": "XSD: base:DateTimeRange\r\n - From: xs:dateTime (minOccurs=1, maxOccurs=1)\r\n - To: xs:dateTime (minOccurs=1, maxOccurs=1)" }, "DateianhangTyp": { "type": "object", "properties": { "diwassAttachmentId": { "$ref": "#/components/schemas/StringField" }, "filename": { "$ref": "#/components/schemas/StringField" }, "fileSize": { "$ref": "#/components/schemas/Int32Field" }, "mimeType": { "$ref": "#/components/schemas/StringField" }, "attachType": { "$ref": "#/components/schemas/StringField" }, "section": { "$ref": "#/components/schemas/StringField" }, "sectionIndex": { "$ref": "#/components/schemas/Int32Field" }, "containsPersonalData": { "$ref": "#/components/schemas/BoolField" }, "binaryData": { "type": "string", "description": "DateianhangTyp", "format": "bytes" }, "remark": { "$ref": "#/components/schemas/StringField" } }, "description": "Die Anh\u00E4nge werden direkt in Diwass abgelegt, allerdings sind weiterf\u00FChrende Daten zu einem Anhang nur im InformationType hinterlegt.\r\n In den Nachrichten mit Nutzdaten ist nur die ID abgelegt. Selbst die Dokumente die der Benutzer selbst erg\u00E4nzt hat, fehlen beim n\u00E4chsten \u00F6ffnen des XMLs\r\n diese Information. Daher wird im zedal-Bereich diese Information gespeichert, um diese pr\u00E4sent zu haben.\r\n Es werden nur die Verwaltungsinformationen vorgehalten" }, "DeadlineType": { "type": "object", "properties": { "caCode": { "$ref": "#/components/schemas/StringField" }, "operatorInternalId": { "$ref": "#/components/schemas/StringField" }, "numberOfDays": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Procedural deadline expressed as a number of working days, scoped to one competent authority. Used inside NotificationDeadlineType to publish per-CA timelines (submission, decision, invalidation, reply windows)." }, "Decimal": { "type": "object", "properties": { "units": { "type": "string", "description": "Whole units part of the amount" }, "nanos": { "type": "integer", "description": "Nano units of the amount (10^-9)\r\n Must be same sign as units", "format": "sfixed32" } }, "description": "A decimal number split into the parts before and after the decimal separator.\r\n Example: 12345.6789 -\u003E { units = 12345, nanos = 678900000 }" }, "DecisionDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "notificationDocumentId": { "$ref": "#/components/schemas/NotificationDocumentIdentifierType" }, "decision": { "$ref": "#/components/schemas/DecisionType" }, "competentAuthority": { "$ref": "#/components/schemas/CompetentAuthorityType" }, "competentAuthoritySignature": { "$ref": "#/components/schemas/SignatureType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Decision rendered by a competent authority on a specific notification document \u2014 e.g. consent, objection or update of a prior decision. The acting authority\u0027s domain role is mandatory here (unlike in the matching submission)." }, "DecisionResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationId": { "$ref": "#/components/schemas/StringField" }, "decisionId": { "$ref": "#/components/schemas/StringField" } }, "description": "Response returned by competent-authority decision operations (consent/objection). Carries the validation outcome, the NotificationId and the server-assigned DecisionId." }, "DecisionType": { "type": "object", "properties": { "decisionDate": { "$ref": "#/components/schemas/TimestampField" }, "validFromDate": { "$ref": "#/components/schemas/TimestampField" }, "validToDate": { "$ref": "#/components/schemas/TimestampField" }, "decisionType": { "$ref": "#/components/schemas/StringField" }, "specificConditions": { "$ref": "#/components/schemas/SpecificConditionsType" }, "objectionDescription": { "$ref": "#/components/schemas/DescriptionType" }, "decisionJustification": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Decision issued by a competent authority on a waste-shipment notification: CONSENT (with optional specific conditions and validity window), OBJECTED (with an objection rationale), or WITHDRAWN. Always carries a justification." }, "DeclarationType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "date": { "$ref": "#/components/schemas/StringField" }, "signature": { "$ref": "#/components/schemas/StringField" } }, "description": "Declaration block carried by an Annex VII shipment document. Captures the declarant\u0027s name, the declaration date and a signature. Reused for arranger, consignee and facility declarations." }, "DefaultType": { "type": "object", "properties": { "number": { "type": "number", "format": "double" }, "boolean": { "type": "boolean" }, "string": { "type": "string" } } }, "DeleteDocumentFromFileResponse": { "type": "object", "properties": {} }, "DeleteFileResponse": { "type": "object", "properties": {} }, "DeleteFileareaTemplateResponse": { "type": "object", "properties": {}, "description": "no message like \u0022file area template with the id xy successfully deleted\u0022?" }, "DeleteTransportTemplateResponse": { "type": "object", "properties": {} }, "DescriptionType": { "type": "object", "properties": { "description": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageDescriptionType" } } }, "description": "Multi-language free-text description. Carries one entry per language, allowing the same content to be transmitted in several languages simultaneously." }, "DiscardFinishedSubmissionResponse": { "type": "object", "properties": {} }, "Discriminator": { "type": "object", "properties": { "propertyName": { "type": "string" }, "mapping": { "$ref": "#/components/schemas/Strings" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "When request bodies or response payloads may be one of a number of different schemas, a \u0060discriminator\u0060 object can be used to aid in serialization, deserialization, and validation. The discriminator is a specific object in a schema which is used to inform the consumer of the specification of an alternative schema based on the value associated with it. When using the discriminator, _inline_ schemas will not be considered." }, "DisposalRecoveryOperations": { "type": "object", "properties": { "technologyDescription": { "$ref": "#/components/schemas/DescriptionType" }, "reasonForExportDescription": { "$ref": "#/components/schemas/DescriptionType" }, "recoveryDisposalTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } } }, "description": "Description of the planned recovery/disposal operations for a notification: the technology employed, the rationale for export, and the applicable R-/D-codes per WSR Annex IB." }, "DiwassAddressType": { "type": "object", "properties": { "arranger": { "$ref": "#/components/schemas/OperatorBaseType" }, "consignee": { "$ref": "#/components/schemas/OperatorBaseType" }, "carrier": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } }, "wasteProducer": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } }, "recoveryLaboratoryFacility": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } } }, "description": "Address block of an Annex VII waste shipment document. Lists the operators involved in the shipment: arranger, consignee, transport carriers and waste producers \u2014 all referenced as DIWASS operator base entries." }, "DiwassAnnexViiMessageType": { "type": "object", "properties": { "createAnnex7DocumentTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7DocumentType" }, "updateAnnex7DocumentTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7DocumentType" }, "createAnnex7TransportTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7TransportType" }, "updateAnnex7TransportTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7TransportType" }, "createAnnex7ConsigneeCertificateOfWasteReceiptTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7ConsigneeCertificateOfWasteReceiptType" }, "updateAnnex7ConsigneeCertificateOfWasteReceiptTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7ConsigneeCertificateOfWasteReceiptType" }, "createAnnex7FacilityCertificateOfWasteReceiptTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7CertificateOfWasteReceiptType" }, "updateAnnex7FacilityCertificateOfWasteReceiptTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7CertificateOfWasteReceiptType" }, "createAnnex7CertificateOfWasteCompletionTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7CertificateOfWasteCompletionType" }, "updateAnnex7CertificateOfWasteCompletionTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7CertificateOfWasteCompletionType" }, "createAnnex7TakeBackTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7TakeBackType" }, "updateAnnex7TakeBackTypeRequest": { "$ref": "#/components/schemas/WasteAnnex7TakeBackType" }, "createAnnex7SignalTypeRequest": { "$ref": "#/components/schemas/Annex7SignalDocumentType" }, "annex7DocumentTypeResponse": { "allOf": [ { "$ref": "#/components/schemas/Annex7DocumentResponseType" } ], "description": "Responses / fault \u2014 element names: *TypeResponse" }, "annex7MovementDocumentTypeResponse": { "$ref": "#/components/schemas/Annex7MovementDocumentResponseType" }, "wasteAnnex7ServiceFault": { "$ref": "#/components/schemas/WasteAnnex7ServiceFault" }, "getAnnex7Response": { "allOf": [ { "$ref": "#/components/schemas/Annex7InformationType" } ], "description": "GetAnnex7Response (element \u002B type retrieval:Annex7InformationType)" }, "getOperatorRequest": { "allOf": [ { "$ref": "#/components/schemas/GetOperatorRequestBaseType" } ], "description": "Operator interface" }, "getOperatorResponse": { "$ref": "#/components/schemas/GetOperatorResponseType" } }, "description": "Envelope message that wraps any single DIWASS Annex VII operation request or response into one typed payload via oneof. Used to transport individual typed Annex VII messages over the generic ZEWASS block protocol." }, "DiwassMovementAddressType": { "type": "object", "properties": { "notificationAddresses": { "allOf": [ { "$ref": "#/components/schemas/DiwassNotificationAddressType" } ], "description": "Addresses inherited from the originating notification." }, "carrierTransport": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } }, "consigneeReception": { "$ref": "#/components/schemas/OperatorBaseType" }, "facilityReception": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } }, "facilityCompletion": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } } }, "description": "Address block of a movement (transport) document. Reuses the addresses from the originating notification and adds the actual transport carriers for the individual shipment movement." }, "DiwassMovementMessageType": { "type": "object", "properties": { "createMovementTemplateRequest": { "$ref": "#/components/schemas/MovementTemplateType" }, "updateMovementTemplateRequest": { "$ref": "#/components/schemas/MovementTemplateType" }, "createCarrierTransportRequest": { "$ref": "#/components/schemas/CarrierTransportDocumentType" }, "updateCarrierTransportRequest": { "$ref": "#/components/schemas/CarrierTransportDocumentType" }, "createConsigneeReceptionRequest": { "$ref": "#/components/schemas/ConsigneeReceptionDocumentType" }, "updateConsigneeReceptionRequest": { "$ref": "#/components/schemas/ConsigneeReceptionDocumentType" }, "createFacilityReceptionRequest": { "$ref": "#/components/schemas/FacilityReceptionDocumentType" }, "updateFacilityReceptionRequest": { "$ref": "#/components/schemas/FacilityReceptionDocumentType" }, "createFacilityCompletionRequest": { "$ref": "#/components/schemas/FacilityCompletionDocumentType" }, "updateFacilityCompletionRequest": { "$ref": "#/components/schemas/FacilityCompletionDocumentType" }, "createMovementTakeBackRequest": { "$ref": "#/components/schemas/MovementTakeBackDocumentType" }, "updateMovementTakeBackRequest": { "$ref": "#/components/schemas/MovementTakeBackDocumentType" }, "movementOperationResponse": { "$ref": "#/components/schemas/MovementOperationResponse" }, "movementTemplateOperationResponse": { "$ref": "#/components/schemas/MovementTemplateOperationResponse" }, "submitMovementSignalRequest": { "$ref": "#/components/schemas/MovementSignalDocumentType" }, "submitMovementSignalResponse": { "$ref": "#/components/schemas/MovementTemplateOperationResponse" }, "getMovementResponse": { "allOf": [ { "$ref": "#/components/schemas/GetMovementResponse" } ], "description": "Retrieval (directly from DiWaSS retrieval)." }, "getOperatorRequest": { "allOf": [ { "$ref": "#/components/schemas/GetOperatorRequestBaseType" } ], "description": "Operator directory" }, "getOperatorResponse": { "$ref": "#/components/schemas/GetOperatorResponseType" }, "getNotificationResponse": { "allOf": [ { "$ref": "#/components/schemas/GetNotificationResponse" } ], "description": "In DiWaSS the movement omits data that may be needed for display, so the originating notification is included as an additional block." } }, "description": "Envelope message wrapping any single DIWASS movement operation request or response into one typed payload via oneof. Used to transport typed Movement messages over the generic ZEWASS block protocol." }, "DiwassNotificationAddressType": { "type": "object", "properties": { "notifier": { "$ref": "#/components/schemas/OperatorBaseType" }, "consignee": { "$ref": "#/components/schemas/OperatorBaseType" }, "carrier": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } }, "wasteProducer": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } }, "recoveryDisposalFacility": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } } }, "description": "Address block of a waste notification document. Lists the operators involved in the notified shipment: notifier, consignee, transport carriers and waste producers \u2014 all referenced as DIWASS operator base entries." }, "DiwassNotificationMessageType": { "type": "object", "properties": { "createSubmissionRequest": { "allOf": [ { "$ref": "#/components/schemas/SubmissionDocumentType" } ], "description": "Submission/Notification Requests" }, "updateSubmissionRequest": { "$ref": "#/components/schemas/SubmissionDocumentType" }, "submitDecisionRequest": { "$ref": "#/components/schemas/DecisionDocumentType" }, "updateDecisionRequest": { "$ref": "#/components/schemas/DecisionDocumentType" }, "decisionResponse": { "$ref": "#/components/schemas/DecisionResponseType" }, "submitAcknowledgementRequest": { "$ref": "#/components/schemas/AcknowledgementDocumentType" }, "acknowledgementResponse": { "$ref": "#/components/schemas/AcknowledgementResponseType" }, "submitRequestForInformationRequest": { "$ref": "#/components/schemas/RequestInformationDocumentType" }, "updateRequestForInformationRequest": { "$ref": "#/components/schemas/RequestInformationDocumentType" }, "requestResponse": { "$ref": "#/components/schemas/RequestResponseType" }, "submitReplyToRequestInformationRequest": { "$ref": "#/components/schemas/RequestInformationDocumentType" }, "submitReplyToRequestInformationResponse": { "$ref": "#/components/schemas/RequestResponseType" }, "submitNotificationSignalRequest": { "$ref": "#/components/schemas/NotificationSignalDocumentType" }, "submitNotificationSignalResponse": { "$ref": "#/components/schemas/NotificationSignalResponseType" }, "submissionOperationResponse": { "$ref": "#/components/schemas/SubmissionOperationResponse" }, "notificationOperationResponse": { "$ref": "#/components/schemas/NotificationOperationResponse" }, "submitRequestForChangeAfterConsentRequest": { "$ref": "#/components/schemas/RequestForChangeAfterConsentDocumentType" }, "submitRequestForChangeAfterConsentResponse": { "$ref": "#/components/schemas/RequestResponseType" }, "submitReplyToRequestForChangeAfterConsentRequest": { "$ref": "#/components/schemas/ReplyToRequestForChangeAfterConsentDocumentType" }, "submitReplyToRequestForChangeAfterConsentResponse": { "$ref": "#/components/schemas/RequestResponseType" }, "submitFacilityCompletionUnderArticle15Request": { "$ref": "#/components/schemas/FacilityCompletionUnderArticle15Type" }, "submitFacilityCompletionUnderArticle15Response": { "$ref": "#/components/schemas/FacilityCompletionUnderArticle15ResponseType" }, "getOperatorRequest": { "allOf": [ { "$ref": "#/components/schemas/GetOperatorRequestBaseType" } ], "description": "Operator directory" }, "getOperatorResponse": { "$ref": "#/components/schemas/GetOperatorResponseType" }, "lookupSyncNotificationRequest": { "allOf": [ { "$ref": "#/components/schemas/LookupSyncNotificationRequest" } ], "description": "Retrieval (directly from DiWaSS retrieval)." }, "lookupSyncNotificationResponse": { "$ref": "#/components/schemas/LookupSyncNotificationResponse" }, "getNotificationRequest": { "$ref": "#/components/schemas/GetNotificationRequest" }, "getNotificationResponse": { "$ref": "#/components/schemas/GetNotificationResponse" } }, "description": "Envelope message wrapping any single DIWASS notification operation request or response into one typed payload via oneof. Used to transport typed Notification messages over the generic ZEWASS block protocol." }, "Document": { "type": "object", "properties": { "openapi": { "type": "string" }, "info": { "$ref": "#/components/schemas/Info" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/Server" } }, "paths": { "$ref": "#/components/schemas/Paths" }, "components": { "$ref": "#/components/schemas/Components" }, "security": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRequirement" } }, "tags": { "type": "array", "items": { "$ref": "#/components/schemas/Tag" } }, "externalDocs": { "$ref": "#/components/schemas/ExternalDocs" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } } }, "DocumentId": { "type": "object", "properties": { "id": { "type": "string", "description": "Document number. Identifier for a document." } }, "description": "Document number. Identifier for a document." }, "DoubleField": { "type": "object", "properties": { "value": { "type": "number", "format": "double" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } }, "description": "Pairs the primitive type \u0060double\u0060 with its meta information." }, "Encoding": { "type": "object", "properties": { "contentType": { "type": "string" }, "headers": { "$ref": "#/components/schemas/HeadersOrReferences" }, "style": { "type": "string" }, "explode": { "type": "boolean" }, "allowReserved": { "type": "boolean" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "A single encoding definition applied to a single schema property." }, "Encodings": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedEncoding" } } } }, "Entry_JwtSession": { "type": "object", "properties": { "familyId": { "type": "string", "description": "An identifier that all tokens coming from the intial refresh token share." }, "appName": { "type": "string", "description": "The name of the app that has issued the inital refresh token." }, "createdOn": { "type": "string", "description": "The utc timestamp of when the first refresh token was issued.", "format": "date-time" }, "lastUsedOn": { "type": "string", "description": "The utc timestamp of when the last acces token was issued.", "format": "date-time" }, "expiresOn": { "type": "string", "description": "The utc timestamp of when the session will expire.", "format": "date-time" } } }, "ErrorInfo": { "type": "object", "properties": { "code": { "type": "string", "description": "Stable error code (platform-wide consistent, machine-parsable)." }, "message": { "type": "string", "description": "Human-readable error message in the respective UI language." } } }, "EventIdentifierType": { "type": "object", "properties": { "eventIdentifier": { "$ref": "#/components/schemas/StringField" } }, "description": "DIWASS event identifier wrapper used to address a single event when looking up event details." }, "Example": { "type": "object", "properties": { "summary": { "type": "string" }, "description": { "type": "string" }, "value": { "$ref": "#/components/schemas/Any" }, "externalValue": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } } }, "ExampleOrReference": { "type": "object", "properties": { "example": { "$ref": "#/components/schemas/Example" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "ExamplesOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedExampleOrReference" } } } }, "ExportCurrentDocumentResponse": { "type": "object", "properties": { "document": { "type": "string", "format": "bytes" } } }, "ExportFileareaTemplateResponse": { "required": [ "document" ], "type": "object", "properties": { "document": { "type": "string", "description": "Binary data containing the template document file.", "format": "bytes" } } }, "ExportStateType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/ConcernedCountryType" }, "exitPointName": { "$ref": "#/components/schemas/StringField" } }, "description": "State of export for a transboundary waste shipment. Extends ConcernedCountryType with the customs exit point at which the waste leaves the exporting country." }, "ExportTransportTemplateResponse": { "type": "object", "properties": { "document": { "type": "string", "description": "Binary data containing the template document file.", "format": "bytes" } } }, "Expression": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } } }, "ExternalDocs": { "type": "object", "properties": { "description": { "type": "string" }, "url": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Allows referencing an external resource for extended documentation." }, "FacilityCompletionDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "certificateOfCompletion": { "$ref": "#/components/schemas/CertificateOfCompletionType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Facility completion document (Annex IB block 19 equivalent) recorded by the recovery/disposal facility once the waste has been processed. Documents the final operation, completion date, and reused / recovered / disposed quantities." }, "FacilityCompletionUnderArticle15ResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationDocumentId": { "$ref": "#/components/schemas/NotificationDocumentIdentifierType" } }, "description": "Response returned when an interim-facility completion declaration under Article 15 WSR is submitted. Carries the validation outcome and the identifier of the resulting completion document." }, "FacilityCompletionUnderArticle15Type": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" }, "certificateId": { "$ref": "#/components/schemas/StringField" }, "recoveryDisposalParty": { "$ref": "#/components/schemas/WasteOperatorType" }, "movementIdentifier": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "completionDate": { "$ref": "#/components/schemas/TimestampField" }, "acceptedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "reusedOrRecycledQuantityArticle15": { "$ref": "#/components/schemas/QuantityArticle15Type" }, "recoveredInOtherMannerQuantityArticle15": { "$ref": "#/components/schemas/QuantityArticle15Type" }, "disposedQuantityArticle15": { "$ref": "#/components/schemas/QuantityArticle15Type" }, "wasteDesignationDescription": { "$ref": "#/components/schemas/DescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Article 15 (WSR) completion certificate \u2014 facility-side confirmation that an interim recovery/disposal step has been completed for one or more movements. Splits the accepted quantity across reused/recycled, recovered-otherwise and disposed buckets, each tagged with the matching R/D codes." }, "FacilityOperationalIndicatorsType": { "type": "object", "properties": { "interimFacility": { "$ref": "#/components/schemas/BoolField" }, "nextSubsequentInterimOrNonInterimFacilityInAnotherCountry": { "$ref": "#/components/schemas/BoolField" }, "nextSubsequentInterimOrNonInterimFacilityInSameCountry": { "$ref": "#/components/schemas/BoolField" } }, "description": "Booleans describing the operational role of a recovery/disposal facility within a chain: whether it is an interim facility, and whether the next subsequent facility is in another country or in the same country." }, "FacilityReceptionDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/CertificateOfWasteReceiptType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Facility reception document recorded by the recovery/disposal facility on arrival of the waste. Extends the consignee receipt with facility-specific data such as actual site, accepted vs rejected quantity, planned recovery/disposal date." }, "FacilityType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/WasteOperatorType" }, "operationalIndicators": { "$ref": "#/components/schemas/FacilityOperationalIndicatorsType" }, "siteDescription": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Generic waste facility, extending WasteOperatorType with operational indicators and a site description. Concrete facility types (RecoveryDisposal / Laboratory) extend this further." }, "FieldMeta": { "type": "object", "properties": { "inLayer": { "type": "boolean" } }, "description": "Meta information required on every field." }, "FileId": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for a file." } }, "description": "Identifier for a file." }, "FindAuthorityActivityRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/FindAuthorityActivityRequestType" } }, "description": "Envelope for the \u0060FindAuthorityActivity\u0060 search call." }, "FindAuthorityActivityRequestType": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/StringField" }, "authorityName": { "$ref": "#/components/schemas/AuthorityNameQueryType" }, "countryId": { "$ref": "#/components/schemas/IDType" }, "code": { "$ref": "#/components/schemas/StringField" }, "role": { "$ref": "#/components/schemas/StringField" }, "unLocode": { "$ref": "#/components/schemas/StringField" }, "applicableClassificationSectionChapter": { "$ref": "#/components/schemas/CodeType" }, "applicableClassificationSection": { "$ref": "#/components/schemas/CodeType" }, "status": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "superiorAuthorityActivityId": { "$ref": "#/components/schemas/IDType" }, "updateDateTimeRange": { "$ref": "#/components/schemas/DateTimeRange" }, "pageSize": { "$ref": "#/components/schemas/Int32Field" }, "offset": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Search request for the authority directory. \u0060countryId\u0060 is mandatory; all remaining fields are optional and combined with AND. Pagination is controlled by \u0060pageSize\u0060 (default 100) and \u0060offset\u0060." }, "FindAuthorityActivityResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/FindAuthorityActivityResponseType" } }, "description": "Envelope for the \u0060FindAuthorityActivity\u0060 paginated response." }, "FindAuthorityActivityResponseType": { "type": "object", "properties": { "authorityActivityIndex": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityActivityIndexType" } }, "pageSize": { "$ref": "#/components/schemas/Int32Field" }, "offset": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Paginated response of \u0060FindAuthorityActivity\u0060. Echoes the requested \u0060pageSize\u0060 and \u0060offset\u0060 so clients can drive the next page." }, "FindOperatorRequest": { "type": "object", "properties": { "request": { "allOf": [ { "$ref": "#/components/schemas/FindOperatorRequestType" } ], "description": "FindOperatorRequest: diroperatorv2:FindOperatorRequestType" } }, "description": "XSD-Element: diroperatorv2:FindOperatorResponse\r\n - type diroperatorbase:FindOperatorResponseBaseType" }, "FindOperatorRequestBaseType": { "type": "object", "properties": { "query": { "$ref": "#/components/schemas/StringField" }, "name": { "$ref": "#/components/schemas/OperatorNameQueryBaseType" }, "activityStatus": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "countryId": { "$ref": "#/components/schemas/IDType" }, "city": { "$ref": "#/components/schemas/CityQueryType" }, "region": { "$ref": "#/components/schemas/RegionQueryType" }, "identifier": { "$ref": "#/components/schemas/OperatorIdentifierQueryBaseType" }, "activity": { "$ref": "#/components/schemas/OperatorActivityQueryBaseType" }, "responsibleAuthorityActivity": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorAuthorityActivityQueryBaseType" } }, "createDateTimeRange": { "$ref": "#/components/schemas/DateTimeRange" }, "updateDateTimeRange": { "$ref": "#/components/schemas/DateTimeRange" }, "sortPredicate": { "$ref": "#/components/schemas/StringField" }, "sortAscending": { "$ref": "#/components/schemas/BoolField" }, "pageSize": { "$ref": "#/components/schemas/Int32Field" }, "offset": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Search request for the operator directory. All criteria are optional and combined with logical AND. Pagination is controlled by \u0060pageSize\u0060 (default 100) and \u0060offset\u0060; sorting by \u0060sortPredicate\u0060 / \u0060sortAscending\u0060." }, "FindOperatorRequestType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/FindOperatorRequestBaseType" }, "groupId": { "$ref": "#/components/schemas/Int64Field" }, "linkedOperatorInternalId": { "$ref": "#/components/schemas/Int64Field" }, "assignedResponsibleAuthorityActivity": { "$ref": "#/components/schemas/OperatorAuthorityActivityQueryBaseType" } }, "description": "---------------------------------------------------------------------\r\n FindOperatorRequest / FindOperatorResponse\r\n ---------------------------------------------------------------------\r\n XSD-Element: diroperatorv2:FindOperatorRequest\r\n - type diroperatorv2:FindOperatorRequestType\r\n XSD: FindOperatorRequestType (extension of FindOperatorRequestBaseType)\r\n - choice(GroupID | LinkedOperatorInternalID), minOccurs=0, maxOccurs=1 (MUTUAL EXCLUSION)\r\n - AssignedResponsibleAuthorityActivity: OperatorAuthorityActivityQueryBaseType (optional)" }, "FindOperatorResponse": { "type": "object", "properties": { "response": { "allOf": [ { "$ref": "#/components/schemas/FindOperatorResponseBaseType" } ], "description": "FindOperatorResponse: diroperatorbase:FindOperatorResponseBaseType" } } }, "FindOperatorResponseBaseType": { "type": "object", "properties": { "operatorIndex": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorIndexBaseType" } }, "pageSize": { "$ref": "#/components/schemas/Int32Field" }, "offset": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Paginated response of \u0060FindOperator\u0060. Echoes the requested \u0060pageSize\u0060 and \u0060offset\u0060 so that the caller can drive the next page; an empty list signals that no further results exist." }, "GetAcknowledgementDocumentType": { "type": "object", "properties": { "caCode": { "$ref": "#/components/schemas/StringField" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "acknowledgementId": { "$ref": "#/components/schemas/StringField" }, "acknowledgement": { "$ref": "#/components/schemas/AcknowledgementType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } }, "signature": { "$ref": "#/components/schemas/SignatureType" } }, "description": "Retrieval view of a CA acknowledgement document (properly carried out / properly completed) confirming receipt or completeness of a notification. Carries the issuing CA context, the acknowledgement payload, optional attachments and signature." }, "GetAllAnnex7Request": { "type": "object", "properties": { "fromDate": { "$ref": "#/components/schemas/TimestampField" }, "toDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Request for the GetAllAnnex7 operation. Lists all Annex VII shipments whose submission / last-update dates fall within the given date range." }, "GetAllAnnex7Response": { "type": "object", "properties": { "annex7List": { "type": "array", "items": { "$ref": "#/components/schemas/MovementModificationDetailsType" } } }, "description": "Response of the GetAllAnnex7 operation: a list of Annex VII shipment summaries (identifier \u002B submission / last-update timestamps) within the requested date range." }, "GetAllMovementsRequest": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" } }, "description": "Request for the GetAllMovements operation. Lists all movements that belong to the given notification." }, "GetAllMovementsResponse": { "type": "object", "properties": { "movementList": { "type": "array", "items": { "$ref": "#/components/schemas/MovementModificationDetailsType" } } }, "description": "Response of the GetAllMovements operation: a list of movement summaries (identifier \u002B submission / last-update timestamps) for the requested notification." }, "GetAnnex7Request": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" } } }, "GetAnnex7Response": { "type": "object", "properties": { "annexvii": { "$ref": "#/components/schemas/AnnexViiDocument" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "transferHistory": { "type": "array", "items": { "$ref": "#/components/schemas/TransferEntry" } } } }, "GetAuthorityActivityUpdatesRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAuthorityActivityUpdatesRequestType" } }, "description": "Envelope for the \u0060GetAuthorityActivityUpdates\u0060 delta-sync call." }, "GetAuthorityActivityUpdatesRequestType": { "type": "object", "properties": { "authorityActivityStatus": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "authorityActivityRole": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "countryId": { "$ref": "#/components/schemas/IDType" }, "updateDateTimeRange": { "$ref": "#/components/schemas/DateTimeRange" }, "pageSize": { "$ref": "#/components/schemas/Int32Field" }, "offset": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Delta-sync request: returns authority activities changed within the given \u0060updateDateTimeRange\u0060, scoped by country and optionally by status/role. Used by client apps to keep a local copy of the authority directory in sync." }, "GetAuthorityActivityUpdatesResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAuthorityActivityUpdatesResponseType" } }, "description": "Envelope for the \u0060GetAuthorityActivityUpdates\u0060 response." }, "GetAuthorityActivityUpdatesResponseType": { "type": "object", "properties": { "authorityActivitySync": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityActivitySyncType" } }, "pageSize": { "$ref": "#/components/schemas/Int32Field" }, "offset": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Paginated delta-sync response listing the authority activities that changed in the requested timestamp window." }, "GetAuthorityByActivityRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAuthorityByActivityRequestType" } }, "description": "Envelope for the \u0060GetAuthorityByActivity\u0060 call: returns the authorities owning the supplied authority-activity ids." }, "GetAuthorityByActivityRequestType": { "type": "object", "properties": { "id": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } } }, "description": "Request payload for \u0060GetAuthorityByActivity\u0060. Looks up authority records by the internal id of one of their activities (max 50 ids per call)." }, "GetAuthorityByActivityResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAuthorityByActivityResponseType" } }, "description": "Envelope for the \u0060GetAuthorityByActivity\u0060 response." }, "GetAuthorityByActivityResponseType": { "type": "object", "properties": { "authority": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityType" } } }, "description": "Response payload for \u0060GetAuthorityByActivity\u0060 carrying the owning authority records." }, "GetAuthorityRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAuthorityRequestType" } }, "description": "Envelope for the \u0060GetAuthority\u0060 web-service call. Wraps the actual request payload to mirror the XSD element/type split." }, "GetAuthorityRequestType": { "type": "object", "properties": { "id": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } } }, "description": "Request payload for \u0060GetAuthority\u0060. Resolves up to 50 authority records by their internal ids." }, "GetAuthorityResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAuthorityResponseType" } }, "description": "Envelope for the \u0060GetAuthority\u0060 web-service response." }, "GetAuthorityResponseType": { "type": "object", "properties": { "authority": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityType" } } }, "description": "Response payload for \u0060GetAuthority\u0060 carrying the resolved authority records." }, "GetCarrierTransportDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "transport": { "$ref": "#/components/schemas/TransportType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a carrier transport document for a notified movement: identifies the movement and carries the transport details (carrier, planned start, transport means, route)." }, "GetConsigneeAnnex7CertificateOfWasteReceiptType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/CertificateOfWasteReceiptBaseType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a consignee certificate of waste receipt for an Annex VII shipment, attesting receipt of the waste at the consignee site." }, "GetConsigneeReceptionDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/CertificateOfWasteReceiptBaseType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a consignee reception document: certificate of waste receipt issued by the consignee for a notified movement, attesting receipt of the shipment." }, "GetDecisionDocumentType": { "type": "object", "properties": { "caCode": { "$ref": "#/components/schemas/StringField" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "decisionId": { "$ref": "#/components/schemas/StringField" }, "decision": { "$ref": "#/components/schemas/DecisionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a CA decision (consent / objection / conditional consent) on a notification. Carries the issuing CA, the decision payload, optional signature and supporting attachments." }, "GetDocumentByIdentResponse": { "type": "object", "properties": { "docIds": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentId" } } } }, "GetDocumentParameterResponse": { "type": "object", "properties": { "value": { "type": "string" } } }, "GetDocumentParticipantResponse": { "type": "object", "properties": { "bmuId": { "$ref": "#/components/schemas/AuthorityId" }, "address": { "$ref": "#/components/schemas/Address" } } }, "GetDocumentRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" } } }, "GetDocumentResponse": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/Document" } } }, "GetFacilityAnnex7CertificateOfWasteReceiptType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/Annex7CertificateOfWasteReceiptType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a facility certificate of waste receipt for an Annex VII shipment, attesting receipt at the recovery / laboratory facility (Annex VII variant)." }, "GetFacilityCompletionDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "certificateOfCompletion": { "$ref": "#/components/schemas/CertificateOfCompletionType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a facility completion document: certificate of completion issued by the recovery / disposal facility, attesting that the operation on the received waste has been completed." }, "GetFacilityCompletionUnderArticle15": { "type": "object", "properties": { "recoveryDisposalParty": { "$ref": "#/components/schemas/WasteOperatorType" }, "certificateId": { "$ref": "#/components/schemas/StringField" }, "movementIdentifier": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "facilityTypeCode": { "$ref": "#/components/schemas/StringField" }, "interimFacility": { "$ref": "#/components/schemas/BoolField" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "completionDate": { "$ref": "#/components/schemas/TimestampField" }, "acceptedQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "reusedQuantityArticle15": { "$ref": "#/components/schemas/QuantityArticle15Type" }, "recoveredQuantityArticle15": { "$ref": "#/components/schemas/QuantityArticle15Type" }, "disposedQuantityArticle15": { "$ref": "#/components/schemas/QuantityArticle15Type" }, "wasteDesignationDescription": { "$ref": "#/components/schemas/DescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Article-15 facility-completion certificate issued by an interim recovery / disposal facility, attesting that the waste of one or more movements has been processed. Aggregates accepted, reused, recovered and disposed quantities together with classification and signature." }, "GetFacilityReceptionDocumentType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/CertificateOfWasteReceiptType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a facility reception document: certificate of waste receipt issued by the recovery / disposal facility for a notified movement." }, "GetFileByRefIdResponse": { "type": "object", "properties": { "fileId": { "$ref": "#/components/schemas/FileId" } } }, "GetGlobalParameterResponse": { "type": "object", "properties": { "value": { "type": "string", "description": "Value of the parameter." } } }, "GetMovementRequest": { "type": "object", "properties": { "movementId": { "$ref": "#/components/schemas/MovementIdentifierType" } }, "description": "Request for the GetMovement operation. Identifies the movement by its DIWASS movement identifier." }, "GetMovementResponse": { "type": "object", "properties": { "movementInformation": { "$ref": "#/components/schemas/MovementInformationType" } }, "description": "Response of the GetMovement operation: the aggregated MovementInformationType view of the requested movement (announcement plus all derived documents)." }, "GetMovementTakeBackDocumentType": { "type": "object", "properties": { "caCode": { "$ref": "#/components/schemas/StringField" }, "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "movementTakeBack": { "$ref": "#/components/schemas/MovementTakeBackType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a movement take-back document: a notified movement that had to be returned (e.g. consignee did not accept the waste). Carries the issuing CA, the movement identifier and the take-back payload." }, "GetMovementTemplateType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementIdentifierType" }, "movementStatus": { "$ref": "#/components/schemas/StringField" }, "movementDocumentDueToTakeBack": { "$ref": "#/components/schemas/BoolField" }, "movementDocumentsDueToIllegalActivity": { "$ref": "#/components/schemas/BoolField" }, "movementReferenceIdentifier": { "$ref": "#/components/schemas/MovementIdentifierType" }, "template": { "$ref": "#/components/schemas/MovementDocumentType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a movement announcement / template under a notification: identifies the movement, its lifecycle status, take-back / illegal-activity flags and the underlying movement document." }, "GetNotificationMonitoringDataResponse": { "type": "object", "properties": { "aggregatedData": { "$ref": "#/components/schemas/GetNotificationMonitoringDataResponse_Aggregated" }, "limits": { "$ref": "#/components/schemas/GetNotificationMonitoringDataResponse_Limits" }, "warningLimits": { "$ref": "#/components/schemas/GetNotificationMonitoringDataResponse_WarningLimits" }, "deBmuSmallAndSmallestAmount": { "$ref": "#/components/schemas/GetNotificationMonitoringDataResponse_DeBmuSmallAndSmallestAmount" }, "warningReactionConfig": { "allOf": [ { "$ref": "#/components/schemas/GetNotificationMonitoringDataResponse_WarningReactionConfig" } ], "description": "User configured actions that should be taken if limits or warning limits are met." }, "notificationBasedMonitoringEnabled": { "type": "boolean", "description": "Show whether or not notification based monitoring operations (weight, number of transports, ...) are enabled." } } }, "GetNotificationMonitoringDataResponse_Aggregated": { "type": "object", "properties": { "tpWeightPerNotification": { "$ref": "#/components/schemas/Decimal" }, "tpWeightPerGeneratorAndWasteCodeThisYear": { "$ref": "#/components/schemas/Decimal" }, "numberOfTransportsPerNotification": { "type": "integer", "format": "int32" }, "numberOfActiveTransports": { "type": "integer", "format": "int32" }, "monitoringWeightOffset": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "Offset aggregated weight against the limit by this amount. E.g. when some transports are not\r\n in the electronic monitoring system." } } }, "GetNotificationMonitoringDataResponse_DeBmuSmallAndSmallestAmount": { "type": "object", "properties": { "allowedWeight": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "The maximum weight allowed for this transport." }, "smallAmountMonitoringEnabled": { "type": "boolean", "description": "Show whether or not 20T monitoring is enabled. Works independently of the global notification_based_monitoring_enabled flag." }, "warningWeightSmallAmount": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "User configured warning weight." }, "smallestAmountMonitoringEnabled": { "type": "boolean", "description": "Show whether or not 2T monitoring is enabled. Works independently of the global notification_based_monitoring_enabled flag." }, "warningWeightSmallestAmount": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "User configured warning weight." } } }, "GetNotificationMonitoringDataResponse_Limits": { "type": "object", "properties": { "allowedWeight": { "$ref": "#/components/schemas/Decimal" }, "validFrom": { "$ref": "#/components/schemas/Date" }, "validTo": { "$ref": "#/components/schemas/Date" }, "allowedNumberOfTransports": { "type": "integer", "format": "int32" }, "numberOfFinanciallyInsuredTransports": { "type": "integer", "format": "int32" } } }, "GetNotificationMonitoringDataResponse_WarningLimits": { "type": "object", "properties": { "weightPercent": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "Warn when this percentage of the allowed weight is reached." }, "daysBeforeExpiration": { "type": "integer", "description": "Warn this number of days before the notification expires.", "format": "int32" }, "numberOfTransportsPercent": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "Warn when this percentage of the number of allowed transports is reached." }, "numberOfFinanciallyInsuredTransportsBeforeLimit": { "type": "integer", "format": "int32" } } }, "GetNotificationMonitoringDataResponse_WarningReactionConfig": { "type": "object", "properties": { "weightExceeded": { "type": "integer", "format": "enum" }, "warningWeightExceeded": { "type": "integer", "format": "enum" }, "validityPeriodExceeded": { "type": "integer", "format": "enum" }, "warningPeriodExceeded": { "type": "integer", "format": "enum" }, "numberOfTransportsExceeded": { "type": "integer", "format": "enum" }, "warningNumberOfTransportsExceeded": { "type": "integer", "format": "enum" }, "numberOfFinanciallyInsuredTransportsExceeded": { "type": "integer", "format": "enum" }, "warningNumberOfFinanciallyInsuredTransportsExceeded": { "type": "integer", "format": "enum" } } }, "GetNotificationRequest": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" } }, "description": "Request for the GetNotification operation. Identifies a notification by its DIWASS identifier." }, "GetNotificationResponse": { "type": "object", "properties": { "notificationInformation": { "$ref": "#/components/schemas/NotificationInformationType" } }, "description": "Response of the GetNotification operation: the aggregated NotificationInformationType view of the requested notification (status plus all linked documents)." }, "GetOperatorRequest": { "type": "object", "properties": { "request": { "allOf": [ { "$ref": "#/components/schemas/GetOperatorRequestBaseType" } ], "description": "request: diroperatorbase:GetOperatorRequestBaseType" } }, "description": "---------------------------------------------------------------------\r\n GetOperatorRequest / GetOperatorResponse\r\n ---------------------------------------------------------------------\r\n XSD-Element: diroperatorv2:GetOperatorRequest\r\n - type diroperatorbase:GetOperatorRequestBaseType" }, "GetOperatorRequestBaseType": { "type": "object", "properties": { "id": { "type": "array", "items": { "$ref": "#/components/schemas/Int64Field" } } }, "description": "Request body for an operator lookup by directory id. Up to 50 internal operator ids may be passed in a single call; the server returns the matching operator records (or an exception if any id is unknown / forbidden)." }, "GetOperatorResponse": { "type": "object", "properties": { "response": { "allOf": [ { "$ref": "#/components/schemas/GetOperatorResponseType" } ], "description": "GetOperatorResponse: diroperatorv2:GetOperatorResponseType" } }, "description": "XSD-Element: diroperatorv2:GetOperatorResponse\r\n - type diroperatorv2:GetOperatorResponseType" }, "GetOperatorResponseType": { "type": "object", "properties": { "operatorDetails": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorWithDetailsType" }, "description": "OperatorDetails: OperatorWithDetailsType (1..*)" } }, "description": "XSD-Typ: diroperatorv2:GetOperatorResponseType\r\n - OperatorDetails: OperatorWithDetailsType (1..*)" }, "GetReplyToRequestForChangeAfterConsentDocumentType": { "type": "object", "properties": { "requestForChangeAfterConsentId": { "$ref": "#/components/schemas/StringField" }, "replyRequestForChangeAfterConsentId": { "$ref": "#/components/schemas/StringField" }, "replyDate": { "$ref": "#/components/schemas/TimestampField" }, "caCode": { "$ref": "#/components/schemas/StringField" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "agreementChangeRouteRequest": { "$ref": "#/components/schemas/BoolField" }, "reasons": { "$ref": "#/components/schemas/LanguageDescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a CA reply to a notifier\u0027s request-for-change-after-consent. Carries the agreement decision on the change-route request, optional reasons, signature and attachments." }, "GetRequestForChangeAfterConsentDocumentType": { "type": "object", "properties": { "requestForChangeAfterConsentId": { "$ref": "#/components/schemas/StringField" }, "requestForChangeDate": { "$ref": "#/components/schemas/TimestampField" }, "requestForChangeStatus": { "$ref": "#/components/schemas/StringField" }, "changeRouteRequest": { "$ref": "#/components/schemas/BoolField" }, "requestDescription": { "$ref": "#/components/schemas/LanguageDescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a notifier-issued request to change parameters of an already-consented notification (e.g. updated route, dates). Carries status, optional change-route flag, multilingual description, signature and attachments." }, "GetRequestInformationDocumentType": { "type": "object", "properties": { "caCode": { "$ref": "#/components/schemas/StringField" }, "requestInformationId": { "$ref": "#/components/schemas/StringField" }, "replyRequestInformationId": { "$ref": "#/components/schemas/StringField" }, "dateRequestReply": { "$ref": "#/components/schemas/TimestampField" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "additionalDaysToReply": { "$ref": "#/components/schemas/Int32Field" }, "statement": { "$ref": "#/components/schemas/DescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "deadlineAdditionalInfoRequest": { "$ref": "#/components/schemas/DeadlineType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of an additional-information request (CA -\u003E notifier) or its reply (notifier -\u003E CA). The same message shape covers both directions; replyRequestInformationId/dateRequestReply distinguish the reply variant. Carries the statement, signature, optional attachments and an optional new deadline." }, "GetSignalDocumentType": { "type": "object", "properties": { "signalId": { "$ref": "#/components/schemas/StringField" }, "caCode": { "$ref": "#/components/schemas/StringField" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "signalDate": { "$ref": "#/components/schemas/TimestampField" }, "signal": { "$ref": "#/components/schemas/SignalStatementType" }, "description": { "$ref": "#/components/schemas/DescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of a signal document \u2014 a CA-issued lifecycle event such as PROPERLY_CARRIED_OUT, COMPLETE_NOTIFICATION, NOTIFICATION_INVALID, REVALIDATED or CANCEL_NOTIFICATION. Carries the issuing CA, the signal payload, optional description, signature and attachments." }, "GetSubmissionDocumentType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/BaseSubmissionDocumentType" }, "submitDate": { "$ref": "#/components/schemas/TimestampField" }, "eligibleForPreConsent": { "$ref": "#/components/schemas/BoolField" }, "shipmentsSubjectToTakeBack": { "$ref": "#/components/schemas/Int32Field" }, "referenceNotificationsNumber": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "notificationDeadline": { "$ref": "#/components/schemas/NotificationDeadlineType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of the original notification submission. Wraps the BaseSubmissionDocument plus DIWASS-side metadata (submit date, pre-consent eligibility, take-back shipments, related notifications, computed deadlines and attachments)." }, "GetTransportDocumentByIdentResponse": { "type": "object", "properties": { "docId": { "$ref": "#/components/schemas/DocumentId" } } }, "GetWasteAnnex7CertificateOfWasteCompletionType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "certificateOfWasteCompletion": { "$ref": "#/components/schemas/Annex7CertificateOfCompletionType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of an Annex VII certificate of waste completion: confirmation that the recovery / laboratory operation on the received waste has been completed." }, "GetWasteAnnex7DocumentType": { "type": "object", "properties": { "annexViiDocumentNo": { "$ref": "#/components/schemas/StringField" }, "documentStatus": { "$ref": "#/components/schemas/StringField" }, "announcementDate": { "$ref": "#/components/schemas/TimestampField" }, "takeBackIndication": { "$ref": "#/components/schemas/BoolField" }, "illegalActivityIndication": { "$ref": "#/components/schemas/BoolField" }, "referenceNotificationNo": { "$ref": "#/components/schemas/StringField" }, "referenceMovementNo": { "$ref": "#/components/schemas/StringField" }, "referenceAnnexViiDocumentNo": { "$ref": "#/components/schemas/StringField" }, "shipmentArrangerIsAlsoProducerOrCollector": { "$ref": "#/components/schemas/BoolField" }, "transportAnnouncement": { "$ref": "#/components/schemas/Annex7TransportAnnouncementType" }, "declarationArranger": { "$ref": "#/components/schemas/DeclarationType" }, "declarationProducer": { "type": "array", "items": { "$ref": "#/components/schemas/DeclarationType" } }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Annex VII announcement document for a shipment of non-notifiable waste under the Waste Shipment Regulation. Carries lifecycle status, take-back / illegal-activity indicators, transport announcement plus declarations of the shipment arranger and producers." }, "GetWasteAnnex7TakeBackType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "quantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "statement": { "$ref": "#/components/schemas/DescriptionType" }, "takeBackDate": { "$ref": "#/components/schemas/TimestampField" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of an Annex VII take-back declaration: documents the return of waste that could not be received as planned, including quantity, statement and take-back date." }, "GetWasteAnnex7TransportType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "transport": { "$ref": "#/components/schemas/TransportType" }, "attachments": { "type": "array", "items": { "$ref": "#/components/schemas/AttachInfoType" } } }, "description": "Retrieval view of an Annex VII transport document: identifies the Annex VII shipment and carries the actual transport details (carrier, dates, route, vehicle)." }, "GoogleProtobufAny": { "type": "object", "properties": { "@type": { "type": "string", "description": "The type of the serialized message." } }, "additionalProperties": true, "description": "Contains an arbitrary serialized message along with a @type that describes the type of the serialized message." }, "Header": { "type": "object", "properties": { "description": { "type": "string" }, "required": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "allowEmptyValue": { "type": "boolean" }, "style": { "type": "string" }, "explode": { "type": "boolean" }, "allowReserved": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/SchemaOrReference" }, "example": { "$ref": "#/components/schemas/Any" }, "examples": { "$ref": "#/components/schemas/ExamplesOrReferences" }, "content": { "$ref": "#/components/schemas/MediaTypes" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "The Header Object follows the structure of the Parameter Object with the following changes: 1. \u0060name\u0060 MUST NOT be specified, it is given in the corresponding \u0060headers\u0060 map. 1. \u0060in\u0060 MUST NOT be specified, it is implicitly in \u0060header\u0060. 1. All traits that are affected by the location MUST be applicable to a location of \u0060header\u0060 (for example, \u0060style\u0060)." }, "HeaderOrReference": { "type": "object", "properties": { "header": { "$ref": "#/components/schemas/Header" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "HeadersOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedHeaderOrReference" } } } }, "IDType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "schemeId": { "$ref": "#/components/schemas/StringField" }, "schemeName": { "$ref": "#/components/schemas/StringField" }, "schemeAgencyId": { "$ref": "#/components/schemas/StringField" }, "schemeAgencyName": { "$ref": "#/components/schemas/StringField" }, "schemeVersionId": { "$ref": "#/components/schemas/StringField" }, "schemeDataUri": { "$ref": "#/components/schemas/StringField" }, "schemeUri": { "$ref": "#/components/schemas/StringField" } }, "description": "UN/CEFACT Unqualified Data Type representing an identifier together with metadata about the scheme it belongs to (scheme ID, name, issuing agency, version, URIs). Used wherever an opaque ID must carry its issuing context." }, "ImportStateType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/ConcernedCountryType" }, "entryPointName": { "$ref": "#/components/schemas/StringField" } }, "description": "State of import for a transboundary waste shipment. Extends ConcernedCountryType with the customs entry point at which the waste enters the importing country." }, "Info": { "type": "object", "properties": { "title": { "type": "string" }, "description": { "type": "string" }, "termsOfService": { "type": "string" }, "contact": { "$ref": "#/components/schemas/Contact" }, "license": { "$ref": "#/components/schemas/License" }, "version": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } }, "summary": { "type": "string" } }, "description": "The object provides metadata about the API. The metadata MAY be used by the clients if needed, and MAY be presented in editing or documentation generation tools for convenience." }, "Int32Field": { "type": "object", "properties": { "value": { "type": "integer", "format": "int32" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } }, "description": "Pairs the primitive type \u0060int32\u0060 with its meta information." }, "Int64Field": { "type": "object", "properties": { "value": { "type": "string" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } } }, "IssueClientIdRequest": { "required": [ "usernameCredentials" ], "type": "object", "properties": { "clientDescription": { "type": "string", "description": "A descriptive string that helps the user identify the client he issued this client_id for." }, "usernameCredentials": { "allOf": [ { "$ref": "#/components/schemas/UsernameCredentials" } ], "description": "Identifies the user application. The app_token is issued by the API operators per client application." } }, "description": "Issues a machine credential bound to a human account. The caller proves ownership via \u0060UsernameCredentials\u0060 (not via AccessToken) and gets back a \u0060client_id\u0060/\u0060client_secret\u0060 pair that can be used for unattended logins." }, "IssueClientIdResponse": { "type": "object", "properties": { "clientId": { "type": "string" }, "clientSecret": { "type": "string" } }, "description": "Returns the newly issued machine credentials. \u0060client_secret\u0060 is only visible here \u2014 it is **not** returned by \u0060ListClientIds\u0060 afterwards. Store securely." }, "IssueRefreshTokenRequest": { "required": [ "appToken" ], "type": "object", "properties": { "appToken": { "type": "string", "description": "Identifies the user application. The app_token is issued by the API operators per client application." }, "usernameCredentials": { "$ref": "#/components/schemas/UsernameCredentials" }, "clientIdCredentials": { "$ref": "#/components/schemas/ClientIdCredentials" } }, "description": "Login payload. Carries the application identifier (\u0060app_token\u0060, provider-issued, identifies the consumer application and determines its allowed scopes) and exactly one credential variant: human (\u0060UsernameCredentials\u0060) or machine (\u0060ClientIdCredentials\u0060)." }, "IssueRefreshTokenResponse": { "type": "object", "properties": { "refreshToken": { "type": "string" } }, "description": "Login response \u2014 returns the long-lived RefreshToken (JWT). Use this token as input for \u0060RequestAccess\u0060 to obtain short-lived AccessTokens. The RefreshToken rotates on every \u0060RequestAccess\u0060 call." }, "ItemsItem": { "type": "object", "properties": { "schemaOrReference": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaOrReference" } } } }, "LanguageDescriptionType": { "type": "object", "properties": { "text": { "$ref": "#/components/schemas/StringField" }, "languageId": { "$ref": "#/components/schemas/StringField" } }, "description": "Single language-tagged piece of free text. Used as a building block for DescriptionType to model multi-language descriptions across DIWASS documents." }, "License": { "type": "object", "properties": { "name": { "type": "string" }, "url": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "License information for the exposed API." }, "Link": { "type": "object", "properties": { "operationRef": { "type": "string" }, "operationId": { "type": "string" }, "parameters": { "$ref": "#/components/schemas/AnyOrExpression" }, "requestBody": { "$ref": "#/components/schemas/AnyOrExpression" }, "description": { "type": "string" }, "server": { "$ref": "#/components/schemas/Server" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "The \u0060Link object\u0060 represents a possible design-time link for a response. The presence of a link does not guarantee the caller\u0027s ability to successfully invoke it, rather it provides a known relationship and traversal mechanism between responses and other operations. Unlike _dynamic_ links (i.e. links provided **in** the response payload), the OAS linking mechanism does not require link information in the runtime response. For computing links, and providing instructions to execute them, a runtime expression is used for accessing values in an operation and using them as parameters while invoking the linked operation." }, "LinkOrReference": { "type": "object", "properties": { "link": { "$ref": "#/components/schemas/Link" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "LinkedAttachType": { "type": "object", "properties": { "attachmentIdentifier": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } } }, "description": "Reference to one or more attachments (by external identifier) linked to a DIWASS document, without inlining their binary content." }, "LinksOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedLinkOrReference" } } } }, "ListAddressesResponse": { "type": "object", "properties": { "entry": { "type": "array", "items": { "$ref": "#/components/schemas/AddressEntry" } } } }, "ListAllSubmissionsResponse": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "$ref": "#/components/schemas/FileId" } } } }, "ListClientIdsResponse": { "type": "object", "properties": { "entry": { "type": "array", "items": { "$ref": "#/components/schemas/ListClientIdsResponse_Entry" } } }, "description": "All currently issued machine credentials of the calling account, returned without the \u0060client_secret\u0060 (only available at issue time)." }, "ListClientIdsResponse_Entry": { "type": "object", "properties": { "tokenId": { "type": "string", "description": "An identifier of this client id." }, "description": { "type": "string", "description": "The description the user entered when issuing this client id." }, "createdOn": { "type": "string", "description": "The utc timestamp of when the client id was issued.", "format": "date-time" } } }, "ListCompletedSubmissionsResponse": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "$ref": "#/components/schemas/FileId" } } } }, "ListDocumentsByParametersResponse": { "type": "object", "properties": { "docIds": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentId" } } } }, "ListDocumentsResponse": { "type": "object", "properties": { "documents": { "type": "array", "items": { "$ref": "#/components/schemas/ListDocumentsResponse_Entry" } } } }, "ListDocumentsResponse_Entry": { "type": "object", "properties": { "docId": { "$ref": "#/components/schemas/DocumentId" } }, "description": "Wrapper message to allow for compatible future extensions (e.g. more information about the document)." }, "ListInboxResponse": { "type": "object", "properties": { "docIds": { "type": "array", "items": { "$ref": "#/components/schemas/DocumentId" } } } }, "ListNewSubmissionsResponse": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "$ref": "#/components/schemas/FileId" } } } }, "ListProviderResponse": { "type": "object", "properties": { "provider": { "type": "array", "items": { "$ref": "#/components/schemas/Provider" } } } }, "ListRejectedSubmissionsResponse": { "type": "object", "properties": { "fileIds": { "type": "array", "items": { "$ref": "#/components/schemas/FileId" } } } }, "ListSessionsResponse": { "type": "object", "properties": { "entry": { "type": "array", "items": { "$ref": "#/components/schemas/ListSessionsResponse_Entry" } } }, "description": "All currently active sessions (RefreshToken families) of the calling account. Each entry exposes the family identifier (used by \u0060RevokeRefreshToken\u0060 to log out one session) plus issuance/last-use/expiry timestamps." }, "ListSessionsResponse_Entry": { "type": "object", "properties": { "jwtSession": { "$ref": "#/components/schemas/Entry_JwtSession" } } }, "ListTransportDocumentResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransportDocumentResponse_Entry" }, "description": "result list" }, "total": { "type": "integer", "format": "int32" } } }, "ListTransportDocumentResponse_Entry": { "type": "object", "properties": { "documentId": { "$ref": "#/components/schemas/DocumentId" }, "lastChanged": { "type": "string", "description": "The timestamp the document was created at.\r\n google.protobuf.Timestamp created_at = 3; // UTC (Systemzeit)\r\n The timestamp the document was last edited at.", "format": "date-time" }, "cancelled": { "type": "boolean", "description": "Cancellation flag." }, "documentType": { "type": "string", "description": "Document type." }, "previewElectronicSignatures": { "type": "string", "description": "Signatures ? f_signatur ?" }, "fVorgang": { "type": "string", "description": "\u003EEDOK overview fields" }, "fKurzinfo": { "type": "string" }, "notificationId": { "type": "string", "description": "\u0060Notifizierung\u0060 (notification number)." }, "wasteProducerNumber": { "type": "string", "description": "Producer" }, "wasteProducerName1": { "type": "string" }, "wasteProducerName2": { "type": "string" }, "wasteProducerCity1": { "type": "string" }, "fErzeugerplz": { "type": "string" }, "wasteProducerStreet1": { "type": "string" }, "fErzeugerhausnr": { "type": "string" }, "fErzeugerKontaktName": { "type": "string" }, "fErzeugerKontaktTel": { "type": "string" }, "fErzeugerKontaktFax": { "type": "string" }, "fErzeugerKontaktEmail": { "type": "string" }, "fErzeugerSignatur1Name": { "type": "string" }, "fErzeugerSignatur1Datum": { "type": "string", "format": "date-time" }, "fErzeugerSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fErzeugerSignatur2Name": { "type": "string" }, "fErzeugerSignatur2Datum": { "type": "string", "format": "date-time" }, "fErzeugerSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "carrier1Number": { "type": "string", "description": "Carrier" }, "carrier1Name1": { "type": "string" }, "carrier1Name2": { "type": "string" }, "fBefoerdererzugmaschine": { "type": "string" }, "fBefoerdereranhaenger": { "type": "string" }, "carrier1City1": { "type": "string" }, "fBefoerdererplz": { "type": "string" }, "carrier1Street1": { "type": "string" }, "fBefoerdererhausnr": { "type": "string" }, "fBefoerdererKontaktName": { "type": "string" }, "fBefoerdererKontaktTel": { "type": "string" }, "fBefoerdererKontaktFax": { "type": "string" }, "fBefoerdererKontaktEmail": { "type": "string" }, "fBefoerdererSignatur1Name": { "type": "string" }, "fBefoerdererSignatur1Datum": { "type": "string", "format": "date-time" }, "fBefoerdererSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fBefoerdererSignatur2Name": { "type": "string" }, "fBefoerdererSignatur2Datum": { "type": "string", "format": "date-time" }, "fBefoerdererSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "recoveryDisposalFacilityNumber": { "type": "string", "description": "Recovery/disposal facility." }, "recoveryDisposalFacilityName1": { "type": "string" }, "recoveryDisposalFacilityName2": { "type": "string" }, "recoveryDisposalFacilityCity1": { "type": "string" }, "fEntsorgerplz": { "type": "string" }, "recoveryDisposalFacilityStreet1": { "type": "string" }, "fEntsorgerhausnr": { "type": "string" }, "fEntsorgerKontaktName": { "type": "string" }, "fEntsorgerKontaktTel": { "type": "string" }, "fEntsorgerKontaktFax": { "type": "string" }, "fEntsorgerKontaktEmail": { "type": "string" }, "fEntsorgerSignatur1Name": { "type": "string" }, "fEntsorgerSignatur1Datum": { "type": "string", "format": "date-time" }, "fEntsorgerSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEntsorgerSignatur2Name": { "type": "string" }, "fEntsorgerSignatur2Datum": { "type": "string", "format": "date-time" }, "fEntsorgerSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fErzeugerBetriebsnr": { "type": "string" }, "fBefoerdererBetriebsnr": { "type": "string" }, "fEntsorgerBetriebsnr": { "type": "string" }, "wasteTypeCode": { "type": "string", "description": "Waste code." }, "fInterneBezeichnung": { "type": "string" }, "fBbGueltigVon": { "$ref": "#/components/schemas/Date" }, "fBbGueltigBis": { "$ref": "#/components/schemas/Date" }, "fBehoerdeBetriebsnr": { "type": "string" }, "fSignatur": { "type": "string" }, "fBef1Signaturinfo": { "type": "string" }, "fAnnahmedatum": { "$ref": "#/components/schemas/Date" }, "fBef2Signaturinfo": { "type": "string" }, "fBefoerderer3BetriebsNr": { "type": "string" }, "fUebergabedatum": { "$ref": "#/components/schemas/Date" }, "transportWeight": { "allOf": [ { "$ref": "#/components/schemas/Decimal" } ], "description": "Quantity." }, "fBefoerderer2BetriebsNr": { "type": "string" }, "fZwlBetriebsNr": { "type": "string" }, "fEntSignaturinfo": { "type": "string" }, "fMengeErzeuger": { "$ref": "#/components/schemas/Decimal" }, "fUebernahmedatum": { "$ref": "#/components/schemas/Date" }, "fErzSignaturinfo": { "type": "string" }, "sequenceNumber": { "type": "string", "description": "The transport document number." }, "fEntCode": { "type": "string", "description": "string nr_revers = 1078; // maxlen = 36" }, "fAbfallbezeichnung": { "type": "string" }, "carrier2Number": { "type": "string", "description": "Additional carriers." }, "carrier2Name1": { "type": "string" }, "carrier2Name2": { "type": "string" }, "carrier2City1": { "type": "string" }, "fBef1plz": { "type": "string" }, "carrier2Street1": { "type": "string" }, "fBef1hausnr": { "type": "string" }, "fBef1KontaktName": { "type": "string" }, "fBef1KontaktTel": { "type": "string" }, "fBef1KontaktFax": { "type": "string" }, "fBef1KontaktEmail": { "type": "string" }, "fBef1Signatur1Name": { "type": "string" }, "fBef1Signatur1Datum": { "type": "string", "format": "date-time" }, "fBef1Signatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fBef1Signatur2Name": { "type": "string" }, "fBef1Signatur2Datum": { "type": "string", "format": "date-time" }, "fBef1Signatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fBef1zugmaschine": { "type": "string" }, "fBef1anhaenger": { "type": "string" }, "fBef1Uebernahme": { "$ref": "#/components/schemas/Date" }, "carrier3Number": { "type": "string" }, "carrier3Name1": { "type": "string" }, "carrier3Name2": { "type": "string" }, "carrier3City1": { "type": "string" }, "fBef2plz": { "type": "string" }, "carrier3Street1": { "type": "string" }, "fBef2hausnr": { "type": "string" }, "fBef2KontaktName": { "type": "string" }, "fBef2KontaktTel": { "type": "string" }, "fBef2KontaktFax": { "type": "string" }, "fBef2KontaktEmail": { "type": "string" }, "fBef2Signatur1Name": { "type": "string" }, "fBef2Signatur1Datum": { "type": "string", "format": "date-time" }, "fBef2Signatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fBef2Signatur2Name": { "type": "string" }, "fBef2Signatur2Datum": { "type": "string", "format": "date-time" }, "fBef2Signatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fBef2zugmaschine": { "type": "string" }, "fBef2anhaenger": { "type": "string" }, "fBef2Uebernahme": { "$ref": "#/components/schemas/Date" }, "fLetzterBefNr": { "type": "string" }, "fLetzterBefname1": { "type": "string" }, "fLetzterBefname2": { "type": "string" }, "fLetzterBefort1": { "type": "string" }, "fLetzterBefplz": { "type": "string" }, "fLetzterBefstrasse1": { "type": "string" }, "fLetzterBefhausnr": { "type": "string" }, "fLetzterBefKontaktName": { "type": "string" }, "fLetzterBefKontaktTel": { "type": "string" }, "fLetzterBefKontaktFax": { "type": "string" }, "fLetzterBefKontaktEmail": { "type": "string" }, "fLetzterBefSignatur1Name": { "type": "string" }, "fLetzterBefSignatur1Datum": { "type": "string", "format": "date-time" }, "fLetzterBefSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fLetzterBefSignatur2Name": { "type": "string" }, "fLetzterBefSignatur2Datum": { "type": "string", "format": "date-time" }, "fLetzterBefSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fLetzterBefUebernahme": { "$ref": "#/components/schemas/Date" }, "fBefSignaturinfo": { "type": "string" }, "fBef1Unterschrift": { "type": "string" }, "fVermerke": { "type": "string" }, "fZwlNr": { "type": "string" }, "fZwlname1": { "type": "string" }, "fZwlname2": { "type": "string" }, "fZwlort1": { "type": "string" }, "fZwlplz": { "type": "string" }, "fZwlstrasse1": { "type": "string" }, "fZwlhausnr": { "type": "string" }, "fZwlSignatur1Name": { "type": "string" }, "fZwlSignatur1Datum": { "type": "string", "format": "date-time" }, "fZwlSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fZwlSignatur2Name": { "type": "string" }, "fZwlSignatur2Datum": { "type": "string", "format": "date-time" }, "fZwlSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fZwlSignaturinfo": { "type": "string" }, "fZwlUebergabe": { "$ref": "#/components/schemas/Date" }, "fBefCode": { "type": "string" }, "fEntUnterschrift": { "type": "string" }, "fBef2Unterschrift": { "type": "string" }, "fZwlUnterschrift": { "type": "string" }, "fErzCode": { "type": "string" }, "fZwlUebernahme": { "$ref": "#/components/schemas/Date" }, "fErzInterneBezeichnung": { "type": "string" }, "fBefInterneBezeichnung": { "type": "string" }, "fEntInterneBezeichnung": { "type": "string" }, "fRdCode": { "type": "string" }, "fTitel": { "type": "string" }, "fRegisterbeleg": { "type": "string" }, "fVolumen": { "$ref": "#/components/schemas/Decimal" }, "fAnnahmeVerweigert": { "type": "string" }, "fErzQuittungsbelegSigniert": { "type": "string" }, "fBefQuittungsbelegSigniert": { "type": "string" }, "fEntQuittungsbelegSigniert": { "type": "string" }, "fBef1QuittungsbelegSigniert": { "type": "string" }, "fBef2QuittungsbelegSigniert": { "type": "string" }, "fZwlQuittungsbelegSigniert": { "type": "string" }, "zustellungsstatus": { "type": "string" }, "bbGueltigBestaetigtVon": { "$ref": "#/components/schemas/Date" }, "bbGueltigBestaetigtBis": { "$ref": "#/components/schemas/Date" }, "mengeGesamtBestaetigt": { "$ref": "#/components/schemas/Decimal" }, "fQbelversicherung": { "type": "boolean" }, "entsorgerAnlagetyp": { "type": "string" }, "fAnzahlTransporte": { "$ref": "#/components/schemas/Decimal" }, "fBesicherteTransporte": { "$ref": "#/components/schemas/Decimal" }, "fOrtDerErzeugung": { "type": "string" }, "fOrtDerEntsorgung": { "type": "string" }, "fErzeugerstaat": { "type": "string" }, "fEntsorgerstaat": { "type": "string" }, "fBefoerdererstaat": { "type": "string" }, "fBef1staat": { "type": "string" }, "fBef2staat": { "type": "string" }, "fLetzterBefstaat": { "type": "string" }, "fBefoerdererTransportart": { "type": "string" }, "fBef1Transportart": { "type": "string" }, "fBef2Transportart": { "type": "string" }, "fLetzterBefTransportart": { "type": "string" }, "fMehrAlsDreiBef": { "type": "boolean" }, "fExporteurnr": { "type": "string" }, "fExporteurname1": { "type": "string" }, "fExporteurname2": { "type": "string" }, "fExporteurstaat": { "type": "string" }, "fExporteurort1": { "type": "string" }, "fExporteurplz": { "type": "string" }, "fExporteurstrasse1": { "type": "string" }, "fExporteurhausnr": { "type": "string" }, "fExporteurKontaktName": { "type": "string" }, "fExporteurKontaktTel": { "type": "string" }, "fExporteurKontaktFax": { "type": "string" }, "fExporteurKontaktEmail": { "type": "string" }, "fExporteurSignatur1Name": { "type": "string" }, "fExporteurSignatur1Datum": { "type": "string", "format": "date-time" }, "fExporteurSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fExporteurSignatur2Name": { "type": "string" }, "fExporteurSignatur2Datum": { "type": "string", "format": "date-time" }, "fExporteurSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fExporteurBetriebsnr": { "type": "string" }, "fExpCode": { "type": "string" }, "fImporteurnr": { "type": "string" }, "fImporteurname1": { "type": "string" }, "fImporteurname2": { "type": "string" }, "fImporteurstaat": { "type": "string" }, "fImporteurort1": { "type": "string" }, "fImporteurplz": { "type": "string" }, "fImporteurstrasse1": { "type": "string" }, "fImporteurhausnr": { "type": "string" }, "fImporteurKontaktName": { "type": "string" }, "fImporteurKontaktTel": { "type": "string" }, "fImporteurKontaktFax": { "type": "string" }, "fImporteurKontaktEmail": { "type": "string" }, "fImporteurSignatur1Name": { "type": "string" }, "fImporteurSignatur1Datum": { "type": "string", "format": "date-time" }, "fImporteurSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fImporteurSignatur2Name": { "type": "string" }, "fImporteurSignatur2Datum": { "type": "string", "format": "date-time" }, "fImporteurSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fImporteurBetriebsnr": { "type": "string" }, "fImpCode": { "type": "string" }, "fAbfallschluesselBasel": { "type": "string" }, "fAbfallschluesselOecd": { "type": "string" }, "fAbfallschluesselEu": { "type": "string" }, "fAbfallschluesselYCode": { "type": "string" }, "fAbfallschluesselHCode": { "type": "string" }, "fAbfallschluesselUnKlasse": { "type": "string" }, "fAbfallschluesselUnKennnr": { "type": "string" }, "fAbfallschluesselUnVname": { "type": "string" }, "fExpSigName": { "type": "string" }, "fExpSigDatum": { "type": "string", "format": "date-time" }, "fExpZustimmungDatum": { "$ref": "#/components/schemas/Date" }, "fExpZustVonDatum": { "$ref": "#/components/schemas/Date" }, "fExpZustBisDatum": { "$ref": "#/components/schemas/Date" }, "fExpBehoerdeName": { "type": "string" }, "fEinfuhrstaat": { "type": "string" }, "fImpEingangAmDatum": { "$ref": "#/components/schemas/Date" }, "fImpEingangDatum": { "$ref": "#/components/schemas/Date" }, "fImpBehoerdeName": { "type": "string" }, "fEingangName": { "type": "string" }, "fEingangDatum": { "$ref": "#/components/schemas/Date" }, "fEingangSignatur": { "type": "string" }, "fEingangRdCode": { "type": "string" }, "fVoraussEntsorgungDatum": { "$ref": "#/components/schemas/Date" }, "fEntsorgungName": { "type": "string" }, "fEntsorgungDatum": { "$ref": "#/components/schemas/Date" }, "fEntsorgungSignatur": { "type": "string" }, "fBehoerdeSignatur1Name": { "type": "string" }, "fBehoerdeSignatur1Datum": { "type": "string", "format": "date-time" }, "fBehoerdeSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fBehoerdeSignatur2Name": { "type": "string" }, "fBehoerdeSignatur2Datum": { "type": "string", "format": "date-time" }, "fBehoerdeSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEnDErzName1": { "type": "string" }, "fEnDErzName2": { "type": "string" }, "fEnDErzStrasse1": { "type": "string" }, "fEnDErzHausnr": { "type": "string" }, "fEnDErzPlz": { "type": "string" }, "fEnDErzOrt1": { "type": "string" }, "fEnDErzAnsprechpName": { "type": "string" }, "fEnDErzAnsprechpTel": { "type": "string" }, "fEnDErzAnsprechpEmail": { "type": "string" }, "fEnDBevName1": { "type": "string" }, "fEnDBevName2": { "type": "string" }, "fEnDBevStrasse1": { "type": "string" }, "fEnDBevHausnr": { "type": "string" }, "fEnDBevPlz": { "type": "string" }, "fEnDBevOrt1": { "type": "string" }, "fEnDBevAnsprechpName": { "type": "string" }, "fEnDBevAnsprechpTel": { "type": "string" }, "fEnDBevAnsprechpEmail": { "type": "string" }, "fEnVeAherkRegnr": { "type": "string" }, "fEnVeAherkAsnr": { "type": "string" }, "fEnVeAherkName1": { "type": "string" }, "fEnVeAherkName2": { "type": "string" }, "fEnVeAherkStrasse1": { "type": "string" }, "fEnVeAherkHausnr": { "type": "string" }, "fEnVeAherkPlz": { "type": "string" }, "fEnVeAherkOrt1": { "type": "string" }, "fEnVeAherkAnsprechpName": { "type": "string" }, "fEnVeAherkAnsprechpTel": { "type": "string" }, "fEnVeAherkAnsprechpEmail": { "type": "string" }, "fEnVeAherkAsbez": { "type": "string" }, "fEnVeAbBezeichnung": { "type": "string" }, "fEnVeAbVorbehArt": { "type": "string" }, "fEnVeAbVorbehandlung": { "type": "boolean" }, "fEnVeAbKonsistenz": { "type": "string" }, "fEnVeAbDaErst": { "type": "boolean" }, "fEnVeAbDaVorhanden": { "type": "boolean" }, "fEnVeVon": { "$ref": "#/components/schemas/Date" }, "fEnVeBis": { "$ref": "#/components/schemas/Date" }, "fEnAeEntName1": { "type": "string" }, "fEnAeEntName2": { "type": "string" }, "fEnAeEntStrasse1": { "type": "string" }, "fEnAeEntHausnr": { "type": "string" }, "fEnAeEntPlz": { "type": "string" }, "fEnAeEntOrt1": { "type": "string" }, "fEnAeAnlageArt": { "type": "string" }, "fEnAeAnsprechpName": { "type": "string" }, "fEnAeAnsprechpTel": { "type": "string" }, "fEnAeAnsprechpEmail": { "type": "string" }, "fEnAeAnlageBez": { "type": "string" }, "fEnAeAnlageFrei": { "type": "boolean" }, "fEnAeAnlageFrnr": { "type": "string" }, "fEnAeAnlageAsnr": { "type": "string" }, "fEnAeVon": { "$ref": "#/components/schemas/Date" }, "fEnAeBis": { "$ref": "#/components/schemas/Date" }, "fEnEbEingAz": { "type": "string" }, "fEnEbEingangsdatum": { "$ref": "#/components/schemas/Date" }, "fEnEbNachfordBis": { "$ref": "#/components/schemas/Date" }, "fEnEbEingNachford": { "$ref": "#/components/schemas/Date" }, "fEnEbEingApName": { "type": "string" }, "fEnEbEingApTel": { "type": "string" }, "fEnEbEingApEmail": { "type": "string" }, "fEnEbFristhemmung": { "type": "boolean" }, "fEnEbMaengel": { "type": "boolean" }, "fEnEbBehName1": { "type": "string" }, "fEnEbBehName2": { "type": "string" }, "fEnEbBehStrasse1": { "type": "string" }, "fEnEbBehHausnr": { "type": "string" }, "fEnEbBehPlz": { "type": "string" }, "fEnEbBehOrt1": { "type": "string" }, "fEnEbBehApName": { "type": "string" }, "fEnEbBehApTel": { "type": "string" }, "fEnEbBehApEmail": { "type": "string" }, "fEnBbEntZul": { "type": "boolean" }, "fEnBbVon": { "$ref": "#/components/schemas/Date" }, "fEnBbBis": { "$ref": "#/components/schemas/Date" }, "fEnBbBehName1": { "type": "string" }, "fEnBbBehName2": { "type": "string" }, "fEnBbBehStrasse1": { "type": "string" }, "fEnBbBehHausnr": { "type": "string" }, "fEnBbBehPlz": { "type": "string" }, "fEnBbBehOrt1": { "type": "string" }, "fEnBbBehApName": { "type": "string" }, "fEnBbBehApTel": { "type": "string" }, "fEnBbBehApEmail": { "type": "string" }, "fEnBbAz": { "type": "string" }, "fEnAoUntersagt": { "type": "boolean" }, "fEnAoVon": { "$ref": "#/components/schemas/Date" }, "fEnAoBis": { "$ref": "#/components/schemas/Date" }, "fEnAoBehName1": { "type": "string" }, "fEnAoBehName2": { "type": "string" }, "fEnAoBehStrasse1": { "type": "string" }, "fEnAoBehHausnr": { "type": "string" }, "fEnAoBehPlz": { "type": "string" }, "fEnAoBehOrt1": { "type": "string" }, "fEnAoBehApName": { "type": "string" }, "fEnAoBehApTel": { "type": "string" }, "fEnAoBehApEmail": { "type": "string" }, "fEnAoAz": { "type": "string" }, "fEnNachforderungenVorhanden": { "type": "boolean" }, "fDaSignatur1Name": { "type": "string" }, "fDaSignatur1Datum": { "type": "string", "format": "date-time" }, "fDaSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fDaSignatur2Name": { "type": "string" }, "fDaSignatur2Datum": { "type": "string", "format": "date-time" }, "fDaSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfBevSignatur1Name": { "type": "string" }, "fEgfBevSignatur1Datum": { "type": "string", "format": "date-time" }, "fEgfBevSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfBevSignatur2Name": { "type": "string" }, "fEgfBevSignatur2Datum": { "type": "string", "format": "date-time" }, "fEgfBevSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfBeaSignatur1Name": { "type": "string" }, "fEgfBeaSignatur1Datum": { "type": "string", "format": "date-time" }, "fEgfBeaSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfBeaSignatur2Name": { "type": "string" }, "fEgfBeaSignatur2Datum": { "type": "string", "format": "date-time" }, "fEgfBeaSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfErzSignatur1Name": { "type": "string" }, "fEgfErzSignatur1Datum": { "type": "string", "format": "date-time" }, "fEgfErzSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfErzSignatur2Name": { "type": "string" }, "fEgfErzSignatur2Datum": { "type": "string", "format": "date-time" }, "fEgfErzSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfBehSignatur1Name": { "type": "string" }, "fEgfBehSignatur1Datum": { "type": "string", "format": "date-time" }, "fEgfBehSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEgfBehSignatur2Name": { "type": "string" }, "fEgfBehSignatur2Datum": { "type": "string", "format": "date-time" }, "fEgfBehSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fTfsLfdnr": { "$ref": "#/components/schemas/Decimal" }, "fTfsErzeugernr": { "type": "string" }, "fTfsBefoerderer1nr": { "type": "string" }, "fTfsBefoerderer2nr": { "type": "string" }, "fTfsBefoerderer3nr": { "type": "string" }, "fTfsLetzterBefoerderernr": { "type": "string" }, "fTfsEntsorgernr": { "type": "string" }, "fTfsExporteurnr": { "type": "string" }, "fTfsImporteurnr": { "type": "string" }, "fAnlageVorabzust": { "type": "boolean" }, "fTanAnlagetyp": { "type": "string" }, "fEntAnAnlagetyp": { "type": "string" }, "fVerbrErstDatum": { "$ref": "#/components/schemas/Date" }, "fVerbrLetztDatum": { "$ref": "#/components/schemas/Date" }, "fEntAnSignatur1Name": { "type": "string" }, "fEntAnSignatur1Datum": { "type": "string", "format": "date-time" }, "fEntAnSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEntAnSignatur2Name": { "type": "string" }, "fEntAnSignatur2Datum": { "type": "string", "format": "date-time" }, "fEntAnSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEntEntSignatur1Name": { "type": "string" }, "fEntEntSignatur1Datum": { "type": "string", "format": "date-time" }, "fEntEntSignatur1Cstat": { "$ref": "#/components/schemas/Decimal" }, "fEntEntSignatur2Name": { "type": "string" }, "fEntEntSignatur2Datum": { "type": "string", "format": "date-time" }, "fEntEntSignatur2Cstat": { "$ref": "#/components/schemas/Decimal" }, "fTfsBesHandlungsverschrift": { "type": "boolean" }, "fAngewandteTechnologie": { "type": "string" }, "fAusfuhrgrund": { "type": "string" }, "fAusfuhrVersand": { "type": "string" }, "fEinfuhrEmpfang": { "type": "string" }, "fAlleZustimmungenErhalten": { "type": "boolean" }, "fAnzahlAnhaenge": { "$ref": "#/components/schemas/Decimal" } } }, "ListTransportTemplatesResponse": { "type": "object", "properties": { "entries": { "type": "array", "items": { "$ref": "#/components/schemas/ListTransportTemplatesResponse_Entry" }, "description": "result list" }, "total": { "type": "integer", "format": "int32" } } }, "ListTransportTemplatesResponse_Entry": { "type": "object", "properties": { "templateId": { "type": "integer", "format": "int32" }, "interneBezeichnung": { "type": "string", "description": "Template." }, "gueltigVon": { "$ref": "#/components/schemas/Date" }, "gueltigBis": { "$ref": "#/components/schemas/Date" }, "created": { "type": "string", "description": "Audit fields.", "format": "date-time" }, "creator": { "type": "string" }, "lastchange": { "type": "string", "format": "date-time" }, "lastuser": { "type": "string" }, "erzCode": { "type": "string" }, "befCode": { "type": "string" }, "entCode": { "type": "string" }, "erzInterneBezeichnung": { "type": "string" }, "befInterneBezeichnung": { "type": "string" }, "entInterneBezeichnung": { "type": "string" }, "art": { "type": "string" }, "sammelentsorgung": { "type": "boolean" }, "durchschlaegeBgls": { "type": "integer", "format": "int32" }, "durchschlaegeUbns": { "type": "integer", "format": "int32" }, "anzahl": { "type": "integer", "format": "int32" }, "anfordern": { "type": "integer", "description": "2007-05-23 Ra ISH special case: ordering via the portal.", "format": "int32" }, "bemerkung": { "type": "string" }, "format": { "type": "string" }, "modell": { "type": "string" }, "registerbeleg": { "type": "string" }, "anfordernName": { "type": "string" }, "anfordernTelefon": { "type": "string" }, "anfordernEmail": { "type": "string" }, "anfordernGelesen": { "type": "boolean" }, "noSync": { "type": "boolean" }, "abfallbezeichnung": { "type": "string" }, "abfallschluessel": { "type": "string" }, "entsorgungsnachweisnr": { "type": "string" }, "menge": { "$ref": "#/components/schemas/Decimal" }, "erzNr": { "type": "string" }, "erzName1": { "type": "string" }, "erzName2": { "type": "string" }, "erzName3": { "type": "string" }, "erzStrasse": { "type": "string" }, "erzHausnr": { "type": "string" }, "erzPlz": { "type": "string" }, "erzOrt": { "type": "string" }, "erzStaat": { "type": "string" }, "erzKontaktName": { "type": "string" }, "erzKontaktTel": { "type": "string" }, "erzKontaktFax": { "type": "string" }, "erzKontaktEmail": { "type": "string" }, "erzTfsnr": { "type": "string" }, "erzUnterschrift": { "type": "string" }, "uebergabedatum": { "$ref": "#/components/schemas/Date" }, "befNr": { "type": "string" }, "befName1": { "type": "string" }, "befName2": { "type": "string" }, "befName3": { "type": "string" }, "befStrasse": { "type": "string" }, "befHausnr": { "type": "string" }, "befPlz": { "type": "string" }, "befOrt": { "type": "string" }, "befStaat": { "type": "string" }, "befKontaktName": { "type": "string" }, "befKontaktTel": { "type": "string" }, "befKontaktFax": { "type": "string" }, "befKontaktEmail": { "type": "string" }, "befTfsnr": { "type": "string" }, "befUnterschrift": { "type": "string" }, "uebernahmedatum": { "$ref": "#/components/schemas/Date" }, "entNr": { "type": "string" }, "entName1": { "type": "string" }, "entName2": { "type": "string" }, "entName3": { "type": "string" }, "entStrasse": { "type": "string" }, "entHausnr": { "type": "string" }, "entPlz": { "type": "string" }, "entOrt": { "type": "string" }, "entStaat": { "type": "string" }, "entKontaktName": { "type": "string" }, "entKontaktTel": { "type": "string" }, "entKontaktFax": { "type": "string" }, "entKontaktEmail": { "type": "string" }, "entTfsnr": { "type": "string" }, "entUnterschrift": { "type": "string" }, "annahmedatum": { "$ref": "#/components/schemas/Date" }, "vermerke": { "type": "string" }, "erzeugerBetriebsNr": { "type": "string" }, "befoerdererBetriebsNr": { "type": "string" }, "entsorgerBetriebsNr": { "type": "string" }, "bef1Nr": { "type": "string", "description": "Template \u2014 additional fields." }, "bef1Name1": { "type": "string" }, "bef1Name2": { "type": "string" }, "bef1Name3": { "type": "string" }, "bef1Strasse": { "type": "string" }, "bef1Hausnr": { "type": "string" }, "bef1Plz": { "type": "string" }, "bef1Ort": { "type": "string" }, "bef1Staat": { "type": "string" }, "bef1KontaktName": { "type": "string" }, "bef1KontaktTel": { "type": "string" }, "bef1KontaktFax": { "type": "string" }, "bef1KontaktEmail": { "type": "string" }, "bef1Tfsnr": { "type": "string" }, "bef1Uebernahme": { "$ref": "#/components/schemas/Date" }, "bef1Unterschrift": { "type": "string" }, "bef1BetriebsNr": { "type": "string" }, "bef2Nr": { "type": "string" }, "bef2Uebernahme": { "$ref": "#/components/schemas/Date" }, "bef2Name1": { "type": "string" }, "bef2Name2": { "type": "string" }, "bef2Name3": { "type": "string" }, "bef2Strasse": { "type": "string" }, "bef2Hausnr": { "type": "string" }, "bef2Plz": { "type": "string" }, "bef2Ort": { "type": "string" }, "bef2Staat": { "type": "string" }, "bef2KontaktName": { "type": "string" }, "bef2KontaktTel": { "type": "string" }, "bef2KontaktFax": { "type": "string" }, "bef2KontaktEmail": { "type": "string" }, "bef2Tfsnr": { "type": "string" }, "bef2Unterschrift": { "type": "string" }, "bef2BetriebsNr": { "type": "string" }, "zwlNr": { "type": "string" }, "zwlUebernahme": { "$ref": "#/components/schemas/Date" }, "zwlName1": { "type": "string" }, "zwlName2": { "type": "string" }, "zwlName3": { "type": "string" }, "zwlStrasse": { "type": "string" }, "zwlHausnr": { "type": "string" }, "zwlPlz": { "type": "string" }, "zwlOrt": { "type": "string" }, "zwlUebergabe": { "$ref": "#/components/schemas/Date" }, "zwlUnterschrift": { "type": "string" }, "zwlBetriebsNr": { "type": "string" }, "entsorgerAnlagetyp": { "type": "string" }, "fAnzahlTransporte": { "type": "integer", "format": "int32" }, "fErzeugerstaat": { "type": "string" }, "fEntsorgerstaat": { "type": "string" }, "fBefoerdererstaat": { "type": "string" }, "fExporteurnr": { "type": "string" }, "fExporteurname1": { "type": "string" }, "fExporteurname2": { "type": "string" }, "fExporteurstaat": { "type": "string" }, "fExporteurstrasse": { "type": "string" }, "fExporteurhausnr": { "type": "string" }, "fExporteurort1": { "type": "string" }, "fExporteurplz": { "type": "string" }, "fExporteurBetriebsnr": { "type": "string" }, "fExpCode": { "type": "string" }, "fExpKontaktName": { "type": "string" }, "fExpKontaktTel": { "type": "string" }, "fExpKontaktFax": { "type": "string" }, "fExpKontaktEmail": { "type": "string" }, "fTfsExporteurnr": { "type": "string" }, "fImporteurnr": { "type": "string" }, "fImporteurname1": { "type": "string" }, "fImporteurname2": { "type": "string" }, "fImporteurstaat": { "type": "string" }, "fImporteurstrasse": { "type": "string" }, "fImporteurhausnr": { "type": "string" }, "fImporteurort1": { "type": "string" }, "fImporteurplz": { "type": "string" }, "fImporteurBetriebsnr": { "type": "string" }, "fImpCode": { "type": "string" }, "fImpKontaktName": { "type": "string" }, "fImpKontaktTel": { "type": "string" }, "fImpKontaktFax": { "type": "string" }, "fImpKontaktEmail": { "type": "string" }, "fTfsImporteurnr": { "type": "string" }, "fAbfallschluesselBasel": { "type": "string" }, "fAbfallschluesselOecd": { "type": "string" }, "fAbfallschluesselEu": { "type": "string" }, "fAbfallschluesselYCode": { "type": "string" }, "fAbfallschluesselHCode": { "type": "string" }, "fAbfallschluesselUnKlasse": { "type": "string" }, "fAbfallschluesselUnKennnr": { "type": "string" }, "fAbfallschluesselUnVname": { "type": "string" }, "letzterBefNr": { "type": "string", "description": "Template \u2014 further fields." }, "letzterBefTfsnr": { "type": "string" }, "letzterBefname1": { "type": "string" }, "letzterBefname2": { "type": "string" }, "letzterBefstrasse": { "type": "string" }, "letzterBefhausnr": { "type": "string" }, "letzterBefort": { "type": "string" }, "letzterBefplz": { "type": "string" }, "letzterBefstaat": { "type": "string" }, "letzterBefKontaktName": { "type": "string" }, "letzterBefKontaktTel": { "type": "string" }, "letzterBefKontaktFax": { "type": "string" }, "letzterBefKontaktEmail": { "type": "string" }, "befZugmaschine": { "type": "string" }, "befAnhaenger": { "type": "string" }, "bef1Zugmaschine": { "type": "string" }, "bef1Anhaenger": { "type": "string" }, "bef2Zugmaschine": { "type": "string" }, "bef2Anhaenger": { "type": "string" }, "befTransportart": { "type": "string" }, "bef1Transportart": { "type": "string" }, "bef2Transportart": { "type": "string" }, "letzterBefTransportart": { "type": "string" }, "letzterBefUebernahme": { "$ref": "#/components/schemas/Date" }, "volumen": { "$ref": "#/components/schemas/Decimal" }, "behoerdeBetriebsnr": { "type": "string" }, "rdCode": { "type": "string" }, "tfsBesHandlungsverschrift": { "type": "boolean" }, "mehrAlsDreiBef": { "type": "boolean" }, "ortDerErzeugung": { "type": "string" }, "ortDerEntsorgung": { "type": "string" } } }, "LogId": { "type": "object", "properties": { "id": { "type": "string", "description": "Identifier for a changelog entry of an object (document or file)." } }, "description": "Identifier for a changelog entry of an object (document or file)." }, "LoginRequest": { "type": "object", "properties": { "groupId": { "type": "string" }, "groupSecret": { "type": "string" } } }, "LoginResponse": { "type": "object", "properties": { "jwt": { "type": "string" }, "expiresAt": { "type": "string", "format": "date-time" }, "tokenType": { "type": "string", "description": "z.B. \u0022Bearer\u0022" } } }, "LookupEventListRequest": { "type": "object", "properties": { "dateFrom": { "$ref": "#/components/schemas/TimestampField" }, "dateTo": { "$ref": "#/components/schemas/TimestampField" }, "notificationIdentifier": { "$ref": "#/components/schemas/StringField" }, "movementIdentifier": { "$ref": "#/components/schemas/StringField" }, "annex7Identifier": { "$ref": "#/components/schemas/StringField" } }, "description": "Request for the LookupEventList operation. Filters events by time window and optionally by a single notification, movement or Annex-7 identifier." }, "LookupEventListResponse": { "type": "object", "properties": { "notificationEventList": { "$ref": "#/components/schemas/ModificationEventType" } }, "description": "Response of the LookupEventList operation: list of waste-domain events matching the request." }, "LookupSyncNotificationRequest": { "type": "object", "properties": { "dateFrom": { "$ref": "#/components/schemas/TimestampField" }, "dateTo": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Request for the LookupSyncNotification operation. Bounds the time window for which DIWASS should return notifications that were submitted or modified." }, "LookupSyncNotificationResponse": { "type": "object", "properties": { "notificationModificationDetails": { "type": "array", "items": { "$ref": "#/components/schemas/NotificationModificationDetailsType" } } }, "description": "Response of the LookupSyncNotification operation: list of notification modification entries within the requested window." }, "MassMeasureType": { "type": "object", "properties": { "tonnes": { "$ref": "#/components/schemas/DoubleField" } }, "description": "Mass measurement expressed in metric tonnes. Supports up to 5 decimal places." }, "MassVolumeMeasureType": { "type": "object", "properties": { "massMeasure": { "$ref": "#/components/schemas/MassMeasureType" }, "volumeMeasure": { "$ref": "#/components/schemas/VolumeMeasureType" } }, "description": "Combined quantity expressed as mass and/or volume. Both fields are optional but in practice at least one is supplied. Used for accepted/rejected/recovered/disposed amounts on certificates." }, "MediaType": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/SchemaOrReference" }, "example": { "$ref": "#/components/schemas/Any" }, "examples": { "$ref": "#/components/schemas/ExamplesOrReferences" }, "encoding": { "$ref": "#/components/schemas/Encodings" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Each Media Type Object provides schema and examples for the media type identified by its key." }, "MediaTypes": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedMediaType" } } } }, "MembersOfOperatorGroupType": { "type": "object", "properties": { "groupId": { "$ref": "#/components/schemas/Int64Field" }, "operator": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorBaseType" } } }, "description": "List of operators that belong to one operator group. Used in the v2 operator detail view (\u0060OperatorWithDetailsType\u0060) to expose group membership alongside the primary operator entry." }, "ModificationEventType": { "type": "object", "properties": { "wasteEvent": { "type": "array", "items": { "$ref": "#/components/schemas/WasteEventType" } } }, "description": "Wrapper around a list of waste-domain events used as the payload of LookupEventList responses." }, "MovementCertificateIdentifierType": { "type": "object", "properties": { "movementId": { "$ref": "#/components/schemas/StringField" }, "certificateId": { "$ref": "#/components/schemas/StringField" } }, "description": "Composite identifier addressing a specific movement certificate (e.g. a ProperlyCarriedOut or ProperlyCompleted certificate) attached to a movement." }, "MovementDocument": { "type": "object", "properties": { "specificationVersion": { "$ref": "#/components/schemas/StringField" }, "blockId": { "$ref": "#/components/schemas/StringField" }, "receivedTimestamp": { "$ref": "#/components/schemas/TimestampField" }, "vendorId": { "$ref": "#/components/schemas/StringField" }, "diwassMessage": { "$ref": "#/components/schemas/DiwassMovementMessageType" }, "notification": { "$ref": "#/components/schemas/GetNotificationResponse" }, "zedal": { "$ref": "#/components/schemas/ZedalMovementType" } }, "description": "Top-level document of a waste shipment movement (Annex IB transport announcement). Carries the block metadata (specification version, block ID, receipt timestamp, vendor) inherited from the ZEWASS BlockType and the typed payload of the movement." }, "MovementDocumentIdentifierType": { "type": "object", "properties": { "movementId": { "$ref": "#/components/schemas/StringField" }, "documentId": { "$ref": "#/components/schemas/StringField" } }, "description": "Composite identifier addressing a specific document attached to a movement (e.g. an updated transport document). The \u0060movement_id\u0060 is mandatory; the \u0060document_id\u0060 narrows the reference to a particular document version." }, "MovementDocumentType": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" }, "shipmentOriginAddress": { "$ref": "#/components/schemas/ShipmentOriginAddressType" }, "sequenceNumber": { "$ref": "#/components/schemas/Int32Field" }, "containerIdentification": { "$ref": "#/components/schemas/StringField" }, "transportAnnouncement": { "$ref": "#/components/schemas/TransportAnnouncementType" }, "notifierSignature": { "$ref": "#/components/schemas/SignatureType" } }, "description": "Core data of a single planned movement under a notification: references the parent notification, the sequence number within the notification, optional shipment-origin address, the transport announcement (carrier, packaging, planned start date, quantity) and the notifier\u0027s signature." }, "MovementIdentifierType": { "type": "object", "properties": { "movementId": { "$ref": "#/components/schemas/StringField" } }, "description": "Bare identifier of a single movement under a notification." }, "MovementInformationType": { "type": "object", "properties": { "announcement": { "$ref": "#/components/schemas/GetMovementTemplateType" }, "carrierTransport": { "type": "array", "items": { "$ref": "#/components/schemas/GetCarrierTransportDocumentType" } }, "consigneeReception": { "$ref": "#/components/schemas/GetConsigneeReceptionDocumentType" }, "facilityReception": { "type": "array", "items": { "$ref": "#/components/schemas/GetFacilityReceptionDocumentType" } }, "facilityCompletion": { "type": "array", "items": { "$ref": "#/components/schemas/GetFacilityCompletionDocumentType" } }, "takeBack": { "$ref": "#/components/schemas/GetMovementTakeBackDocumentType" }, "signals": { "type": "array", "items": { "$ref": "#/components/schemas/GetSignalDocumentType" } } }, "description": "Aggregate retrieval view of a single movement under a notification: announcement / template, carrier transport documents, consignee and facility reception documents, facility completion certificates, optional take-back document and lifecycle signals." }, "MovementModificationDetailsType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementIdentifierType" }, "submissionDate": { "$ref": "#/components/schemas/TimestampField" }, "lastUpdateDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Lightweight movement / Annex VII summary entry returned by the GetAllMovements / GetAllAnnex7 listing operations: identifier plus submission / last-update timestamps." }, "MovementOperationResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "movementCertificateId": { "$ref": "#/components/schemas/MovementCertificateIdentifierType" } }, "description": "Response returned by movement-level Create/Update operations (carrier transport, consignee/facility reception, facility completion, take-back). Carries the validation outcome and the identifier of the resulting movement-certificate document." }, "MovementPackagingType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/PackagingTypeBase" }, "packageQuantity": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Packaging used in a single transport: extends the generic PackagingTypeBase with the concrete number of packages used in that movement." }, "MovementSignalDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "movementIdentifier": { "$ref": "#/components/schemas/MovementIdentifierType" }, "statement": { "$ref": "#/components/schemas/SignalStatementDocumentType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Movement-level signal (e.g. movement cancelled, properly carried out). Optional \u0060onBehalfOfCa\u0060 allows another competent authority to sign on behalf of the originating authority. The signal payload carries the actual statement and signature." }, "MovementTakeBackDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "movementIdentifier": { "$ref": "#/components/schemas/MovementDocumentIdentifierType" }, "movementTakeBack": { "$ref": "#/components/schemas/MovementTakeBackType" }, "competentAuthoritySignature": { "$ref": "#/components/schemas/SignatureType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Take-back order document issued by a competent authority for an existing movement under Article 22 WSR (e.g. when the destination facility refused acceptance). Records the take-back quantity, reasons, planned date and the authority\u0027s signature." }, "MovementTakeBackType": { "type": "object", "properties": { "quantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "reasons": { "$ref": "#/components/schemas/DescriptionType" }, "requirements": { "$ref": "#/components/schemas/DescriptionType" }, "takeBackDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Records that a quantity of waste has been taken back to the country of dispatch \u2014 used when a movement cannot be completed at destination. Specifies the returned quantity, the reasons, any specific requirements for handling and the date the take-back occurred." }, "MovementTemplateOperationResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "movementId": { "$ref": "#/components/schemas/MovementIdentifierType" } }, "description": "Response returned by Create/Update operations on a movement template. Carries the validation outcome and, on successful create, the DIWASS-assigned MovementId." }, "MovementTemplateType": { "type": "object", "properties": { "movementIdentifier": { "$ref": "#/components/schemas/MovementIdentifierType" }, "movementDocumentDueToTakeBack": { "$ref": "#/components/schemas/BoolField" }, "movementDocumentsDueToIllegalActivity": { "$ref": "#/components/schemas/BoolField" }, "movementReferenceIdentifier": { "$ref": "#/components/schemas/MovementIdentifierType" }, "template": { "$ref": "#/components/schemas/MovementDocumentType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Top-level movement-template payload submitted by the notifier to register a planned movement under a notification. Wraps the MovementDocument plus the take-back / illegal-activity flags and any linked attachments. DIWASS assigns the MovementId on create (format \u0060DE...i.NNNNNNMOV\u0060)." }, "NamedAny": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/Any" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of Any as ordered (name,value) pairs." }, "NamedCallbackOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/CallbackOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of CallbackOrReference as ordered (name,value) pairs." }, "NamedEncoding": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/Encoding" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of Encoding as ordered (name,value) pairs." }, "NamedExampleOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/ExampleOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of ExampleOrReference as ordered (name,value) pairs." }, "NamedHeaderOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/HeaderOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of HeaderOrReference as ordered (name,value) pairs." }, "NamedLinkOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/LinkOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of LinkOrReference as ordered (name,value) pairs." }, "NamedMediaType": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/MediaType" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of MediaType as ordered (name,value) pairs." }, "NamedParameterOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/ParameterOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of ParameterOrReference as ordered (name,value) pairs." }, "NamedPathItem": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/PathItem" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of PathItem as ordered (name,value) pairs." }, "NamedRequestBodyOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/RequestBodyOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of RequestBodyOrReference as ordered (name,value) pairs." }, "NamedResponseOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/ResponseOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of ResponseOrReference as ordered (name,value) pairs." }, "NamedSchemaOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/SchemaOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of SchemaOrReference as ordered (name,value) pairs." }, "NamedSecuritySchemeOrReference": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/SecuritySchemeOrReference" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of SecuritySchemeOrReference as ordered (name,value) pairs." }, "NamedServerVariable": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/ServerVariable" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of ServerVariable as ordered (name,value) pairs." }, "NamedString": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "type": "string", "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of string as ordered (name,value) pairs." }, "NamedStringArray": { "type": "object", "properties": { "name": { "type": "string", "description": "Map key" }, "value": { "allOf": [ { "$ref": "#/components/schemas/StringArray" } ], "description": "Mapped value" } }, "description": "Automatically-generated message used to represent maps of StringArray as ordered (name,value) pairs." }, "NotificationDeadlineType": { "type": "object", "properties": { "properlyCarriedOutSubmission": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } }, "properlyCompletedSubmission": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } }, "additionalInfoRequestOrProperlyCarriedOutSubmission": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } }, "additionalInfoRequestOrProperlyCompletedSubmission": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } }, "notificationInvalidation": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } }, "replyToAdditionalInfoRequest": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } }, "decisionSubmission": { "type": "array", "items": { "$ref": "#/components/schemas/DeadlineType" } } }, "description": "Bundle of per-CA procedural deadlines published by DIWASS for a notification (submission acknowledgement, additional-info reply windows, invalidation deadline, decision deadline). Each list typically contains one entry per involved competent authority." }, "NotificationDocument": { "type": "object", "properties": { "specificationVersion": { "allOf": [ { "$ref": "#/components/schemas/StringField" } ], "description": "Ausname f\u00FCr die Block-Basis, da diese in der XSD als extension base=\u0022zewass:BlockType\u0022 definiert ist. In der Proto-Struktur wird die Basis direkt in die NotificationDocument-Struktur integriert.\r\n BlockType base = 1 [(infotech.zedal.documents.v1.mandatory)=true]; // XSD: zewass:NotificationBlockType (extension of zewass:BlockType).base -\u003E Proto: BlockType" }, "blockId": { "$ref": "#/components/schemas/StringField" }, "receivedTimestamp": { "$ref": "#/components/schemas/TimestampField" }, "vendorId": { "$ref": "#/components/schemas/StringField" }, "diwassMessage": { "$ref": "#/components/schemas/DiwassNotificationMessageType" }, "zedal": { "$ref": "#/components/schemas/ZedalNotificationType" } }, "description": "Top-level document of a waste shipment notification (Annex IA). Carries the block metadata (specification version, block ID, receipt timestamp, vendor) inherited from the ZEWASS BlockType and the typed payload of the notification itself." }, "NotificationDocumentIdentifierType": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" }, "documentId": { "$ref": "#/components/schemas/StringField" } }, "description": "Composite identifier addressing a specific document version attached to a notification (used e.g. when issuing a decision against a particular submission revision)." }, "NotificationInformationType": { "type": "object", "properties": { "notificationStatus": { "$ref": "#/components/schemas/StringField" }, "submission": { "$ref": "#/components/schemas/GetSubmissionDocumentType" }, "decisions": { "type": "array", "items": { "$ref": "#/components/schemas/GetDecisionDocumentType" } }, "acknowledgement": { "type": "array", "items": { "$ref": "#/components/schemas/GetAcknowledgementDocumentType" } }, "requestInformation": { "type": "array", "items": { "$ref": "#/components/schemas/GetRequestInformationDocumentType" } }, "replyRequestInformation": { "type": "array", "items": { "$ref": "#/components/schemas/GetRequestInformationDocumentType" } }, "requestForChangeAfterConsent": { "type": "array", "items": { "$ref": "#/components/schemas/GetRequestForChangeAfterConsentDocumentType" } }, "replyRequestForChangeAfterConsent": { "type": "array", "items": { "$ref": "#/components/schemas/GetReplyToRequestForChangeAfterConsentDocumentType" } }, "signals": { "type": "array", "items": { "$ref": "#/components/schemas/GetSignalDocumentType" } }, "completionCertificateUnderArticle15": { "type": "array", "items": { "$ref": "#/components/schemas/GetFacilityCompletionUnderArticle15" } }, "movementIdentifier": { "type": "array", "items": { "$ref": "#/components/schemas/MovementIdentifierType" } } }, "description": "Aggregate retrieval view of a notification\u0027s full lifecycle: status, original submission and all derived documents (decisions, acknowledgements, requests for information and their replies, requests for change after consent and their replies, signals, Article-15 completion certificates) plus referenced movement identifiers." }, "NotificationMassVolumeMeasureType": { "type": "object", "properties": { "massMeasure": { "$ref": "#/components/schemas/MassMeasureType" }, "volumeMeasure": { "$ref": "#/components/schemas/VolumeMeasureType" } }, "description": "Mass and/or volume of waste covered by a notification across all planned shipments. Structurally identical to MassVolumeMeasureType but kept as a distinct type to match the XSD where notification-level totals have their own slot." }, "NotificationModificationDetailsType": { "type": "object", "properties": { "notificationIdentifier": { "$ref": "#/components/schemas/StringField" }, "submissionDate": { "$ref": "#/components/schemas/TimestampField" }, "lastUpdateDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Lightweight change-tracking entry for a notification, used by sync endpoints to enumerate notifications that were submitted or modified within a given window." }, "NotificationOperationResponse": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationDocumentId": { "$ref": "#/components/schemas/NotificationDocumentIdentifierType" } }, "description": "Response returned by competent-authority operations on a notification document (e.g. setting a decision document or interim status). Carries the validation outcome and the DIWASS-assigned identifier of the resulting notification document." }, "NotificationSignalDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "notificationId": { "$ref": "#/components/schemas/StringField" }, "statement": { "$ref": "#/components/schemas/SignalStatementDocumentType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Carries a SignalStatementDocumentType against a specific notification \u2014 used for lifecycle events like ProperlyCarriedOut, NotificationCancelled, NotificationWithdrawn etc." }, "NotificationSignalResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationDocumentId": { "$ref": "#/components/schemas/NotificationDocumentIdentifierType" } }, "description": "Response returned when a notification-level signal (e.g. notification cancelled, properly carried out) is submitted. Carries the validation outcome and the identifier of the resulting signal document." }, "OauthFlow": { "type": "object", "properties": { "authorizationUrl": { "type": "string" }, "tokenUrl": { "type": "string" }, "refreshUrl": { "type": "string" }, "scopes": { "$ref": "#/components/schemas/Strings" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Configuration details for a supported OAuth Flow" }, "OauthFlows": { "type": "object", "properties": { "implicit": { "$ref": "#/components/schemas/OauthFlow" }, "password": { "$ref": "#/components/schemas/OauthFlow" }, "clientCredentials": { "$ref": "#/components/schemas/OauthFlow" }, "authorizationCode": { "$ref": "#/components/schemas/OauthFlow" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Allows configuration of the supported OAuth Flows." }, "OnBehalfCAType": { "type": "object", "properties": { "competentAuthorityId": { "$ref": "#/components/schemas/StringField" }, "countryId": { "$ref": "#/components/schemas/StringField" }, "competentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" } }, "description": "Identifies a competent authority that the caller is acting on behalf of. Required when an authorised intermediary submits documents for a CA that is not directly connected to DIWASS." }, "Operation": { "type": "object", "properties": { "tags": { "type": "array", "items": { "type": "string" } }, "summary": { "type": "string" }, "description": { "type": "string" }, "externalDocs": { "$ref": "#/components/schemas/ExternalDocs" }, "operationId": { "type": "string" }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterOrReference" } }, "requestBody": { "$ref": "#/components/schemas/RequestBodyOrReference" }, "responses": { "$ref": "#/components/schemas/Responses" }, "callbacks": { "$ref": "#/components/schemas/CallbacksOrReferences" }, "deprecated": { "type": "boolean" }, "security": { "type": "array", "items": { "$ref": "#/components/schemas/SecurityRequirement" } }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/Server" } }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Describes a single API operation on a path." }, "OperatorActivityBaseType": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/StringField" }, "activityType": { "$ref": "#/components/schemas/OperatorActivityTypeDescriptorBaseType" }, "status": { "$ref": "#/components/schemas/StringField" }, "address": { "$ref": "#/components/schemas/AddressBaseType" }, "responsibleAuthorityActivity": { "type": "array", "items": { "$ref": "#/components/schemas/AuthorityActivityDescriptorType" } }, "responsibleOrganicControlBody": { "$ref": "#/components/schemas/OrganicControlBodyActivityDescriptorType" }, "remark": { "type": "array", "items": { "$ref": "#/components/schemas/CodeType" } }, "validityDateFrom": { "$ref": "#/components/schemas/TimestampField" }, "validityDateTo": { "$ref": "#/components/schemas/TimestampField" }, "publishedDate": { "$ref": "#/components/schemas/TimestampField" }, "applicationDate": { "$ref": "#/components/schemas/TimestampField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Authorised activity of an operator at a specific site address (e.g. an R13 interim storage permit). Carries the activity classification, lifecycle \u0060status\u0060, validity dates, the supervising authority/control body links, and remarks captured by the registering authority." }, "OperatorActivityIndexBaseType": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/StringField" }, "activityType": { "$ref": "#/components/schemas/OperatorActivityTypeDescriptorBaseType" }, "status": { "$ref": "#/components/schemas/StringField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Compact activity entry used inside operator index/listing results. Carries the identifier, classification, lifecycle status and internal id without the full nested authority/contact graph." }, "OperatorActivityQueryBaseType": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/StringField" }, "chapter": { "$ref": "#/components/schemas/StringField" }, "section": { "$ref": "#/components/schemas/StringField" }, "type": { "$ref": "#/components/schemas/StringField" } }, "description": "Search criterion filtering operators by their authorised activity. Each field narrows the activity classification (national identifier, chapter, section, leaf type) and is combined with the others by logical AND." }, "OperatorActivityTypeDescriptorBaseType": { "type": "object", "properties": { "chapter": { "$ref": "#/components/schemas/CodeType" }, "section": { "$ref": "#/components/schemas/CodeType" }, "type": { "$ref": "#/components/schemas/CodeType" } }, "description": "Hierarchical classification of an operator activity. The \u0060type\u0060 is the leaf code (e.g. R-/D-recovery code for a waste site); \u0060chapter\u0060 and \u0060section\u0060 are the optional grouping nodes from the activity classification tree." }, "OperatorAddressBaseType": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/AddressBaseType" }, "main": { "$ref": "#/components/schemas/BoolField" } }, "description": "Address entry on an operator record. An operator may have several addresses (head office, branches, sites); \u0060main=true\u0060 marks the legal seat." }, "OperatorAddressIndexBaseType": { "type": "object", "properties": { "address": { "$ref": "#/components/schemas/AddressIndexType" } }, "description": "Compact address representation used inside \u0060OperatorIndex\u0060 search results." }, "OperatorAuthorityActivityQueryBaseType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "exactMatch": { "$ref": "#/components/schemas/BoolField" }, "codeType": { "$ref": "#/components/schemas/StringField" } }, "description": "Search criterion targeting operators whose responsible authority activity matches a given code. \u0060codeType\u0060 selects whether the \u0060value\u0060 is interpreted as the activity code or as a UN/LOCODE." }, "OperatorBaseType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "operatorAddress": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorAddressBaseType" } }, "operatorContactDetail": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorContactDetailBaseType" } }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorIdentifierBaseType" } }, "activity": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorActivityBaseType" } }, "chanProcedure": { "$ref": "#/components/schemas/BoolField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" }, "main": { "$ref": "#/components/schemas/BoolField" } }, "description": "Full operator record returned by the operator directory: legal name, addresses, contacts, external identifiers and the list of authorised activities. The \u0060internalId\u0060 is the directory\u0027s stable primary key." }, "OperatorContactDetailBaseType": { "type": "object", "properties": { "contactDetail": { "$ref": "#/components/schemas/ContactDetailType" }, "main": { "$ref": "#/components/schemas/BoolField" } }, "description": "Contact entry (phone, email, fax, role) attached to an operator. \u0060main=true\u0060 marks the primary contact channel for official correspondence." }, "OperatorIdentifierBaseType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "type": { "$ref": "#/components/schemas/StringField" }, "name": { "$ref": "#/components/schemas/StringField" }, "main": { "$ref": "#/components/schemas/BoolField" } }, "description": "Typed external identifier of an operator (e.g. EORI, VAT, national waste-shipment number). The \u0060type\u0060 discriminates between identifier schemes; one identifier may be flagged as \u0060main\u0060 to highlight the primary business identifier." }, "OperatorIdentifierQueryBaseType": { "type": "object", "properties": { "id": { "$ref": "#/components/schemas/StringField" }, "type": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } } }, "description": "Search criterion that filters operators by an external identifier value, optionally restricted to certain identifier \u0060type\u0060s (EORI/VAT/...). Up to 15 \u0060type\u0060 values may be passed." }, "OperatorIndexBaseType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "identifier": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorIdentifierBaseType" } }, "linkedOperatorInternalId": { "$ref": "#/components/schemas/Int64Field" }, "operatorAddress": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorAddressIndexBaseType" } }, "activity": { "type": "array", "items": { "$ref": "#/components/schemas/OperatorActivityIndexBaseType" } }, "createDateTime": { "$ref": "#/components/schemas/TimestampField" }, "updateDateTime": { "$ref": "#/components/schemas/TimestampField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Compact operator entry returned by \u0060FindOperator\u0060. Contains the fields needed to render a result row (name, identifiers, addresses, activities, create/update timestamps) without the full graph of the \u0060OperatorBaseType\u0060." }, "OperatorNameQueryBaseType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "matchMode": { "$ref": "#/components/schemas/StringField" } }, "description": "Search criterion targeting the operator name in \u0060FindOperator\u0060 queries. \u0060matchMode\u0060 \u0060PHRASE\u0060 keeps the exact word order; \u0060FULL_TEXT\u0060 performs a tokenised full-text match where word order is irrelevant." }, "OperatorWithDetailsType": { "type": "object", "properties": { "linkedOperatorInternalId": { "$ref": "#/components/schemas/Int64Field" }, "operator": { "$ref": "#/components/schemas/OperatorBaseType" }, "membersOfOperatorGroup": { "$ref": "#/components/schemas/MembersOfOperatorGroupType" }, "assignedResponsibleAuthorities": { "$ref": "#/components/schemas/AssignedResponsibleAuthoritiesType" } }, "description": "Operator detail view returned by the v2 directory API. Combines the base operator data with optional information about a parent operator group, its members and the responsible competent authorities." }, "OrganicControlBodyActivityDescriptorType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "code": { "$ref": "#/components/schemas/StringField" }, "address": { "$ref": "#/components/schemas/AddressType" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Descriptor of an organic control body activity in the DIWASS directory. Identifies the body\u0027s name, activity code, postal address and the internal directory ID \u2014 used wherever an OCB is referenced by another directory entry or document." }, "PackagingType": { "type": "object", "properties": { "packageTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "packageDescription": { "$ref": "#/components/schemas/DescriptionType" }, "specialHandlingRequirementIndicator": { "$ref": "#/components/schemas/BoolField" } }, "description": "Packaging description for the waste shipments: one or more package type codes (1..10), an optional free-text description and a flag for special handling requirements (mandatory)." }, "PackagingTypeBase": { "type": "object", "properties": { "packageTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "packageDescription": { "$ref": "#/components/schemas/DescriptionType" }, "specialHandlingRequirementIndicator": { "$ref": "#/components/schemas/BoolField" } }, "description": "Looser variant of PackagingType with the special-handling flag optional. Used in contexts where packaging information may be partially specified." }, "Parameter": { "type": "object", "properties": { "name": { "type": "string" }, "in": { "type": "string" }, "description": { "type": "string" }, "required": { "type": "boolean" }, "deprecated": { "type": "boolean" }, "allowEmptyValue": { "type": "boolean" }, "style": { "type": "string" }, "explode": { "type": "boolean" }, "allowReserved": { "type": "boolean" }, "schema": { "$ref": "#/components/schemas/SchemaOrReference" }, "example": { "$ref": "#/components/schemas/Any" }, "examples": { "$ref": "#/components/schemas/ExamplesOrReferences" }, "content": { "$ref": "#/components/schemas/MediaTypes" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Describes a single operation parameter. A unique parameter is defined by a combination of a name and location." }, "ParameterOrReference": { "type": "object", "properties": { "parameter": { "$ref": "#/components/schemas/Parameter" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "ParametersOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedParameterOrReference" } } } }, "PartyId": { "type": "object", "properties": { "countryId": { "type": "string" }, "identificationId": { "type": "string" } }, "description": "international registrationnumber with country id" }, "PathItem": { "type": "object", "properties": { "Ref": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" }, "get": { "$ref": "#/components/schemas/Operation" }, "put": { "$ref": "#/components/schemas/Operation" }, "post": { "$ref": "#/components/schemas/Operation" }, "delete": { "$ref": "#/components/schemas/Operation" }, "options": { "$ref": "#/components/schemas/Operation" }, "head": { "$ref": "#/components/schemas/Operation" }, "patch": { "$ref": "#/components/schemas/Operation" }, "trace": { "$ref": "#/components/schemas/Operation" }, "servers": { "type": "array", "items": { "$ref": "#/components/schemas/Server" } }, "parameters": { "type": "array", "items": { "$ref": "#/components/schemas/ParameterOrReference" } }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Describes the operations available on a single path. A Path Item MAY be empty, due to ACL constraints. The path itself is still exposed to the documentation viewer but they will not know which operations and parameters are available." }, "Paths": { "type": "object", "properties": { "path": { "type": "array", "items": { "$ref": "#/components/schemas/NamedPathItem" } }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Holds the relative paths to the individual endpoints and their operations. The path is appended to the URL from the \u0060Server Object\u0060 in order to construct the full URL. The Paths MAY be empty, due to ACL constraints." }, "PeekNextAcknowledgableTransportDocumentResponse": { "type": "object", "properties": { "docId": { "$ref": "#/components/schemas/DocumentId" }, "logId": { "$ref": "#/components/schemas/LogId" } } }, "PeekNextFileAreaDocumentResponse": { "type": "object", "properties": { "docId": { "$ref": "#/components/schemas/DocumentId" }, "logId": { "$ref": "#/components/schemas/LogId" } } }, "PeekNextTransportDocumentResponse": { "type": "object", "properties": { "docId": { "$ref": "#/components/schemas/DocumentId" }, "logId": { "$ref": "#/components/schemas/LogId" } } }, "Properties": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedSchemaOrReference" } } } }, "Provider": { "type": "object", "properties": { "id": { "example": 20, "type": "integer", "description": "the provider id", "format": "int32" }, "name": { "example": "login.bund2.zedal.de", "type": "string", "description": "the long provider name" }, "shortName": { "example": "BUND2", "pattern": "[A-Z0-9]\u002B", "type": "string", "description": "the short provider name" }, "type": { "example": "PROD", "type": "integer", "description": "the type of the provider", "format": "enum" }, "vendor": { "example": "ZEDAL AG", "type": "string", "description": "the vendor of the provider" }, "portalUrl": { "example": "https://login.bund2.zedal.de", "type": "string", "description": "URL of the portal", "format": "url" }, "soapUrl": { "example": "https://login.bund2.zedal.de/ws/ws.php", "type": "string", "description": "URL of classic SOAP webservices", "format": "url" }, "grpcUrl": { "example": "api.zedal.de:443", "type": "string", "description": "URL of grpc services", "format": "host:port" } } }, "QuantityArticle15Type": { "type": "object", "properties": { "quantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "recoveryDisposalTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } } }, "description": "Mass/volume quantity assigned to one or more recovery (R-codes) or disposal (D-codes) operations as required by Article 15 of the WSR. Used inside FacilityCompletionUnderArticle15Type." }, "RecoveryDisposalFacilityType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/FacilityType" }, "facilityTypeCode": { "$ref": "#/components/schemas/StringField" } }, "description": "Recovery or disposal facility receiving the waste. Extends FacilityType with a single facility type code: \u0060R\u0060 for recovery, \u0060D\u0060 for disposal." }, "RecoveryLaboratoryFacilityType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/Annex7FacilityType" }, "facilityLaboratoryTypeCode": { "$ref": "#/components/schemas/StringField" } } }, "Reference": { "type": "object", "properties": { "Ref": { "type": "string" }, "summary": { "type": "string" }, "description": { "type": "string" } }, "description": "A simple object to allow referencing other components in the specification, internally and externally. The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules. For this specification, reference resolution is accomplished as defined by the JSON Reference specification and not by the JSON Schema specification." }, "RegionQueryType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "internalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "XSD: dirregion:RegionQueryType" }, "RegisterGroupRequest": { "type": "object", "properties": {} }, "RegisterGroupResponse": { "type": "object", "properties": { "groupId": { "type": "string" }, "groupSecret": { "type": "string", "description": "Nur bei der Registrierung zur\u00FCckgegeben; serverseitig nur gehasht gespeichert" } } }, "RemoveDocumentsFromInboxResponse": { "type": "object", "properties": {} }, "ReplyToRequestForChangeAfterConsentDocumentType": { "type": "object", "properties": { "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "requestForChangeAfterConsentId": { "$ref": "#/components/schemas/StringField" }, "agreementChangeRouteRequest": { "$ref": "#/components/schemas/BoolField" }, "reasons": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageDescriptionType" } }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Authority\u0027s reply to a RequestForChangeAfterConsent \u2014 granting or refusing the requested route change with optional reasoning." }, "ReplyToRequestForChangeAfterConsentRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "reply": { "$ref": "#/components/schemas/ReplyToRequestForChangeAfterConsentDocumentType" } } }, "ReplyToRequestForChangeAfterConsentResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated \u0060Notifizierung\u0060 (zewass format with ZEDAL extensions) including\r\n the authority\u0027s reply to a request for change after consent just recorded." } } }, "RequestAccessRequest": { "required": [ "refreshToken" ], "type": "object", "properties": { "refreshToken": { "type": "string" } }, "description": "Carries the RefreshToken to exchange for a fresh AccessToken. The same token must also be supplied in the \u0060Authorization\u0060 header (security scheme \u0060RefreshToken\u0060) \u2014 the body field is what is actually consumed and rotated." }, "RequestAccessResponse": { "type": "object", "properties": { "accessToken": { "type": "string" }, "newRefreshToken": { "type": "string" } }, "description": "Result of the token exchange: a short-lived AccessToken for subsequent API calls plus a **new** RefreshToken (the presented one is invalidated). Clients must persist \u0060new_refresh_token\u0060 and use it for the next \u0060RequestAccess\u0060 \u2014 keep the old one only briefly to handle network retries." }, "RequestBodiesOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedRequestBodyOrReference" } } } }, "RequestBody": { "type": "object", "properties": { "description": { "type": "string" }, "content": { "$ref": "#/components/schemas/MediaTypes" }, "required": { "type": "boolean" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Describes a single request body." }, "RequestBodyOrReference": { "type": "object", "properties": { "requestBody": { "$ref": "#/components/schemas/RequestBody" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "RequestForChangeAfterConsentDocumentType": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" }, "changeRouteRequest": { "$ref": "#/components/schemas/BoolField" }, "requestDescription": { "type": "array", "items": { "$ref": "#/components/schemas/LanguageDescriptionType" } }, "signature": { "$ref": "#/components/schemas/SignatureType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" } }, "description": "Notifier\u0027s request to change a consented notification \u2014 typically a route change after consent. Triggers a fresh round of authority approvals." }, "RequestInformationDocumentType": { "type": "object", "properties": { "requestInformationId": { "$ref": "#/components/schemas/StringField" }, "userCompetentAuthorityDomainId": { "$ref": "#/components/schemas/StringField" }, "onBehalfOfCa": { "$ref": "#/components/schemas/OnBehalfCAType" }, "additionalDaysToReply": { "$ref": "#/components/schemas/Int32Field" }, "statement": { "$ref": "#/components/schemas/StatementDocumentType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Authority request for additional information regarding a pending notification. Carries an optional deadline extension and a structured statement describing what is being asked of the notifier." }, "RequestResponseType": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationId": { "$ref": "#/components/schemas/StringField" }, "requestId": { "$ref": "#/components/schemas/StringField" } }, "description": "Response payload for request-for-information (RFI) and request-for-change-after-consent (RFCAC) operations as well as their replies. Carries the validation outcome plus the NotificationId and the server-assigned RequestId." }, "Response": { "type": "object", "properties": { "description": { "type": "string" }, "headers": { "$ref": "#/components/schemas/HeadersOrReferences" }, "content": { "$ref": "#/components/schemas/MediaTypes" }, "links": { "$ref": "#/components/schemas/LinksOrReferences" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Describes a single response from an API Operation, including design-time, static \u0060links\u0060 to operations based on the response." }, "ResponseOrReference": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/Response" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "Responses": { "type": "object", "properties": { "default": { "$ref": "#/components/schemas/ResponseOrReference" }, "responseOrReference": { "type": "array", "items": { "$ref": "#/components/schemas/NamedResponseOrReference" } }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "A container for the expected responses of an operation. The container maps a HTTP response code to the expected response. The documentation is not necessarily expected to cover all possible HTTP response codes because they may not be known in advance. However, documentation is expected to cover a successful operation response and any known errors. The \u0060default\u0060 MAY be used as a default response object for all HTTP codes that are not covered individually by the specification. The \u0060Responses Object\u0060 MUST contain at least one response code, and it SHOULD be the response for a successful operation call." }, "ResponsesOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedResponseOrReference" } } } }, "RetrievalGetAllAnnex7Request": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAllAnnex7Request" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "RetrievalGetAllAnnex7Response": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAllAnnex7Response" } } }, "RetrievalGetAllMovementsRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/GetAllMovementsRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "RetrievalGetAllMovementsResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/GetAllMovementsResponse" } } }, "RetrievalLookupEventListRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/LookupEventListRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "RetrievalLookupEventListResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/LookupEventListResponse" } } }, "RetrievalLookupSyncNotificationRequest": { "type": "object", "properties": { "request": { "$ref": "#/components/schemas/LookupSyncNotificationRequest" }, "credentials": { "$ref": "#/components/schemas/WsseCredentials" } } }, "RetrievalLookupSyncNotificationResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/LookupSyncNotificationResponse" } } }, "RevokeAccessFromFileResponse": { "type": "object", "properties": {} }, "RevokeClientIdRequest": { "type": "object", "properties": { "clientId": { "type": "string" }, "tokenId": { "type": "string" } }, "description": "Identifies which machine credential to revoke. Supply either the \u0060client_id\u0060 directly or the \u0060token_id\u0060 from \u0060ListClientIds\u0060. Revoking cascades to all RefreshTokens that were minted via this client_id." }, "RevokeClientIdResponse": { "type": "object", "properties": {}, "description": "Empty acknowledgement that the machine credential and its derived RefreshTokens have been revoked." }, "RevokeRefreshTokenRequest": { "type": "object", "properties": { "refreshToken": { "type": "string" }, "familyId": { "type": "string" } }, "description": "Identifies which RefreshToken (or token family) to revoke. Supply either the concrete \u0060refresh_token\u0060 (logs out one session) or a \u0060family_id\u0060 from \u0060ListSessions\u0060 (logs out all tokens derived from one initial login)." }, "RevokeRefreshTokenResponse": { "type": "object", "properties": {}, "description": "Empty acknowledgement that the revocation has been applied. Subsequent calls with the revoked token will fail authentication." }, "Schema": { "type": "object", "properties": { "nullable": { "type": "boolean" }, "discriminator": { "$ref": "#/components/schemas/Discriminator" }, "readOnly": { "type": "boolean" }, "writeOnly": { "type": "boolean" }, "xml": { "$ref": "#/components/schemas/Xml" }, "externalDocs": { "$ref": "#/components/schemas/ExternalDocs" }, "example": { "$ref": "#/components/schemas/Any" }, "deprecated": { "type": "boolean" }, "title": { "type": "string" }, "multipleOf": { "type": "number", "format": "double" }, "maximum": { "type": "number", "format": "double" }, "exclusiveMaximum": { "type": "boolean" }, "minimum": { "type": "number", "format": "double" }, "exclusiveMinimum": { "type": "boolean" }, "maxLength": { "type": "string" }, "minLength": { "type": "string" }, "pattern": { "type": "string" }, "maxItems": { "type": "string" }, "minItems": { "type": "string" }, "uniqueItems": { "type": "boolean" }, "maxProperties": { "type": "string" }, "minProperties": { "type": "string" }, "required": { "type": "array", "items": { "type": "string" } }, "enum": { "type": "array", "items": { "$ref": "#/components/schemas/Any" } }, "type": { "type": "string" }, "allOf": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaOrReference" } }, "oneOf": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaOrReference" } }, "anyOf": { "type": "array", "items": { "$ref": "#/components/schemas/SchemaOrReference" } }, "not": { "$ref": "#/components/schemas/Schema" }, "items": { "$ref": "#/components/schemas/ItemsItem" }, "properties": { "$ref": "#/components/schemas/Properties" }, "additionalProperties": { "$ref": "#/components/schemas/AdditionalPropertiesItem" }, "default": { "$ref": "#/components/schemas/DefaultType" }, "description": { "type": "string" }, "format": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "The Schema Object allows the definition of input and output data types. These types can be objects, but also primitives and arrays. This object is an extended subset of the JSON Schema Specification Wright Draft 00. For more information about the properties, see JSON Schema Core and JSON Schema Validation. Unless stated otherwise, the property definitions follow the JSON Schema." }, "SchemaOrReference": { "type": "object", "properties": { "schema": { "$ref": "#/components/schemas/Schema" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "SchemasOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedSchemaOrReference" } } } }, "SecurityRequirement": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedStringArray" } } }, "description": "Lists the required security schemes to execute this operation. The name used for each property MUST correspond to a security scheme declared in the Security Schemes under the Components Object. Security Requirement Objects that contain multiple schemes require that all schemes MUST be satisfied for a request to be authorized. This enables support for scenarios where multiple query parameters or HTTP headers are required to convey security information. When a list of Security Requirement Objects is defined on the OpenAPI Object or Operation Object, only one of the Security Requirement Objects in the list needs to be satisfied to authorize the request." }, "SecurityScheme": { "type": "object", "properties": { "type": { "type": "string" }, "description": { "type": "string" }, "name": { "type": "string" }, "in": { "type": "string" }, "scheme": { "type": "string" }, "bearerFormat": { "type": "string" }, "flows": { "$ref": "#/components/schemas/OauthFlows" }, "openIdConnectUrl": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Defines a security scheme that can be used by the operations. Supported schemes are HTTP authentication, an API key (either as a header, a cookie parameter or as a query parameter), mutual TLS (use of a client certificate), OAuth2\u0027s common flows (implicit, password, application and access code) as defined in RFC6749, and OpenID Connect. Please note that currently (2019) the implicit flow is about to be deprecated OAuth 2.0 Security Best Current Practice. Recommended for most use case is Authorization Code Grant flow with PKCE." }, "SecuritySchemeOrReference": { "type": "object", "properties": { "securityScheme": { "$ref": "#/components/schemas/SecurityScheme" }, "reference": { "$ref": "#/components/schemas/Reference" } } }, "SecuritySchemesOrReferences": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedSecuritySchemeOrReference" } } } }, "Server": { "type": "object", "properties": { "url": { "type": "string" }, "description": { "type": "string" }, "variables": { "$ref": "#/components/schemas/ServerVariables" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "An object representing a Server." }, "ServerVariable": { "type": "object", "properties": { "enum": { "type": "array", "items": { "type": "string" } }, "default": { "type": "string" }, "description": { "type": "string" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "An object representing a Server Variable for server URL template substitution." }, "ServerVariables": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedServerVariable" } } } }, "SetAnnex7CarrierTransferRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "carrierTransfer": { "$ref": "#/components/schemas/WasteAnnex7TransportType" } } }, "SetAnnex7CarrierTransferResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060annexvii\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "annexvii": { "allOf": [ { "$ref": "#/components/schemas/AnnexViiDocument" } ], "description": "Current state of the associated Annex VII document (zewass format with ZEDAL extensions),\r\n including the carrier transfer certificate that was just set." } } }, "SetAnnex7CertificateOfCompletionRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "certificateOfCompletion": { "$ref": "#/components/schemas/WasteAnnex7CertificateOfWasteCompletionType" } } }, "SetAnnex7CertificateOfCompletionResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060annexvii\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "annexvii": { "allOf": [ { "$ref": "#/components/schemas/AnnexViiDocument" } ], "description": "Current state of the associated Annex VII document (zewass format with ZEDAL extensions),\r\n including the recovery certificate of completion that was just set." } } }, "SetAnnex7ConsigneeCertificateRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "consigneeCertificate": { "$ref": "#/components/schemas/WasteAnnex7ConsigneeCertificateOfWasteReceiptType" } } }, "SetAnnex7ConsigneeCertificateResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060annexvii\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "annexvii": { "allOf": [ { "$ref": "#/components/schemas/AnnexViiDocument" } ], "description": "Current state of the associated Annex VII document (zewass format with ZEDAL extensions),\r\n including the consignee receipt certificate that was just set." } } }, "SetAnnex7FacilityCertificateRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "facilityCertificate": { "$ref": "#/components/schemas/WasteAnnex7CertificateOfWasteReceiptType" } } }, "SetAnnex7FacilityCertificateResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060annexvii\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "annexvii": { "allOf": [ { "$ref": "#/components/schemas/AnnexViiDocument" } ], "description": "Current state of the associated Annex VII document (zewass format with ZEDAL extensions),\r\n including the facility receipt certificate that was just set." } } }, "SetAnnex7Request": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "announcement": { "$ref": "#/components/schemas/WasteAnnex7DocumentType" } } }, "SetAnnex7Response": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060annexvii\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "annexvii": { "allOf": [ { "$ref": "#/components/schemas/AnnexViiDocument" } ], "description": "Current state of the associated Annex VII document (zewass format with ZEDAL extensions)." } } }, "SetAnnex7TakeBackRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "takeBack": { "$ref": "#/components/schemas/WasteAnnex7TakeBackType" } } }, "SetAnnex7TakeBackResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060annexvii\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "annexvii": { "allOf": [ { "$ref": "#/components/schemas/AnnexViiDocument" } ], "description": "Current state of the associated Annex VII document (zewass format with ZEDAL extensions),\r\n including the take-back that was just initiated." } } }, "SetByIntentRequest": { "type": "object", "properties": { "docXml": { "type": "string", "description": "On initial create: leave empty.", "format": "bytes" }, "intent": { "type": "integer", "description": "Which operation should be executed.", "format": "enum" }, "annexvii": { "$ref": "#/components/schemas/Annex7InformationType" }, "notification": { "$ref": "#/components/schemas/NotificationInformationType" }, "movement": { "$ref": "#/components/schemas/MovementInformationType" } } }, "SetByIntentResponse": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/Document" }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" } } }, "SetCarrierTransportApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "carrierTransport": { "$ref": "#/components/schemas/CarrierTransportDocumentType" } } }, "SetCarrierTransportResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060movement\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "movement": { "allOf": [ { "$ref": "#/components/schemas/MovementDocument" } ], "description": "Current state of the associated movement document (zewass format with ZEDAL extensions),\r\n including the carrier transport data that was just recorded." } } }, "SetConsigneeReceptionApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "consigneeReception": { "$ref": "#/components/schemas/ConsigneeReceptionDocumentType" } } }, "SetConsigneeReceptionResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060movement\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "movement": { "allOf": [ { "$ref": "#/components/schemas/MovementDocument" } ], "description": "Current state of the associated movement document (zewass format with ZEDAL extensions),\r\n including the consignee receipt certificate that was just set." } } }, "SetDecisionRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "decision": { "$ref": "#/components/schemas/DecisionDocumentType" } } }, "SetDecisionResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated \u0060Notifizierung\u0060 (zewass format with ZEDAL extensions) including\r\n the authority decision just recorded." } } }, "SetDocumentParameterResponse": { "type": "object", "properties": {} }, "SetFacilityCompletionApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "facilityCompletion": { "$ref": "#/components/schemas/FacilityCompletionDocumentType" } } }, "SetFacilityCompletionResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060movement\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "movement": { "allOf": [ { "$ref": "#/components/schemas/MovementDocument" } ], "description": "Current state of the associated movement document (zewass format with ZEDAL extensions),\r\n including the recovery/disposal certificate of completion that was just set." } } }, "SetFacilityCompletionUnderArticle15Request": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "certificate": { "$ref": "#/components/schemas/FacilityCompletionUnderArticle15Type" } }, "description": "See Art. 15 and Art. 27(1)(a)(xii) of Regulation (EU) 2024/1157." }, "SetFacilityCompletionUnderArticle15Response": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated notification (zewass format with ZEDAL extensions),\r\n including the Art. 15 certificate of completion that was just set." } } }, "SetFacilityReceptionApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "facilityReception": { "$ref": "#/components/schemas/FacilityReceptionDocumentType" } } }, "SetFacilityReceptionResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060movement\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "movement": { "allOf": [ { "$ref": "#/components/schemas/MovementDocument" } ], "description": "Current state of the associated movement document (zewass format with ZEDAL extensions),\r\n including the facility receipt certificate that was just set." } } }, "SetFileAreaDocumentReceivedResponse": { "type": "object", "properties": {} }, "SetGlobalParameterResponse": { "type": "object", "properties": {} }, "SetInboxDocumentsReadResponse": { "type": "object", "properties": {} }, "SetLocalSubmissionResponse": { "type": "object", "properties": {} }, "SetMovementTakeBackApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "takeBack": { "$ref": "#/components/schemas/MovementTakeBackDocumentType" } } }, "SetMovementTakeBackResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060movement\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "movement": { "allOf": [ { "$ref": "#/components/schemas/MovementDocument" } ], "description": "Current state of the associated movement document (zewass format with ZEDAL extensions)\r\n including the take-back order just issued." } } }, "SetMovementTemplateApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "movementTemplate": { "$ref": "#/components/schemas/MovementTemplateType" } } }, "SetMovementTemplateResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060movement\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "movement": { "allOf": [ { "$ref": "#/components/schemas/MovementDocument" } ], "description": "Current state of the associated movement document (zewass format with ZEDAL extensions),\r\n including the movement template that was just updated." } } }, "SetReplyToRequestInformationRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "reply": { "allOf": [ { "$ref": "#/components/schemas/RequestInformationDocumentType" } ], "description": "Same type as RequestInformation - BXA distinguishes via the intent." } } }, "SetReplyToRequestInformationResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated notification (zewass format with ZEDAL extensions),\r\n including the reply to the request for information that was just set." } } }, "SetRequestForChangeAfterConsentRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "request": { "$ref": "#/components/schemas/RequestForChangeAfterConsentDocumentType" } } }, "SetRequestForChangeAfterConsentResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated notification (zewass format with ZEDAL extensions),\r\n including the request for change after consent that was just submitted." } } }, "SetRequestInformationRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "requestInformation": { "$ref": "#/components/schemas/RequestInformationDocumentType" } } }, "SetRequestInformationResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated \u0060Notifizierung\u0060 (zewass format with ZEDAL extensions) including\r\n the request for information just issued." } } }, "SetSubmissionRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "submission": { "$ref": "#/components/schemas/SubmissionDocumentType" } } }, "SetSubmissionResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated notification (zewass format with ZEDAL extensions),\r\n including the submission that was just set." } } }, "SetTransportDocumentReceivedResponse": { "type": "object", "properties": {} }, "ShipmentOriginAddressType": { "type": "object", "properties": { "partyUuid": { "$ref": "#/components/schemas/StringField" }, "addressDetails": { "$ref": "#/components/schemas/StringField" } }, "description": "Address from which the waste shipment originates. Either references a known party by \u0060party_uuid\u0060 or supplies a free-text \u0060address_details\u0060 string. The two alternatives mirror the XSD choice between a registered party and an ad-hoc unstructured address." }, "ShipmentPeriodType": { "type": "object", "properties": { "firstStartDate": { "$ref": "#/components/schemas/TimestampField" }, "lastStartDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Validity window during which individual shipments may be carried out under a notification. \u0060first_start_date\u0060 is the earliest allowed shipment start; \u0060last_start_date\u0060 is the latest. Both bounds are inclusive." }, "SignalStatementDocumentType": { "type": "object", "properties": { "signal": { "$ref": "#/components/schemas/SignalStatementType" }, "description": { "$ref": "#/components/schemas/DescriptionType" }, "signature": { "$ref": "#/components/schemas/SignatureType" } }, "description": "Wraps a SignalStatementType with an optional human description and the signing operator\u0027s signature. Submitted as the payload of NotificationSignalDocumentType." }, "SignalStatementType": { "type": "object", "properties": { "typeCode": { "$ref": "#/components/schemas/StringField" } }, "description": "Lifecycle signal raised against a notification or movement \u2014 e.g. \u0060ProperlyCarriedOut\u0060, \u0060NotificationCancelled\u0060, \u0060NotificationWithdrawn\u0060. The signal type drives downstream state transitions in DIWASS." }, "SignatureType": { "type": "object", "properties": { "name": { "$ref": "#/components/schemas/StringField" }, "organizationRole": { "$ref": "#/components/schemas/StringField" }, "timestamp": { "$ref": "#/components/schemas/TimestampField" }, "emailUri": { "$ref": "#/components/schemas/StringField" }, "signature": { "$ref": "#/components/schemas/StringField" } }, "description": "Digital or written signature attached to a DIWASS declaration: who signed, in which organisational role, when, and (optionally) the cryptographic signature value plus a contact email." }, "SpecificConditionsType": { "type": "object", "properties": { "specificConditionDescription": { "$ref": "#/components/schemas/DescriptionType" }, "consentValidMass": { "$ref": "#/components/schemas/MassMeasureType" }, "consentValidVolume": { "$ref": "#/components/schemas/VolumeMeasureType" }, "consentValidShipmentCount": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Specific conditions attached to a competent authority\u0027s CONSENT decision. May restrict the consent to a smaller mass, volume or shipment count than the originally notified amount, and may carry a free-text condition description." }, "StatementDocumentType": { "type": "object", "properties": { "notificationId": { "$ref": "#/components/schemas/StringField" }, "statement": { "$ref": "#/components/schemas/StatementType" }, "signature": { "$ref": "#/components/schemas/SignatureType" } }, "description": "Top-level statement document referencing an existing notification, the actual statement and a signature. Used to attach textual statements (objections, comments) to a notification process and authenticate them via signature." }, "StatementType": { "type": "object", "properties": { "priorityCode": { "$ref": "#/components/schemas/StringField" }, "statement": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Statement block \u2014 a textual comment or objection associated with a notification or shipment, classified by priority code (1 = high, 2 = medium, 3 = low). Used by competent authorities and operators to attach observations to a regulated process." }, "StreetAddress": { "type": "object", "properties": { "name1": { "type": "string" }, "name2": { "type": "string" }, "name3": { "type": "string" }, "name4": { "type": "string" }, "streetName1": { "type": "string" }, "streetName2": { "type": "string" }, "buildingNumber": { "type": "string" }, "cityName1": { "type": "string" }, "cityName2": { "type": "string" }, "postCode": { "type": "string" }, "countryId": { "$ref": "#/components/schemas/CountryCode" } }, "description": "a single address block" }, "StringArray": { "type": "object", "properties": { "value": { "type": "array", "items": { "type": "string" } } } }, "StringField": { "type": "object", "properties": { "value": { "type": "string" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } }, "description": "Pairs the primitive type \u0060string\u0060 with its meta information." }, "Strings": { "type": "object", "properties": { "additionalProperties": { "type": "array", "items": { "$ref": "#/components/schemas/NamedString" } } } }, "SubmissionDocumentType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/BaseSubmissionDocumentType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Top-level submission document sent by a notifier or its representative when creating or updating a notification. Wraps the BaseSubmissionDocumentType plus any linked attachments." }, "SubmissionOperationResponse": { "type": "object", "properties": { "responseStatus": { "$ref": "#/components/schemas/WasteWebServiceResponse" }, "notificationId": { "$ref": "#/components/schemas/StringField" } }, "description": "Generic submission-service response. Returned by Create/Update operations on a notification submission. Carries the validation outcome and, on success, the DIWASS-assigned NotificationId." }, "SubmissionType": { "type": "object", "properties": { "notifier": { "$ref": "#/components/schemas/WasteOperatorType" }, "consignee": { "$ref": "#/components/schemas/WasteOperatorType" }, "individualShipmentIndicator": { "$ref": "#/components/schemas/BoolField" }, "destinedForRecoveryDisposal": { "$ref": "#/components/schemas/StringField" }, "preConsentIndicator": { "$ref": "#/components/schemas/BoolField" }, "shipmentQuantity": { "$ref": "#/components/schemas/Int32Field" }, "totalWasteMeasurement": { "$ref": "#/components/schemas/NotificationMassVolumeMeasureType" }, "shipmentPeriod": { "$ref": "#/components/schemas/ShipmentPeriodType" }, "packaging": { "$ref": "#/components/schemas/PackagingType" }, "customsCodesHs": { "$ref": "#/components/schemas/CustomsCodesType" }, "shipmentOriginAddress": { "$ref": "#/components/schemas/ShipmentOriginAddressType" }, "carrier": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierType" } }, "wasteProducer": { "type": "array", "items": { "$ref": "#/components/schemas/WasteProducerType" } }, "recoveryDisposalFacility": { "type": "array", "items": { "$ref": "#/components/schemas/RecoveryDisposalFacilityType" } }, "disposalRecoveryOperations": { "$ref": "#/components/schemas/DisposalRecoveryOperations" }, "wasteDesignationDescription": { "$ref": "#/components/schemas/DescriptionType" }, "physicalCharacteristicTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "physicalCharacteristicDescription": { "$ref": "#/components/schemas/DescriptionType" }, "wasteClassification": { "$ref": "#/components/schemas/WasteClassificationType" }, "exportState": { "$ref": "#/components/schemas/ExportStateType" }, "importState": { "$ref": "#/components/schemas/ImportStateType" }, "transitState": { "type": "array", "items": { "$ref": "#/components/schemas/TransitStateType" } }, "customsOfficeEntryName": { "$ref": "#/components/schemas/StringField" }, "customsOfficeExitName": { "$ref": "#/components/schemas/StringField" }, "customsOfficeExportName": { "$ref": "#/components/schemas/StringField" }, "altRouteCustomsOfficeEntryName": { "$ref": "#/components/schemas/StringField" }, "altRouteCustomsOfficeExitName": { "$ref": "#/components/schemas/StringField" }, "altRouteCustomsOfficeExportName": { "$ref": "#/components/schemas/StringField" }, "annexQuantity": { "$ref": "#/components/schemas/Int32Field" } }, "description": "Core notification payload describing a planned transboundary waste shipment: involved parties (notifier, consignee, carriers, producers), the waste (classification, packaging, quantity), recovery/disposal facilities and operations, route information (export/import/transit states, customs offices) and the planned shipment period." }, "SubmitAcknowledgementRequest": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/AcknowledgementDocumentType" } }, "description": "Request submitted by a competent authority to record an acknowledgement of the notification (Article 8 WSR)." }, "SubmitAcknowledgementResponse": { "type": "object", "properties": { "document": { "allOf": [ { "$ref": "#/components/schemas/Document" } ], "description": "Deprecated: use the typed \u0060notification\u0060 field instead." }, "docXml": { "type": "string", "format": "bytes" }, "followupIntents": { "type": "array", "items": { "type": "integer", "format": "enum" } }, "validationErrors": { "$ref": "#/components/schemas/ValidationErrors" }, "notification": { "allOf": [ { "$ref": "#/components/schemas/NotificationDocument" } ], "description": "Current state of the associated \u0060Notifizierung\u0060 (zewass format with ZEDAL extensions) including\r\n the acknowledgement of receipt just recorded." } } }, "SubmitMovementSignalApiRequest": { "type": "object", "properties": { "docXml": { "type": "string", "format": "bytes" }, "signal": { "$ref": "#/components/schemas/MovementSignalDocumentType" } } }, "SubmitMovementSignalResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/MovementTemplateOperationResponse" } }, "description": "Response wrapper for SubmitMovementSignalRequest." }, "SubmitNotificationSignalRequest": { "type": "object", "properties": { "document": { "$ref": "#/components/schemas/NotificationSignalDocumentType" } }, "description": "Request to submit a notification-level signal (e.g. notification cancelled, properly carried out, properly completed) on behalf of the notifier or a competent authority." }, "SubmitNotificationSignalResponse": { "type": "object", "properties": { "response": { "$ref": "#/components/schemas/NotificationSignalResponseType" } }, "description": "Response wrapper for SubmitNotificationSignalRequest." }, "Tag": { "type": "object", "properties": { "name": { "type": "string" }, "description": { "type": "string" }, "externalDocs": { "$ref": "#/components/schemas/ExternalDocs" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "Adds metadata to a single tag that is used by the Operation Object. It is not mandatory to have a Tag Object per tag defined in the Operation Object instances." }, "TextType": { "type": "object", "properties": { "value": { "$ref": "#/components/schemas/StringField" }, "languageId": { "$ref": "#/components/schemas/StringField" }, "languageLocaleId": { "$ref": "#/components/schemas/StringField" } }, "description": "UN/CEFACT Unqualified Data Type representing a free-text string with optional language and locale metadata. Used wherever a textual value may carry language information (e.g. localized names, descriptions)." }, "TimestampField": { "type": "object", "properties": { "value": { "type": "string", "format": "date-time" }, "meta": { "$ref": "#/components/schemas/FieldMeta" } }, "description": "Pairs Google\u0027s \u0060Timestamp\u0060 type with its meta information." }, "TransferEntry": { "type": "object", "properties": { "occurredAt": { "type": "string", "description": "Timestamp of the delivery attempt (UTC).", "format": "date-time" }, "success": { "type": "boolean", "description": "True if the delivery completed successfully;\r\n false if the delivery failed (\u0060error\u0060 set)." }, "requestName": { "type": "string", "description": "Name of the triggering request (e.g. \u0022SetSubmission\u0022,\r\n \u0022SubmitAcknowledgement\u0022). Identifies which operation caused the\r\n delivery attempt \u2014 without carrying the XML payload along." }, "error": { "allOf": [ { "$ref": "#/components/schemas/ErrorInfo" } ], "description": "Error details \u2014 set exactly when \u0060success == false\u0060." } }, "description": "Single attempted BXA delivery to the DIWASS backend. Captures the attempt timestamp, the originating request name (e.g. \u0060SetSubmission\u0060), success/failure flag and \u2014 on failure \u2014 structured error details. Multiple entries form the transfer history of a document; the latest entry\u0027s \u0060success\u0060 field indicates the current delivery state." }, "TransitStateType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/ConcernedCountryType" }, "entryPointName": { "$ref": "#/components/schemas/StringField" }, "exitPointName": { "$ref": "#/components/schemas/StringField" } }, "description": "State of transit for a transboundary waste shipment. Extends ConcernedCountryType with both the entry and exit customs points used to traverse the transit country." }, "TransportAnnouncementType": { "type": "object", "properties": { "actualQuantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "startDate": { "$ref": "#/components/schemas/TimestampField" }, "packaging": { "$ref": "#/components/schemas/MovementPackagingType" }, "carrier": { "type": "array", "items": { "$ref": "#/components/schemas/CarrierType" } }, "additionalInformation": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Announcement of a single transport within a waste shipment movement. Contains the actual transported quantity, the planned start date, packaging information, the carriers performing the transport and optional free-text additional information." }, "TransportType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/WasteOperatorType" }, "meansOfTransportCode": { "$ref": "#/components/schemas/StringField" }, "vehicleId": { "type": "array", "items": { "$ref": "#/components/schemas/StringField" } }, "transferDate": { "$ref": "#/components/schemas/TimestampField" }, "additionalInformation": { "$ref": "#/components/schemas/DescriptionType" }, "declarationCarrierTransfer": { "$ref": "#/components/schemas/DeclarationType" } }, "description": "Single transport leg of a movement: who carried it, by which means, with which vehicle(s), on which date, plus an optional additional information block and the carrier\u0027s transfer declaration." }, "UnregisterGroupRequest": { "type": "object", "properties": { "groupId": { "type": "string" }, "groupSecret": { "type": "string" } } }, "UnregisterGroupResponse": { "type": "object", "properties": { "success": { "type": "boolean" } } }, "UsernameCredentials": { "required": [ "subscriberId", "accountId", "password" ], "type": "object", "properties": { "subscriberId": { "type": "string" }, "accountId": { "type": "string" }, "password": { "type": "string" } }, "description": "Human-user credentials: a subscriber-scoped account identified by \u0060subscriber_id\u0060 \u002B \u0060account_id\u0060 plus the account\u0027s password. Used in \u0060IssueRefreshToken\u0060 for interactive logins and in \u0060IssueClientId\u0060 to authorize issuing a machine credential." }, "ValidationError": { "type": "object", "properties": { "path": { "type": "string", "description": "Object path to the offending location in the document." }, "error": { "type": "string", "description": "Error message for this path." } }, "description": "Single schema-validation finding: an object path into the document plus a human-readable error message. Path notation is JSONPath-style on proto field names; consumers can use it to highlight the offending field in their UI." }, "ValidationErrors": { "type": "object", "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationError" } } }, "description": "Schema-validation result carried in every DIWASS BXA API response. Empty list = document is schema-conformant; non-empty list = per-entry (path, error) tuples. Validation errors do not fail the RPC \u2014 they are returned alongside the regular response payload so the consumer can react in-line." }, "VolumeMeasureType": { "type": "object", "properties": { "cubicMeters": { "$ref": "#/components/schemas/DoubleField" } }, "description": "Volume measurement expressed in cubic meters. Supports up to 5 decimal places." }, "WasteAnnex7CertificateOfWasteCompletionType": { "type": "object", "properties": { "movement": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "certificateOfWasteCompletion": { "$ref": "#/components/schemas/Annex7CertificateOfCompletionType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Facility\u0027s certificate of completion confirming that recovery or disposal of a received waste shipment has been completed (\u0060Verwertungs-/Beseitigungsnachweis\u0060). Closes the chain of custody for an Annex VII shipment leg." }, "WasteAnnex7CertificateOfWasteReceiptType": { "type": "object", "properties": { "movement": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/Annex7CertificateOfWasteReceiptType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Facility\u0027s certificate confirming receipt of waste at the recovery/disposal facility (\u0060\u00DCbernahmebescheinigung\u0060). Issued by the receiving facility after acceptance; includes accepted/rejected quantities and rejection reasons where applicable." }, "WasteAnnex7ConsigneeCertificateOfWasteReceiptType": { "type": "object", "properties": { "movement": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "certificateOfWasteReceipt": { "$ref": "#/components/schemas/CertificateOfWasteReceiptBaseType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Consignee\u0027s certificate confirming the receipt of a transported waste shipment leg. Issued by the consignee operator after a movement has arrived; used by the arranger and competent authorities to track shipment status." }, "WasteAnnex7DocumentType": { "type": "object", "properties": { "annexViiDocumentNo": { "$ref": "#/components/schemas/StringField" }, "takeBackIndication": { "$ref": "#/components/schemas/BoolField" }, "illegalActivityIndication": { "$ref": "#/components/schemas/BoolField" }, "referenceNotificationNo": { "$ref": "#/components/schemas/StringField" }, "referenceMovementNo": { "$ref": "#/components/schemas/StringField" }, "referenceAnnexViiDocumentNo": { "$ref": "#/components/schemas/StringField" }, "shipmentArrangerIsAlsoProducerOrCollector": { "$ref": "#/components/schemas/BoolField" }, "transportAnnouncement": { "$ref": "#/components/schemas/Annex7TransportAnnouncementType" }, "declarationArranger": { "$ref": "#/components/schemas/DeclarationType" }, "declarationProducer": { "type": "array", "items": { "$ref": "#/components/schemas/DeclarationType" } }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Initial Annex VII document declaring a single transboundary waste shipment under the EU Waste Shipment Regulation. Carries the Annex VII number, indicators for take-back / illegal activity, references to related notification / movement / Annex VII documents, the transport announcement and the declarations of the parties involved (arranger, producer)." }, "WasteAnnex7ServiceFault": { "type": "object", "properties": { "errorMessage": { "$ref": "#/components/schemas/StringField" } }, "description": "Service-level fault returned when an Annex VII operation cannot be processed at all (e.g. authentication failure, malformed request, backend unreachable). Distinct from field-level validation errors carried in the response wrappers." }, "WasteAnnex7TakeBackType": { "type": "object", "properties": { "movement": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "quantity": { "$ref": "#/components/schemas/MassVolumeMeasureType" }, "statement": { "$ref": "#/components/schemas/DescriptionType" }, "takeBackDate": { "$ref": "#/components/schemas/TimestampField" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Take-back document for an Annex VII shipment that could not be completed at the consignee and is being returned. Captures the take-back quantity, justification statement and the return transport date." }, "WasteAnnex7TransportType": { "type": "object", "properties": { "movement": { "$ref": "#/components/schemas/Annex7MovementDocumentIdentifierType" }, "transport": { "$ref": "#/components/schemas/TransportType" }, "linkedAttachments": { "$ref": "#/components/schemas/LinkedAttachType" } }, "description": "Transport-leg document for an existing Annex VII shipment. Captures the typed transport information (actual quantities, dates, packaging, carriers) plus optional linked attachments. Created/updated separately from the parent Annex VII document for each leg." }, "WasteClassificationType": { "type": "object", "properties": { "wasteTypeCode": { "type": "array", "items": { "$ref": "#/components/schemas/WasteCodeType" } } }, "description": "Aggregate of one or more waste classification codes describing the waste type from different perspectives (e.g. Basel and EWC simultaneously)." }, "WasteCodeType": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/StringField" }, "listId": { "$ref": "#/components/schemas/StringField" } }, "description": "Single waste classification code with the identifier of its source list (Basel/OECD/EWC/national list). The pair (\u0060code\u0060, \u0060list_id\u0060) uniquely identifies the entry." }, "WasteEventType": { "type": "object", "properties": { "identifier": { "$ref": "#/components/schemas/EventIdentifierType" }, "code": { "$ref": "#/components/schemas/StringField" }, "description": { "$ref": "#/components/schemas/StringField" }, "eventDate": { "$ref": "#/components/schemas/TimestampField" } }, "description": "Single waste-domain event published by DIWASS. Carries the event identifier, an event-type code from the ModificationEventCode codelist (notification / movement / Annex-7 / signal lifecycle), an optional human-readable description and the event timestamp." }, "WasteMessageDescription": { "type": "object", "properties": { "code": { "$ref": "#/components/schemas/StringField" }, "description": { "$ref": "#/components/schemas/LanguageDescriptionType" } }, "description": "Single error or warning entry returned in a WasteWebServiceResponse. Pairs a stable code with an optional multi-language description so clients can drive logic on the code while still showing localised text to users." }, "WasteOperatorType": { "type": "object", "properties": { "partyUuid": { "$ref": "#/components/schemas/StringField" }, "contact": { "$ref": "#/components/schemas/ContactType" }, "operatorInternalId": { "$ref": "#/components/schemas/Int64Field" } }, "description": "Operator (legal entity) participating in a waste-shipment workflow: notifier, consignee, carrier, producer, recovery/disposal facility, etc. Identified by \u0060party_uuid\u0060 and the operator-internal id; optionally carries contact info." }, "WasteProducerType": { "type": "object", "properties": { "base": { "$ref": "#/components/schemas/WasteOperatorType" }, "siteDescription": { "$ref": "#/components/schemas/DescriptionType" }, "processDescription": { "$ref": "#/components/schemas/DescriptionType" } }, "description": "Operator producing the waste at source. Extends WasteOperatorType with mandatory site and process descriptions detailing where and how the waste arose." }, "WasteWebServiceResponse": { "type": "object", "properties": { "statusCode": { "$ref": "#/components/schemas/StringField" }, "errors": { "type": "array", "items": { "$ref": "#/components/schemas/WasteMessageDescription" } }, "warnings": { "type": "array", "items": { "$ref": "#/components/schemas/WasteMessageDescription" } } }, "description": "Standard response from a DIWASS web service call. Indicates the processing outcome (\u0060OK\u0060 / \u0060NOTOK\u0060 / \u0060WARNING\u0060) and carries any errors or warnings raised by server-side validation. A \u0060NOTOK\u0060 response means the submitted document was rejected; a \u0060WARNING\u0060 response means the document was accepted but contains issues the caller should review." }, "WsseCredentials": { "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "description": "WSSE credentials used to authenticate against the DIWASS SOAP backend.\r\n Passed per request so that the gateway can serve multiple users." }, "Xml": { "type": "object", "properties": { "name": { "type": "string" }, "namespace": { "type": "string" }, "prefix": { "type": "string" }, "attribute": { "type": "boolean" }, "wrapped": { "type": "boolean" }, "specificationExtension": { "type": "array", "items": { "$ref": "#/components/schemas/NamedAny" } } }, "description": "A metadata object that allows for more fine-tuned XML model definitions. When using arrays, XML element names are *not* inferred (for singular/plural forms) and the \u0060name\u0060 property SHOULD be used to add that information. See examples for expected behavior." }, "ZedalAnnexViiType": { "type": "object", "properties": { "addresses": { "$ref": "#/components/schemas/DiwassAddressType" }, "declarationArranger": { "$ref": "#/components/schemas/DeclarationType" }, "declarationConsignee": { "$ref": "#/components/schemas/DeclarationType" }, "declarationFacility": { "$ref": "#/components/schemas/DeclarationType" }, "zusatzdaten": { "$ref": "#/components/schemas/Zusatzdaten" }, "dateianhang": { "type": "array", "items": { "$ref": "#/components/schemas/DateianhangTyp" } }, "preliminaryMovementIdentifier": { "$ref": "#/components/schemas/StringField" }, "commPartners": { "type": "array", "items": { "$ref": "#/components/schemas/CommPartner" } } }, "description": "ZEDAL-specific aggregate that bundles the addresses and the arranger/consignee/facility declarations of an Annex VII shipment into a single structure for the ZEDAL block envelope." }, "ZedalMovementType": { "type": "object", "properties": { "addresses": { "$ref": "#/components/schemas/DiwassMovementAddressType" }, "zusatzdaten": { "$ref": "#/components/schemas/Zusatzdaten" }, "dateianhang": { "type": "array", "items": { "$ref": "#/components/schemas/DateianhangTyp" } }, "preliminaryMovementIdentifier": { "$ref": "#/components/schemas/StringField" }, "commPartners": { "type": "array", "items": { "$ref": "#/components/schemas/CommPartner" } } } }, "ZedalNotificationType": { "type": "object", "properties": { "addresses": { "$ref": "#/components/schemas/DiwassNotificationAddressType" }, "zusatzdaten": { "$ref": "#/components/schemas/Zusatzdaten" }, "commPartners": { "type": "array", "items": { "$ref": "#/components/schemas/CommPartner" } }, "dateianhang": { "type": "array", "items": { "$ref": "#/components/schemas/DateianhangTyp" } } }, "description": "ZEDAL-specific aggregate that bundles the notification addresses, ZEDAL business metadata (Zusatzdaten \u2014 operator numbers, internal references) and attached files (Dateianh\u00E4nge) for the notification block envelope." }, "Zusatzdaten": { "type": "object", "properties": { "dvCode": { "$ref": "#/components/schemas/DVCode" }, "betriebsnummern": { "$ref": "#/components/schemas/Betriebsnummern" }, "cancelled": { "$ref": "#/components/schemas/BoolField" } }, "description": "\u0060Zusatzdaten\u0060." } }, "securitySchemes": { "AccessToken": { "type": "apiKey", "description": "Short-lived bearer token (typically minutes) used to authenticate **every** ZEDAL API call except \u0060AuthApi.IssueRefreshToken\u0060 and \u0060AuthApi.RequestAccess\u0060. Obtained via \u0060AuthApi.RequestAccess\u0060 by exchanging a \u0060RefreshToken\u0060. Carry it in the request as \u0060Authorization: Bearer \u003Caccess-token\u003E\u0060. Once expired, fetch a new one via \u0060RequestAccess\u0060 \u2014 do not re-login.", "name": "Authorization", "in": "header" }, "RefreshToken": { "type": "apiKey", "description": "Long-lived bearer token used **only** to authenticate \u0060AuthApi.RequestAccess\u0060. Obtained via \u0060AuthApi.IssueRefreshToken\u0060 on initial login. Carry it in the request as \u0060Authorization: Bearer \u003Crefresh-token\u003E\u0060. **Rotation:** every successful \u0060RequestAccess\u0060 call invalidates the presented RefreshToken and returns a new one \u2014 the new RefreshToken must be used for the next \u0060RequestAccess\u0060. Keep the RefreshToken in secure storage (it grants the ability to mint new AccessTokens).", "name": "Authorization", "in": "header" } } }, "security": [ { "AccessToken": [] } ], "tags": [ { "name": "AttachmentApi", "description": "Service that handles attachment related functions.\r\n WSDL: WasteAttachWebServiceV1 (operations: submitAttach, getAttach)" }, { "name": "AuthApi", "description": "Authentication endpoint of the ZEDAL platform. Implements a three-stage token flow:\r\n\r\n 1. \u0060IssueRefreshToken\u0060 (login): client sends \u0060UsernameCredentials\u0060 (user) or\r\n \u0060ClientIdCredentials\u0060 (machine) plus an \u0060app_token\u0060 issued by the API operator\r\n and receives a long-lived RefreshToken (JWT). Called unauthenticated.\r\n 2. \u0060RequestAccess\u0060: client sends the RefreshToken (\u0060Authorization: Bearer \u2026\u0060,\r\n security scheme \u0060RefreshToken\u0060) and receives a short-lived AccessToken **plus a\r\n new RefreshToken**. The presented RefreshToken is invalidated \u2014 this rotation\r\n is required for security; clients must persist the new RefreshToken for the\r\n next call.\r\n 3. All other ZEDAL API calls authenticate with the AccessToken (security scheme\r\n \u0060AccessToken\u0060, set as document-level default).\r\n\r\n Scopes (e.g. \u0060usermgt\u0060) are attached at login time based on the \u0060app_token\u0060 and\r\n the account\u0027s subscriber assignment, and carried in the AccessToken claims.\r\n Several \u0060AuthApi\u0060 management operations themselves require scope \u0060usermgt\u0060." }, { "name": "AuthorityApi", "description": "Service that handles authority directory related functions." }, { "name": "AuthorityDocumentApi", "description": "Document operations for competent authorities (Beh\u00F6rden) under the EU Waste\r\n Shipment Regulation. Authorities issue acknowledgements, decisions, requests\r\n for information, requests for change after consent and signal documents on\r\n DIWASS notification and movement documents. Complementary to\r\n \u0060CompanyDocumentApi\u0060, which covers the company-side document operations." }, { "name": "CommonApi", "description": "Cross-cutting tenant operations that don\u0027t belong to a specific document or\r\n master-data domain. Currently used for tenant-wide global parameters\r\n (configuration values, feature flags) that affect how documents are processed\r\n or validated." }, { "name": "CompanyDocumentApi", "description": "Document operations for companies and ERP clients under the EU Waste Shipment\r\n Regulation. Notifying parties (arrangers, consignees, facilities) submit,\r\n update and supplement shipment notifications, transport announcements,\r\n certificates and statements. Complementary to \u0060AuthorityDocumentApi\u0060 on the\r\n regulator side.\r\n\r\n Conventions:\r\n Create* = initial document creation (no doc_xml)\r\n Set* = typed Set call (always with doc_xml)\r\n Server determines the intent automatically from the document state:\r\n No block of this type yet -\u003E submit/create intent\r\n Block already present -\u003E update/correction intent\r\n SetByIntent = generic alternative with the full retrieval document (UI-friendly)" }, { "name": "DiscoveryApi", "description": "Provider discovery for clients that need to know which ZEDAL provider serves\r\n which region, document domain or tenant. Returns the available providers and\r\n their endpoint metadata so SDK clients can pick the right backend before\r\n authenticating against it." }, { "name": "DocumentApi", "description": "Read and write operations on ZEDAL documents: get by identifier, list by\r\n criteria, create, update, delete and lifecycle transitions. Documents are the\r\n central artifact of the ZEDAL platform (Entsorgungsnachweis, Begleitschein,\r\n Annex-VII shipment, \u2026) and link to operators, master data and attached files." }, { "name": "DocumentTemplateApi", "description": "Reusable document templates (Muster) that operators apply when creating new\r\n documents. Templates carry default values for transport, waste classification\r\n and parties to reduce manual data entry on recurring shipments. Supports\r\n import, listing and application to a new document." }, { "name": "FileApi", "description": "File management for binary attachments referenced from ZEDAL documents\r\n (signed PDFs, scans, supporting evidence). Handles upload, metadata read,\r\n download and lifecycle of files; the file IDs returned here are referenced\r\n from document attachment fields." }, { "name": "MasterdataApi", "description": "Tenant-scoped master data referenced from documents and templates: addresses,\r\n operators, waste catalog entries, transport vehicle data and other reference\r\n data that has its own lifecycle independent of individual documents." }, { "name": "OperatorApi", "description": "Service that handles operator related functions." }, { "name": "PreviewApi", "description": "Read-only list/search views over ZEDAL documents and master data, optimised\r\n for UI tables and quick lookups. Distinct from \u0060DocumentApi.GetDocument\u0060,\r\n which returns the full typed document \u2014 \u0060PreviewApi\u0060 returns lightweight\r\n per-row summaries plus the fields needed to filter, sort and paginate." }, { "name": "RegisteredGroupAuthApi", "description": "Funktionsaufrufe auf diesem Service ben\u00F6tigen keine JWT Authentisierung.\r\n Fehlerf\u00E4lle (gRPC Status):\r\n - AlreadyExists (RegisterGroup), NotFound (UnregisterGroup/Login), PermissionDenied (UnregisterGroup), Unauthenticated (Login)" }, { "name": "RetrievalApi", "description": "Service that handles waste retrieval/lookup related functions.\r\n WSDL: WasteLookupWebServiceV1\r\n Umfang: LookupEventList, LookupSyncNotification, GetAllMovements, GetAllAnnex7" } ], "externalDocs": { "description": "ZEDAL Developer Documentation", "url": "https://docs.live.zedal.de" }, "x-tagGroups": [ { "name": "Core", "tags": [ "AuthApi", "CommonApi", "DocumentApi", "DocumentTemplateApi", "FileApi", "MasterdataApi", "PreviewApi" ] }, { "name": "DIWASS", "tags": [ "AuthorityApi", "AttachmentApi", "OperatorApi", "RetrievalApi" ] }, { "name": "BXA-DIWASS", "tags": [ "AuthorityDocumentApi", "CompanyDocumentApi" ] }, { "name": "Utility", "tags": [ "DiscoveryApi" ] } ] }