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>

Description¶

The calls provide overview data for documents stored in the ZEDAL document database. One function per main area (Transport Documents / File Area / Inbox) is available. The functions offer an optional parameter speedup-preselection to limit the amount of documents to the timespan provided, resulting in a speed up of the query.

Available Fields (`<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 contains the ZEDAL-internal and network-wide unique document number (“docID” - e.g. “12345-6”), doc.sequence_number the official BMU transport document number.

The document type in field doc.document_type correponds to the BMU document type (“BGS”, “UNS”, etc.).

The current layer in doc.current_layer corresponds to the official BMU layer names (e.g. “BGSERZLayer”).

Cancelled documents are markde with the value “true” in the field doc.cancelled.

The field doc.notes may contain multi-line contents.

The signature status fields (..._cstat) carry the following codes: - 2 -> valid - 5 -> questionable, e.g. OCSP “unknown” or without answer - 8 -> invalid

Date fields have the format YYYY-MM-DD (e.g.: “2022-08-31”).

Timestamp fields have the Format YYYY-MM-DDTHH24:Mi:SSZ - e.g.: “2022-08-31T16:48:23Z”. All times are noted in UTC.

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

path -> Field name (s. above)
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(s)

If multiple filters are declared, they are always AND-linked (meaning all given conditions have to match). Other logical links can be modeled by performing queries sequentially and combining the results accordingly.

Data types (in `<operands>`):¶

s -> string, e.g.: “Berlin“
i -> int, e.g.: “12“
n -> double, e.g.: “1.23“
d -> date, YYYY-MM-DD - e.g.: “2022-08-31“
utc -> dateTime (in UTC), YYYY-MM-DD HH24:Mi:SS - e.g.: “2022-08-31 16:48:23“
(- not used - dt -> dateTime, YYYY-MM-DD HH24:Mi:SS - e.g.: “2022-08-31 16:48:23”)

The number of needed operands (by repetition of the <operands> element) depends on the used operator: - null / not_null: No operand - equal / not_equal / contains / begins_with / ends_with / less / greater / less_or_equal / greater_or_equal: Exactly one operand - between: Exactly two operands - in_list: One or more operands

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

Without further specification, the data sets are returned in no particular order.

path -> Field name (s. above)
direction -> Direction (“asc” / “desc”)

Optional: Pagination:¶

Without further specification, a maximum of the first 20 data sets will be returned.

page_start -> First data set to be returned (>= 1)
page_size -> Count of data sets to be returned

Optional: Speedup-Preselection (`<speedup-preselection>`):¶

Takes a date (format YYYY-MM-DD - e.g.: “2022-08-31”). The base amount of documents is pre-limited to those relevant until up to this date, resulting in a speed-up of the query. When not provided, all available data is taken into account.

ZEDAL SOAP Webservice: Overview table queries via ListTransportDocuments() / ListFileAreaDocuments() / ListInboxDocuments()¶

Description¶

Available Fields (<fieldmask> / <path>):¶

Optional: Filter (<filter>):¶

Data types (in <operands>):¶

Optional: Sort (<sort>):¶