Sie haben eine Frage?
Arberseestraße 3
94249 Bodenmais, DE
Tel.: (0049) 9924 94324-0
Fax: (0049) 9924 94324-5
E-Mail: info@docbox.eu

#S0008 - POST-Request: /api/document/list

Listet die Dokumente innerhalb eines bestimmten Ordners auf und kann dabei die Dokumente anhand ihrer externen Metadaten filtern.

URL-Schema

 


 

Query-Parameter

Name Pflichtfeld Datentyp Anmerkung
folder-id Ja Integer Gibt die ID des Ordners an.
with-external-metadata-keys Nein String-Liste (komma-separiert) Optionaler Parameter, der eine Liste von Keys externer Metadaten angibt, welche die aufgelisteten Dokumente besitzen müssen.
without-external-metadata-keys Nein String-Liste (komma-separiert) Optionaler Parameter, der eine Liste von Keys externer Metadaten angibt, welche die aufgelisteten Dokumente nicht besitzen dürfen.
with-autoexport-status Nein Boolean (true/false) Optionaler Parameter, der einen Filter auf den AutoExport-Status aktiviert. Ist der Wert auf true gesetzt, werden nur Dokument aufgelistet, die autoexportiert wurden, bei false nur solche, die nicht autoexportiert wurden.

Beispiel POST-Request:

 

POST /docbox.webapp/api/ document/list HTTP/1.1
Authorization: Basic VXNlcjpQYXNz
API-Key: dUdQBLnAZQ-4NwniKonV-wLkEyzsu4-OCxPGHZlZ

folder-id=123&with-external-metadata-keys=Rechnung&without-external-metadata-keys=Export,Datev 

 

Erfolgreiche Antwort:

Liste der Dokumente mit ID und Name des Ordners, die ggf. die angegebenen Metadaten besitzen oder nicht. Das genaue Antwortformat ist in der DOCBOX.

HTTP Status 200
Content-Type: text/xml

 

<?xml version="1.0" encoding="UTF-8"?>
<docbox-document-list>
  <document>
    <id>1001</id>
    <name>Rechnung R-40834</name>
  </document>
  <document>
    <id>1009</id>
    <name>Rechnung R-40837</name>
  </document>
</docbox-document-list>

HTTP-Statuscodes

Error-Codes Erläuterung
400 Bad Request  Fehlende oder ungültige Parameter
401 Unauthorized Ungültige Zugangsdaten
403 Forbidden Fehlende Berechtigungen oder DOCBOX®-Module
404 Not found Dokument nicht gefunden
500 Server Error Serverseitiger Fehler, z.B. Datenbankfehler
501 Not implemented Nicht unterstützte HTTP Methode verwendet

Hinweis:
Hierbei handelt es sich um Beispiel URLs. Sämtliche Angaben in {} müssen durch Ihre DOCBOX® ersetzt werden.

{HOST}: Hostname oder IP-Adresse Ihrer DOCBOX® einsetzen
{PORT}: PORT Ihrer DOCBOX® einsetzen