Felder der Listen¶
Die Listen der QueryApi filtern, sortieren und wählen Spalten über Feldpfade. Diese Seite nennt für jede Liste die gültigen Pfade, ihren Typ und das Feld in operands, mit dem ein Vergleichswert typisiert gesendet wird. Wie du eine Abfrage aufbaust, steht bei den eANV-Begleitscheinen.
Pfade und Werte¶
- Ein Pfad beginnt bei der Zeile in
entriesund läuft bis zum Einzelfeld, etwadoc.waste_producer.signature1.time. - Er gilt in Proto-Schreibweise (
doc.last_changed) und in JSON-Schreibweise (doc.lastChanged). Die Muster-Liste nimmt nur die Proto-Schreibweise. - Filter, Sortierung und Spaltenauswahl (
mask) nehmen dieselben Pfade. Alle Bedingungen infiltergelten zusammen. - Die Spalte Wert nennt das Feld in
operands, das zum Typ passt:s(Text),nInt32(Ganzzahl),b(Wahrheitswert),n(Dezimalzahl ausunitsundnanos),d(DatumYYYY-MM-DD),dt(Datum mit UhrzeitYYYY-MM-DDThh:mm:ss) oderutc(Zeitstempel). Einen Text insnimmt jedes Feld an; ein Datum mit Uhrzeit muss dann genau die FormYYYY-MM-DDThh:mm:sshaben. - Einen Pfad, der hier nicht steht, lehnt der Server ab. Die Meldung nennt die Stelle des Pfads, ab 0 gezählt:
output columns|2|invalid namebetrifft den dritten Pfad inmask. - Die Übersichtsabfragen der SOAP-Schnittstelle nutzen eigene Feldnamen, etwa
doc.waste_producer_numberstattdoc.waste_producer.number, und kennen Felder, die es hier nicht gibt, etwadoc.current_layer.
Seitensteuerung¶
pageStart ist die erste Zeile der Seite und zählt ab 1; 0 gilt wie 1. Ohne pageSize liefert eine Seite 20 Zeilen, höchstens 1000. Die Antwort nennt in total die Zahl aller Zeilen, die zu den Bedingungen passen. Die nächste Seite beginnt bei pageStart plus Anzahl der gelieferten Zeilen.
Dokumente¶
ListTransportDocuments (Bestand), ListFileAreaDocuments (Aktenbereich), ListInboxDocuments (Eingang) und ListFiles (Akten) tragen ein Dokument in doc, bei ListFiles das Hauptdokument der Akte. Für alle vier gelten diese Felder:
| Pfad | JSON-Schreibweise | Typ | Wert | Inhalt |
|---|---|---|---|---|
doc.document_id |
doc.documentId |
Text | s |
Kennung des Dokuments; gilt auch als doc.document_id.id |
doc.sequence_number |
doc.sequenceNumber |
Text | s |
Nummer des Transportpapiers |
doc.last_changed |
doc.lastChanged |
Zeitstempel (UTC) | utc |
Zeitpunkt der letzten Änderung |
doc.transport_weight_tonnes |
doc.transportWeightTonnes |
Dezimalzahl | n |
Menge in Tonnen |
doc.notification_id |
doc.notificationId |
Text | s |
Nachweisnummer bzw. Notifizierungsnummer |
doc.waste_type_code |
doc.wasteTypeCode |
Text | s |
Abfallschlüssel |
doc.document_type |
doc.documentType |
Text | s |
Dokumentart, etwa BGS, RGB oder UNS (eANV), VB (DiWaSS-Movement) oder N (DiWaSS-Notifizierung) |
doc.consecutive_transport_number |
doc.consecutiveTransportNumber |
Dezimalzahl | n |
Laufende Nummer des Transports innerhalb der Notifizierung (DiWaSS) |
Beteiligte¶
Jeder Beteiligte steht unter seiner Rolle: doc.<rolle>.<feld>, etwa doc.waste_disposer.name1.
| Rolle | Pfad |
|---|---|
| Erzeuger | doc.waste_producer |
| Beförderer 1 | doc.waste_carrier1 |
| Beförderer 2 | doc.waste_carrier2 |
| Beförderer 3 | doc.waste_carrier3 |
| Entsorger | doc.waste_disposer |
| Zwischenlager | doc.temporary_storage |
| Feld | JSON-Schreibweise | Typ | Wert | Inhalt |
|---|---|---|---|---|
number |
number |
Text | s |
Nummer des Beteiligten |
name1 |
name1 |
Text | s |
Name, Zeile 1 |
name2 |
name2 |
Text | s |
Name, Zeile 2 |
city1 |
city1 |
Text | s |
Ort |
postcode |
postcode |
Text | s |
Postleitzahl |
street1 |
street1 |
Text | s |
Straße |
house_number |
houseNumber |
Text | s |
Hausnummer |
contact_name |
contactName |
Text | s |
Kontakt: Name |
contact_phone |
contactPhone |
Text | s |
Kontakt: Telefon |
contact_fax |
contactFax |
Text | s |
Kontakt: Fax |
contact_email |
contactEmail |
Text | s |
Kontakt: E-Mail |
transport_date |
transportDate |
Datum | d |
Datum in dieser Rolle (Übergabe bzw. Annahme) |
signature1.name |
signature1.name |
Text | s |
Name im Zertifikat der ersten Signatur |
signature1.time |
signature1.time |
Zeitstempel (UTC) | utc |
Zeitpunkt der ersten Signatur |
signature1.cstat |
signature1.cstat |
Ganzzahl | nInt32 |
Gesamtstatus der ersten Signatur |
signature2.name |
signature2.name |
Text | s |
Name im Zertifikat der zweiten Signatur |
signature2.time |
signature2.time |
Zeitstempel (UTC) | utc |
Zeitpunkt der zweiten Signatur |
signature2.cstat |
signature2.cstat |
Ganzzahl | nInt32 |
Gesamtstatus der zweiten Signatur |
Beim Zwischenlager (doc.temporary_storage) lassen sich contact_name, contact_phone, contact_fax, contact_email, transport_date nicht abfragen.
Zusätzliche Felder je Liste¶
Diese Felder stehen in der Zeile neben doc, nicht darunter. Der Pfad heißt also cancelled, nicht doc.cancelled.
| Liste | Pfad | JSON-Schreibweise | Typ | Wert | Inhalt |
|---|---|---|---|---|---|
ListTransportDocuments |
cancelled |
cancelled |
Wahrheitswert | b |
Dokument ist storniert |
ListFileAreaDocuments |
file_id |
fileId |
Text | s |
Kennung der Akte; gilt auch als file_id.id |
ListInboxDocuments |
read |
read |
Wahrheitswert | b |
Eingangsdokument ist gelesen |
ListInboxDocuments |
removed |
removed |
Wahrheitswert | b |
Eingangsdokument ist entfernt |
ListFiles |
file_id |
fileId |
Text | s |
Kennung der Akte; gilt auch als file_id.id |
ListFiles |
created |
created |
Zeitstempel (UTC) | utc |
Zeitpunkt der Anlage der Akte |
ListFiles |
last_changed |
lastChanged |
Zeitstempel (UTC) | utc |
Zeitpunkt der letzten Änderung der Akte |
ListFiles |
expired |
expired |
Zeitstempel (UTC) | utc |
Ablaufzeitpunkt der Akte |
ListFiles |
designation |
designation |
Text | s |
Bezeichnung der Akte |
Muster¶
ListTransportTemplates trägt die Felder eines Musters direkt in der Zeile, ohne doc. Die 205 Pfade gelten nur in Proto-Schreibweise; die Namen folgen dem Datenmodell der Muster.
Alle Felder der Muster-Liste
| Pfad | Typ | Wert |
|---|---|---|
template_id |
Ganzzahl | nInt32 |
bef_anhaenger |
Text | s |
abfallbezeichnung |
Text | s |
abfallschluessel |
Text | s |
entsorgungsnachweisnr |
Text | s |
menge_tonnes |
Dezimalzahl | n |
erz_nr |
Text | s |
erz_name1 |
Text | s |
erz_name2 |
Text | s |
erz_name3 |
Text | s |
erz_strasse |
Text | s |
erz_hausnr |
Text | s |
erz_plz |
Text | s |
erz_ort |
Text | s |
erz_staat |
Text | s |
erz_kontakt_name |
Text | s |
erz_kontakt_tel |
Text | s |
erz_kontakt_fax |
Text | s |
erz_tfsnr |
Text | s |
erz_unterschrift |
Text | s |
uebergabedatum |
Datum | d |
bef_nr |
Text | s |
bef_name1 |
Text | s |
bef_name2 |
Text | s |
bef_name3 |
Text | s |
bef_strasse |
Text | s |
bef_hausnr |
Text | s |
bef_plz |
Text | s |
bef_ort |
Text | s |
bef_staat |
Text | s |
bef_kontakt_name |
Text | s |
bef_kontakt_tel |
Text | s |
bef_kontakt_fax |
Text | s |
bef_kontakt_email |
Text | s |
bef_tfsnr |
Text | s |
bef_unterschrift |
Text | s |
uebernahmedatum |
Datum | d |
ent_nr |
Text | s |
ent_name1 |
Text | s |
ent_name2 |
Text | s |
ent_name3 |
Text | s |
ent_strasse |
Text | s |
ent_hausnr |
Text | s |
ent_plz |
Text | s |
ent_ort |
Text | s |
ent_staat |
Text | s |
ent_kontakt_name |
Text | s |
ent_kontakt_tel |
Text | s |
ent_kontakt_fax |
Text | s |
ent_kontakt_email |
Text | s |
ent_tfsnr |
Text | s |
ent_unterschrift |
Text | s |
annahmedatum |
Datum | d |
vermerke |
Text | s |
erzeuger_betriebs_nr |
Text | s |
befoerderer_betriebs_nr |
Text | s |
entsorger_betriebs_nr |
Text | s |
bef1_nr |
Text | s |
bef1_name1 |
Text | s |
bef1_name2 |
Text | s |
bef1_name3 |
Text | s |
bef1_strasse |
Text | s |
bef1_hausnr |
Text | s |
bef1_plz |
Text | s |
bef1_ort |
Text | s |
bef1_staat |
Text | s |
bef1_kontakt_name |
Text | s |
bef1_kontakt_tel |
Text | s |
bef1_kontakt_fax |
Text | s |
bef1_kontakt_email |
Text | s |
bef1_tfsnr |
Text | s |
bef1_uebernahme |
Datum | d |
bef1_unterschrift |
Text | s |
bef1_betriebs_nr |
Text | s |
bef2_nr |
Text | s |
bef2_uebernahme |
Datum | d |
bef2_name1 |
Text | s |
bef2_name2 |
Text | s |
bef2_name3 |
Text | s |
bef2_strasse |
Text | s |
bef2_hausnr |
Text | s |
bef2_plz |
Text | s |
bef2_ort |
Text | s |
bef2_staat |
Text | s |
bef2_kontakt_name |
Text | s |
bef2_kontakt_tel |
Text | s |
bef2_kontakt_fax |
Text | s |
bef2_kontakt_email |
Text | s |
bef2_tfsnr |
Text | s |
bef2_unterschrift |
Text | s |
bef2_betriebs_nr |
Text | s |
zwl_nr |
Text | s |
zwl_uebernahme |
Datum | d |
zwl_name1 |
Text | s |
zwl_name2 |
Text | s |
zwl_name3 |
Text | s |
zwl_strasse |
Text | s |
zwl_hausnr |
Text | s |
zwl_plz |
Text | s |
zwl_ort |
Text | s |
zwl_uebergabe |
Datum | d |
zwl_unterschrift |
Text | s |
zwl_betriebs_nr |
Text | s |
entsorger_anlagetyp |
Text | s |
f_anzahl_transporte |
Ganzzahl | nInt32 |
f_erzeugerstaat |
Text | s |
f_entsorgerstaat |
Text | s |
f_befoerdererstaat |
Text | s |
f_exporteurnr |
Text | s |
f_exporteurname1 |
Text | s |
f_exporteurname2 |
Text | s |
f_exporteurstaat |
Text | s |
f_exporteurstrasse |
Text | s |
f_exporteurhausnr |
Text | s |
f_exporteurort1 |
Text | s |
f_exporteurplz |
Text | s |
f_exporteur_betriebsnr |
Text | s |
f_exp_code |
Text | s |
f_exp_kontakt_name |
Text | s |
f_exp_kontakt_tel |
Text | s |
f_exp_kontakt_fax |
Text | s |
f_exp_kontakt_email |
Text | s |
f_tfs_exporteurnr |
Text | s |
f_importeurnr |
Text | s |
f_importeurname1 |
Text | s |
f_importeurname2 |
Text | s |
f_importeurstaat |
Text | s |
f_importeurstrasse |
Text | s |
f_importeurhausnr |
Text | s |
f_importeurort1 |
Text | s |
f_importeurplz |
Text | s |
f_importeur_betriebsnr |
Text | s |
f_imp_code |
Text | s |
f_imp_kontakt_name |
Text | s |
f_imp_kontakt_tel |
Text | s |
f_imp_kontakt_fax |
Text | s |
f_imp_kontakt_email |
Text | s |
f_tfs_importeurnr |
Text | s |
f_abfallschluessel_basel |
Text | s |
f_abfallschluessel_oecd |
Text | s |
f_abfallschluessel_eu |
Text | s |
f_abfallschluessel_y_code |
Text | s |
f_abfallschluessel_h_code |
Text | s |
f_abfallschluessel_un_klasse |
Text | s |
f_abfallschluessel_un_kennnr |
Text | s |
f_abfallschluessel_un_vname |
Text | s |
letzter_bef_nr |
Text | s |
letzter_bef_tfsnr |
Text | s |
letzter_befname1 |
Text | s |
letzter_befname2 |
Text | s |
letzter_befstrasse |
Text | s |
letzter_befhausnr |
Text | s |
letzter_befort |
Text | s |
letzter_befplz |
Text | s |
letzter_befstaat |
Text | s |
letzter_bef_kontakt_name |
Text | s |
letzter_bef_kontakt_tel |
Text | s |
letzter_bef_kontakt_fax |
Text | s |
letzter_bef_kontakt_email |
Text | s |
bef_zugmaschine |
Text | s |
bef1_zugmaschine |
Text | s |
bef1_anhaenger |
Text | s |
bef2_zugmaschine |
Text | s |
bef2_anhaenger |
Text | s |
bef_transportart |
Text | s |
bef1_transportart |
Text | s |
bef2_transportart |
Text | s |
letzter_bef_transportart |
Text | s |
letzter_bef_uebernahme |
Datum | d |
volumen_cbm |
Dezimalzahl | n |
behoerde_betriebsnr |
Text | s |
rd_code |
Text | s |
tfs_bes_handlungsvorschrift |
Wahrheitswert | b |
mehr_als_drei_bef |
Wahrheitswert | b |
ort_der_erzeugung |
Text | s |
ort_der_entsorgung |
Text | s |
interne_bezeichnung |
Text | s |
gueltig_von |
Datum | d |
gueltig_bis |
Datum | d |
created |
Zeitstempel (UTC) | utc |
creator |
Text | s |
last_change |
Zeitstempel (UTC) | utc |
last_user |
Text | s |
erz_code |
Text | s |
bef_code |
Text | s |
ent_code |
Text | s |
erz_interne_bezeichnung |
Text | s |
bef_interne_bezeichnung |
Text | s |
ent_interne_bezeichnung |
Text | s |
art |
Text | s |
sammelentsorgung |
Wahrheitswert | b |
durchschlaege_bgls |
Ganzzahl | nInt32 |
durchschlaege_ubns |
Ganzzahl | nInt32 |
anzahl |
Ganzzahl | nInt32 |
anfordern |
Ganzzahl | nInt32 |
bemerkung |
Text | s |
format |
Text | s |
modell |
Text | s |
registerbeleg |
Text | s |
anfordern_name |
Text | s |
anfordern_telefon |
Text | s |
anfordern_email |
Text | s |
anfordern_gelesen |
Wahrheitswert | b |
no_sync |
Wahrheitswert | b |
erz_kontakt_email |
Text | s |