ListInboxDocuments()¶

<ListTransportDocuments>
    <sessionid>...</sessionid>
    <qpar>
        <fieldmask>
            <!-- Zero or more repetitions: -->
            <item>...</item>
        </fieldmask>
        <!-- Zero or more repetitions: -->
        <filter>
            <path>...</path>
            <op>
                <!-- Choice from: -->
                equal
                not_equal
                null
                not_null
                contains
                begins_with
                ends_with
                less
                greater
                less_or_equal
                greater_or_equal
                between
                in_list
            </op>
            <!-- Zero or more repetitions: -->
            <operands>
                <!-- Choice from: -->
                <s>...</s>
                <i>...</i>
                <n>...</n>
                <d>...</d>
                <utc>...</utc>
                <dt>...</dt>
            </operands>
        </filter>
        <!-- Zero or more repetitions: -->
        <sort>
            <path>...</path>
            <direction>
                <!-- Choice from: -->
                asc
                desc
            </direction>
        </sort>
        <!-- Optional: -->
        <page_start>...</page_start>
        <!-- Optional: -->
        <page_size>...</page_size>
    </qpar>
    <!-- Optional: -->
    <speedup-preselection>...</speedup-preselection>
</ListTransportDocuments>

<ListFileAreaDocuments>
    <sessionid>...</sessionid>
    <qpar>
        <fieldmask>
            <!-- Zero or more repetitions: -->
            <item>...</item>
        </fieldmask>
        <!-- Zero or more repetitions: -->
        <filter>
            <path>...</path>
            <op>
                <!-- Choice from: -->
                equal
                not_equal
                null
                not_null
                contains
                begins_with
                ends_with
                less
                greater
                less_or_equal
                greater_or_equal
                between
                in_list
            </op>
            <!-- Zero or more repetitions: -->
            <operands>
                <!-- Choice from: -->
                <s>...</s>
                <i>...</i>
                <n>...</n>
                <d>...</d>
                <utc>...</utc>
                <dt>...</dt>
            </operands>
        </filter>
        <!-- Zero or more repetitions: -->
        <sort>
            <path>...</path>
            <direction>
                <!-- Choice from: -->
                asc
                desc
            </direction>
        </sort>
        <!-- Optional: -->
        <page_start>...</page_start>
        <!-- Optional: -->
        <page_size>...</page_size>
    </qpar>
    <!-- Optional: -->
    <speedup-preselection>...</speedup-preselection>
</ListFileAreaDocuments>

<ListInboxDocuments>
    <sessionid>...</sessionid>
    <qpar>
        <fieldmask>
            <!-- Zero or more repetitions: -->
            <item>...</item>
        </fieldmask>
        <!-- Zero or more repetitions: -->
        <filter>
            <path>...</path>
            <op>
                <!-- Choice from: -->
                equal
                not_equal
                null
                not_null
                contains
                begins_with
                ends_with
                less
                greater
                less_or_equal
                greater_or_equal
                between
                in_list
            </op>
            <!-- Zero or more repetitions: -->
            <operands>
                <!-- Choice from: -->
                <s>...</s>
                <i>...</i>
                <n>...</n>
                <d>...</d>
                <utc>...</utc>
                <dt>...</dt>
            </operands>
        </filter>
        <!-- Zero or more repetitions: -->
        <sort>
            <path>...</path>
            <direction>
                <!-- Choice from: -->
                asc
                desc
            </direction>
        </sort>
        <!-- Optional: -->
        <page_start>...</page_start>
        <!-- Optional: -->
        <page_size>...</page_size>
    </qpar>
    <!-- Optional: -->
    <speedup-preselection>...</speedup-preselection>
</ListInboxDocuments>

Beschreibung¶

Die Aufrufe liefern Übersichtsdaten zu Dokumenten im ZEDAL-Dokumentenbestand. Für jeden Hauptbereich (Transportdokumente / Nachweis-Bereich / Inbox) gibt es eine Funktion. Mit dem optionalen Parameter speedup-preselection lässt sich die Menge der Dokumente auf einen Zeitraum begrenzen; die Abfrage wird dadurch schneller.

Verfügbare Felder (`<fieldmask>` / `<path>`):¶

