1b.app
Link kopiert -

API Dokumente (Dokument)

Hinzufügen eines Dokuments zu einem Prozess Methode: /api/document/add/

Optionen

Beispiel:

http://myboxurl/api/document/add/?login=LOGIN&password=PASSWORD&ordercode=1&templateid=14&name=TEST

Feld Art Beschreibung Obligatorisch oder nicht Kommentar
1 login string Melden Sie sich im BOX-System an Pflichtfeld.  
2 password string Passwort im md5-Format Pflichtfeld. Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3 templateid integer Dokumentvorlagen-ID Pflichtfeld. Geben Sie die ID der Dokumentvorlage an, um ein Dokument zu erstellen.
4 orderid integer Prozess ID Pflichtfeld. Geben Sie die ID oder externe ID des Prozesses an, für den Sie ein Dokument erstellen möchten
5 ordercode integer Externe Prozess-ID Pflichtfeld. Geben Sie die ID oder externe ID des Prozesses an, für den Sie ein Dokument erstellen möchten
6 name string Dokumentname Nicht erforderliches Feld.  
7 clientview 1 / 0 Kann im Büro des Kunden eingesehen werden Nicht erforderliches Feld. Um das Dokument zur Ansicht im Büro des Kunden verfügbar zu machen, geben Sie 1 in dieses Feld ein
8 fileoriginal string Originaldatei Nicht erforderliches Feld.  

Erhalt eines Dokuments und Erhalt aller Dokumente, Methode: /api/document/get/

Optionen
Optionen zum Abrufen eines einzelnen Dokuments:

Beispiel:

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&documentid=7927

Feld Art Beschreibung Obligatorisch oder nicht Kommentar
1 login string Melden Sie sich im BOX-System an Pflichtfeld.  
2 password string Passwort im md5-Format Pflichtfeld. Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3 documentid string Dokument Identifikation Pflichtfeld. Wenn Sie eine bestimmte Bestellung benötigen, übergeben Sie in diesem Feld entweder die Dokument-ID oder die Dokumentnummer. Die Engine findet diesen und gibt ihn zurück.

Feldwerte zurückgeben
id - id dokumentieren
number - Dokumentnummer,
name - Dokumentname,
contractorid - id juristische Person im BOX-System,
contactorname - Offizielle Unternehmensbezeichnung,
templateid - id Dokumentvorlage,
templatename - Dokumentvorlagenname,
userid - id der Benutzer, der das Dokument erstellt hat,
cdate - Erstellungsdatum des Dokuments,
sdate - Datum, an dem das Dokument gesendet wurde,
bdate - Datum des Eingangs des Dokuments zurück,
adate - Archivierungsdatum des Dokuments,
edate - Änderungsdatum des Dokuments,
fileoriginal - Link zur Originaldatei,
file - Link zur gescannten Kopie,
content - Dokumentinhalt in HTML,
clientview - zur persönlichen Besichtigung zur Verfügung,
clientpay - zur Zahlung in Ihrem Konto verfügbar,
sum - Dokumentenbetrag,
currencyid - id Dokumentenwährung,
currencyname - Dokumentwährungsname,
orderid - id Dokumentenprozess
4 clientinfo boolean Client-Daten-Array verarbeiten Nicht erforderliches Feld. Das Array enthält alle System- und Zusatzfelder des Clients des Prozesses, in dem das Dokument erstellt wurde, der in der /api/contact-get/json-Anfrageantwort angegeben ist/
Optionen zum Abrufen aller Dokumente:

Beispiel:

http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=1
http://myboxurl/api/document/get/?login=LOGIN&password=PASSWORD&part=2

