Collmex API: Rückmeldungen
Fehler- und Erfolgsmeldungen
Die komplette Kommunikation findet in einer Datenbank-Transaktion statt. Im Falle eines Fehlers wird die Datenbank-Transaktion zurück gerollt. Das bedeutet, dass entweder alle Änderungen oder gar keine übernommen werden.
Für den Fall, dass es bei der Kommunikation einen Fehler gab, wird ein Fehlersatz zurückgegeben (Meldungstyp 'E').
Wenn es keinen Fehler gab, wird das angeforderte Ergebnis zurückgegeben und als letzte Meldung immer eine Erfolgsmeldung (Meldungstyp 'S', Meldungsnummer 20420, Meldungstext 'Datenübertragung erfolgreich. Es wurden XXX Datensätze verarbeitet.').
| Nr | Feld | Typ | Max.Länge | Bemerkung
|
|---|
| 1 | Satzart | C | | Festwert MESSAGE
| | 2 | Meldungstyp | C | 2 | 'S' = Success
'W' = Warnung
'E' = Fehler
| | 3 | Meldungsnummer | C | 20 | Die interne Collmex-Meldungsnummer
| | 4 | Meldungstext | C | 255 | -
| | 5 | Zeile | I | 8 | Zeilennummer der Upload-Datei, auf die sich die Meldung bezieht.
|
Rückmeldung von Nummern
Sofern das Programm bei eine Nummer für ein Dokument vergeben hat, wird diese über die Satzart NEW_OBJECT_ID zurückgegeben. Mehr Informationen dazu unter Nummernvergabe.
Beschränkungen / Limits
- Pro Tag können unter einer Kundennummer maximal 10.000 API-Aufrufe ausgeführt werden.
Minimieren Sie die Anzahl der Aufrufe, indem Sie die Objekte nicht einzeln, sondern gesammelt abfragen bzw. übergeben. Vermeiden Sie zyklische Abfragen in kurzen Zeitabständen; verwenden Sie statt dessen Benachrichtigungen, um geänderte Daten nur bei Bedarf abzufragen.
- Gleichzeitig können pro Benutzer maximal 5 API-Aufrufe ausgeführt werden.
Warten Sie mit dem nächsten API-Aufruf, bis der vorige beendet ist; starten Sie keine parallelen Aufrufe. Verwenden Sie für jedes angebundene System einen eigenen Benutzer.
- Wartungszeit ist täglich von 3:30 bis 5:00 Uhr.
Vermeiden Sie API-Aufrufe in dieser Zeit. Auch außerhalb der Wartungszeit kann es im Falle einer Störung zu Serviceunterbrechungen kommen. Warten Sie mindestens eine Minute, bevor Sie die Abfrage wiederholen, wenn Collmex nicht erreichbar ist, oder Sie den Fehler 200005 "System temporär nicht erreichbar. Bitte probieren Sie es später noch einmal." erhalten.
Siehe auch: Collmex API Inhalt, Nummernvergabe
|