doc.document_id
doc.last_changed
doc.cancelled
doc.document_type
doc.current_layer
doc.sequence_number
doc.notification_id
doc.transport_weight
doc.transport_volume
doc.waste_type_code
doc.notes
doc.handover_date
doc.internal_name
doc.waste_producer_number
doc.waste_producer_name1
doc.waste_producer_name2
doc.waste_producer_city1
doc.waste_producer_street1
doc.waste_producer_internal_name
doc.waste_producer_site_number
doc.waste_producer_code
doc.waste_producer_sig1_name
doc.waste_producer_sig1_time
doc.waste_producer_sig1_cstat
doc.waste_producer_sig2_name
doc.waste_producer_sig2_time
doc.waste_producer_sig2_cstat
doc.takeover_date
doc.carrier1_number
doc.carrier1_name1
doc.carrier1_name2
doc.carrier1_city1
doc.carrier1_street1
doc.carrier1_truck
doc.carrier1_trailer
doc.carrier1_internal_name
doc.carrier1_code
doc.carrier1_site_number
doc.carrier1_sig1_name
doc.carrier1_sig1_time
doc.carrier1_sig1_cstat
doc.carrier1_sig2_name
doc.carrier1_sig2_time
doc.carrier1_sig2_cstat
doc.acceptance_date
doc.recovery_disposal_facility_number
doc.recovery_disposal_facility_name1
doc.recovery_disposal_facility_name2
doc.recovery_disposal_facility_city1
doc.recovery_disposal_facility_street1
doc.recovery_disposal_facility_acceptance_refused
doc.recovery_disposal_facility_internal_name
doc.recovery_disposal_facility_site_number
doc.recovery_disposal_facility_code
doc.recovery_disposal_facility_sig1_name
doc.recovery_disposal_facility_sig1_time
doc.recovery_disposal_facility_sig1_cstat
doc.recovery_disposal_facility_sig2_name
doc.recovery_disposal_facility_sig2_time
doc.recovery_disposal_facility_sig2_cstat
doc.carrier2_number
doc.carrier2_name1
doc.carrier2_name2
doc.carrier2_city1
doc.carrier2_street1
doc.carrier2_truck
doc.carrier2_trailer
doc.carrier2_site_number
doc.carrier2_sig1_name
doc.carrier2_sig1_time
doc.carrier2_sig1_cstat
doc.carrier2_sig2_name
doc.carrier2_sig2_time
doc.carrier2_sig2_cstat
doc.carrier3_number
doc.carrier3_name1
doc.carrier3_name2
doc.carrier3_city1
doc.carrier3_street1
doc.carrier3_truck
doc.carrier3_trailer
doc.carrier3_site_number
doc.carrier3_sig1_name
doc.carrier3_sig1_time
doc.carrier3_sig1_cstat
doc.carrier3_sig2_name
doc.carrier3_sig2_time
doc.carrier3_sig2_cstat
doc.temporary_storage_number
doc.temporary_storage_name1
doc.temporary_storage_name2
doc.temporary_storage_city1
doc.temporary_storage_street1
doc.temporary_storage_site_number
doc.temporary_storage_sig1_name
doc.temporary_storage_sig1_time
doc.temporary_storage_sig1_cstat
doc.temporary_storage_sig2_name
doc.temporary_storage_sig2_time
doc.temporary_storage_sig2_cstat

doc.document_id enthält die ZEDAL-interne und netzweit eindeutige Dokumentnummer („docID“, z. B. „12345-6“), doc.sequence_number die amtliche BMU-Nummer des Transportdokuments.

Der Dokumenttyp im Feld doc.document_type entspricht dem BMU-Dokumenttyp („BGS“, „UNS“ usw.).

Der aktuelle Layer in doc.current_layer entspricht den amtlichen BMU-Layer-Namen (z. B. „BGSERZLayer“).

Stornierte Dokumente tragen im Feld doc.cancelled den Wert „true“.

Das Feld doc.notes kann mehrzeilige Inhalte haben.

Die Felder zum Signaturstatus (..._cstat) tragen folgende Codes: - 2 -> gültig - 5 -> fraglich, z. B. OCSP „unknown“ oder ohne Antwort - 8 -> ungültig

Datumsfelder haben das Format YYYY-MM-DD (z. B. „2022-08-31“).

Zeitstempelfelder haben das Format YYYY-MM-DDTHH24:Mi:SSZ, z. B. „2022-08-31T16:48:23Z“. Alle Zeiten sind in UTC angegeben.

Optional: Filter (`<filter>`):¶

path -> Feldname (siehe oben)
op -> Operator („equal“ / „not_equal“ / „null“ / „not_null“ / „contains“ / „begins_with“ / „ends_with“ / „less“ / „greater“ / „less_or_equal“ / „greater_or_equal“ / „between“ / „in_list“)
operands -> Operand(en)

Mehrere Filter werden immer mit UND verknüpft (alle Bedingungen müssen zutreffen). Andere logische Verknüpfungen lassen sich abbilden, indem du Abfragen nacheinander ausführst und die Ergebnisse entsprechend zusammenführst.

Datentypen (in `<operands>`):¶

s -> string, z. B. „Berlin“
i -> int, z. B. „12“
n -> double, z. B. „1.23“
d -> date, YYYY-MM-DD, z. B. „2022-08-31“
utc -> dateTime (in UTC), YYYY-MM-DD HH24:Mi:SS, z. B. „2022-08-31 16:48:23“
(nicht verwendet: dt -> dateTime, YYYY-MM-DD HH24:Mi:SS, z. B. „2022-08-31 16:48:23“)

Wie viele Operanden nötig sind (durch Wiederholen des Elements <operands>), hängt vom Operator ab: - null / not_null: kein Operand - equal / not_equal / contains / begins_with / ends_with / less / greater / less_or_equal / greater_or_equal: genau ein Operand - between: genau zwei Operanden - in_list: ein oder mehrere Operanden

Optional: Sortierung (`<sort>`):¶

Ohne Angabe kommen die Datensätze in keiner bestimmten Reihenfolge zurück.

path -> Feldname (siehe oben)
direction -> Richtung („asc“ / „desc“)

Optional: Seitenweise Abfrage:¶

Ohne Angabe kommen höchstens die ersten 20 Datensätze zurück.

page_start -> erster zurückzugebender Datensatz (>= 1)
page_size -> Anzahl der zurückzugebenden Datensätze

Optional: Vorauswahl zur Beschleunigung (`<speedup-preselection>`):¶

Erwartet ein date (Format YYYY-MM-DD, z. B. „2022-08-31“). Die Grundmenge der Dokumente wird vorab auf die bis zu diesem Datum relevanten begrenzt; die Abfrage wird dadurch schneller. Ohne Angabe werden alle verfügbaren Daten berücksichtigt.

ZEDAL-SOAP-Webservice: Übersichtsabfragen über ListTransportDocuments() / ListFileAreaDocuments() / ListInboxDocuments()¶

Beschreibung¶

Verfügbare Felder (<fieldmask> / <path>):¶

Optional: Filter (<filter>):¶

Datentypen (in <operands>):¶

Optional: Sortierung (<sort>):¶