Feld Art Beschreibung Obligatorisch oder nicht Kommentar
1 login string Melden Sie sich im BOX-System an Pflichtfeld.  
2 password string Passwort im md5-Format Pflichtfeld. Schreiben Sie an den technischen Support und wir geben Ihnen einen Hash für die API
3 orderid string ID Prozess Nicht erforderliches Feld. Geben Sie die ID des Prozesses an, dessen Dokumente Sie erhalten möchten
4 templateid string ID Dokumentvorlage Nicht erforderliches Feld. Geben Sie die ID der Dokumentvorlage an, nach der die Dokumente gefiltert werden sollen.
5 cdate date Erstellungsdatum des Dokuments Nicht erforderliches Feld. Geben Sie das Erstellungsdatum an und die endgültige Auswahl umfasst nur die Dokumente, deren Erstellungsdatum größer oder gleich dem angegebenen ist
6 part integer Teil der Dokumente Pflichtfeld. API stellt bis zu 1000 Dokumente im 1. Teil aus, um die nächsten 1000 Dokumente zu erhalten, übertrage 2 dorthin (Teil 2 wird erhalten) und so weiter.

Feldwerte zurückgeben
id - id dokumentieren
number - Dokumentnummer,
name - Dokumentname,
contractorid - id juristische Person im BOX-System,
contactorname - Offizielle Unternehmensbezeichnung,
templateid - id Dokumentvorlage,
templatename - Dokumentvorlagenname,
userid - id der Benutzer, der das Dokument erstellt hat,
cdate - Erstellungsdatum des Dokuments,
sdate - Datum, an dem das Dokument gesendet wurde,
bdate - Datum des Eingangs des Dokuments zurück,
adate - Archivierungsdatum des Dokuments,
edate - Änderungsdatum des Dokuments,
fileoriginal - Link zur Originaldatei,
file - Link zur gescannten Kopie,
content - Dokumentinhalt in HTML,
clientview - zur persönlichen Besichtigung zur Verfügung,
clientpay - zur Zahlung in Ihrem Konto verfügbar,
sum - Dokumentenbetrag,
currencyid - id Dokumentenwährung,
currencyname - Dokumentwährungsname,
orderid - id Dokumentenprozess
7 clientinfo boolean Client-Daten-Array verarbeiten Nicht erforderliches Feld. Das Array enthält alle System- und Zusatzfelder des Clients des Prozesses, in dem das Dokument erstellt wurde, der in der /api/contact-get/json-Anfrageantwort angegeben ist/

Mögliche Antworten auf die Anfrage

Mehr
Status Nachricht Nachrichtenbeschreibung
1 fail login_empty Fehlende Anmeldung
2 fail password_empty Fehlendes Passwort
3 fail Bad user level! Niedriges Benutzerlevel zum Ausführen dieser Aktion (benötigt Level 2 und höher)
4 fail Login or password not correct! Login oder Passwort falsch eingegeben

Es können auch Fehler auftreten:

502 Bad Gateway - Wenn dieser Fehler auftritt, müssen Sie:
1. Überprüfen Sie, ob Sie Zugang zum Internet haben (gehen Sie zu einer anderen Website).
2. Wenn es keine Probleme mit dem Zugriff gibt — Sie können Cookies löschen.
Wenn das oben genannte nicht geholfen hat — Serverseitiges Problem. Wenden Sie sich an den Systemadministrator der Site.

503 (Service Temporarily Unavailable) - Dieser Fehler kann durch zu viele auftreten Anfragen an den Server. Wenn Sie einen solchen Fehler sehen, sollten Sie ein paar Minuten warten und es erneut versuchen.

504 Gateway Timeout - cDer Punkt ist höchstwahrscheinlich die erhöhte Auslastung der Site, bei der Apache dies nicht tut verwaltet, HTTP-Antworten zu geben, und neue Anforderungen werden in die Warteschlange gestellt. Um das Problem zu lösen, können Sie hinzufügen Serverressourcen, insbesondere RAM, und die Anzahl der httpd-Prozesse erhöhen (Apache).
Ein weiterer möglicher Grund für den 504-Fehler ist, dass das ausführbare Skript nicht in das zugewiesene Limit passt Zeit. Dies passiert, wenn die Anfrage zu schwer ist. Versuchen Sie, Ihre Anfrage in mehrere weitere aufzuteilen klein.

Fehler 505 HTTP-Version wird nicht unterstützt bedeutet, dass die Website nicht ist unterstützt die Version des HTTP-Protokolls, die der Browser verwendet, um eine Webseite anzufordern