2. Tabelle aller FunktionenKapitel hinzufügen
Um eine bessere Übersicht zu gewährleisten, werden nur die Variablen der Parameter/Übergabewerte genannt. Im Kapitel Funktionen im Detail werden diese ausführlich beschrieben.
| Funktion | Parameter/Übergabewert des Client | Rückgabewert von MyBib eDoc | Beschreibung |
| Debug-Funktionen | |||
| debug.fault | flag | xmlrpc-Fault | Dient der Überprüfung der Fehlerbehandlung von Clients |
| debug.echo | content (string) | content (string) | Eine Echo-Funktion, gibt exakt den im Request übergebenen String zurück |
| debug.reciprocal | value (integer) | Reziprokwert des Parameters | Zu Testzwecken („1/x-Funktion“) |
| debug.sum | value1 (integer) value2 (integer) | Summe der Parameter | Zu Testzwecken („Aufsummierung“) |
| Service-Funktionen | |||
| service.license | success ⇒ Lizenznummer (String) error ⇒ Fehlermeldung (String) | Liefert die Lizenznummer eines MyBib eDoc-Systems zurück | |
| service.noop | session_id (Session-ID) | success ⇒ success_struct error ⇒ error_struct | (Noop = No Operation) – verhindert Session-Timeouts |
| service.datetime | Format (string) | success ⇒ Systemzeit (String) | Die aktuelle Systemzeit des MyBib eDoc-Systems. Fehlt der Formatstring wird die Rückgabe in ISO8601 erfolgen. |
| service.proxy | URL (string) | success ⇒ Gibt den Inhalt der URL wieder (String) error ⇒ Fehlermeldung (String) | Für Testzwecke |
| service.testconnection | success ⇒ String (gibt im Erfolgsfall „Hello, nice to meet you“ zurück) | Führt einen Verbindungstest durch (Ping). | |
| service.auth | auth_struct ( auth_system auth_system_id auth_system_mac auth_service auth_realm auth_address auth_ip auth_user auth_name auth_username auth_inst auth_institution auth_domain auth_pwd auth_pass auth_password auth_lang auth_language ) | success ⇒ success_struct error ⇒ error_struct (mit technischer und lesbarer Fehlermeldung) | Service, mit dem Fremdsysteme sich gegenüber MyBib eDoc authentifizieren können. Mandatorische Angaben sind realm, user und password. |
| service.login | login_struct ( login_user login_pwd login_mac login_domain login_language login_interface) | success ⇒ session_struct (mit folgenden Parametern: session_id (Session-ID) xmlrpc_interface (Protokollversion des XMLRPCServers)) error ⇒ error_struct | Führt eine Anmeldung am System durch. Legt im Erfolgsfall eine Session an, die bei weiteren Aufrufen verwendet werden muss. |
| service.logout | session_id | success ⇒ success_struct error ⇒ error_struct | Beendet eine Session. |
| service.register | register_struct ( register_user register_pwd register_mac scc_opsystem scc_system scc_scanner scc_version scc_customer scc_company scc_licdate scc_licmod scc_licscanner) | success ⇒ success_struct error ⇒ error_struct | Führt eine Registrierung des Clients durch. Mandatorische Angaben sind register_user, register_pwd und register_mac. |
| service.getuserlist | session_id | success ⇒ user_struct error ⇒ error_struct | Liefert eine Liste möglicher MyBib-Nutzer des Clients zurück. |
| service.checkuser | session_id user pass | success ⇒ user_struct error ⇒ error_struct | Liefert die MyBib eDoc user_id eines authentifizierten MyBib eDoc-Nutzer. |
| Auftragsfunktionen | |||
| order.getdata | session_id order_nr mode user pass | success ⇒ transfer_struct, format_struct, order_struct error ⇒ error_struct | Liefert zur übergebenen Bestellung alle für den Upload bzw. Download relevanten Informationen an den Scanclient. |
| order.notifyupload | session_id order_nr status_code scan_code error_code upload_code journal_struct reworking_code_struct | success ⇒ success_struct error ⇒ error_struct | Teilt den erfolgreichen oder nicht erfolgreichen Download bzw. Upload der Dateien mit. |
| order.validateorder | session_id order_nr user pass | success ⇒ complain_struct, ocr_struct, xmlrpc_struct error ⇒ error_struct | Nach erfolgreicher Überprüfung der Parameter auf Vollständigkeit, wird der Auftrag freigegeben und der Status geändert. |
| order.acquire | session_id order_struct | success ⇒ order_struct error ⇒ error_struct | Legt einen Auftrag in MyBib eDoc an. |
| order.cleanimagedir | session_id order_nr | success ⇒ success_struct error ⇒ error_struct | Versucht den Inhalt eines Scanverzeichnisses auf dem MyBib eDoc-Servers zu löschen. |
| order.track | session_id order_nr track_code | success ⇒ track_struct error ⇒ error_struct | Versucht die verlangten Daten an den Client zu übermitteln. Ist dies nicht möglich, wird eine Fehlermeldung ausgegeben. |
| order.notify | session_id notify_struct mit folgenden Parametern – order_nr – notification – action_code – message | success ⇒ success_struct error ⇒ error_struct | Für einen bestimmten Auftrag wird eine eine Nachricht an den Server übergeben. Diese Nachricht kann verbunden sein mit einer Kategorie und einer Aktion, die explizit angegeben werden muss. |
| order.complain | session_id order_nr complaint_struct – reason – download_struct | success ⇒ success_struct error ⇒ error_struct | Stößt die Reklamationsbearbeitung eines Auftrages an. Zusätzlich zum Grund der Reklamation müssen die Daten für den Download der Scans übergeben werden. |
| order.fileupload | session_id order_nr file_meta_data file als base64 | success ⇒ success_struct error ⇒ error_struct | Dient dem Upload einer Datei (vorwiegend Scans) via http/https. |
| order.filedownload | session_id order_nr user passwort | success ⇒ file_struct error ⇒ error_struct | Gegenstück zu order.fileupload, dient dem Download einer Datei via http/https bei der Reklamationsbearbeitung. |
| order.getreworkingcodes | session_id order_nr user pass | success ⇒ success_struct( mit validen reworking codes) error ⇒ error_struct | Erforderlich zum Auswählen eines Nachbearbeitungskennzeichens. |
| order.listreworkingcodes | session_id order_nr user pass | success ⇒ success_struct( mit validen reworking codes) error ⇒ error_struct | s. order.getreworkingcodes |
| order.getflyleaf | session_id order_nr | success ⇒ success_struct ( mit enthaltenem Deckblatt als base64) error ⇒ error_struct | Deckblatt kann damit gepollt werden, es muss kein Batchprozess gestartet werden. |
| order.acquireupload | session_id order_struct (Bestelldaten im ILL-subito-Format) file (base64) | success ⇒ success_struct error ⇒ error_struct | Erfasst Auftrag in MyBib eDoc inklusive Upload einer Datei. |
| order.search | session_id search_struct result_limit result_offset | success ⇒ order_list error ⇒ error_struct | Liefert eine Liste mit Aufträgen anhand einer ausgewählten Kategorie. |
| order.setreworkingcodes | session_id order_nr reworking_text reworking_code user pass | success ⇒ success_struct( mit validen reworking codes) error ⇒ error_struct | Setzt ein Nachbearbeitungskennzeichen innerhalb eines Auftrag. |
| order.setstate | session_id order_nr order_state | success ⇒ success_struct error ⇒ error_struct | Setzt den Status des ausgwählten Auftrages auf den gewünchten Wert. |
| Auftragschargen-Funktionen | |||
| charge.order.adjoin | session_id charge_number element_struct | success ⇒ summary_struct error ⇒ error_struct | Im element_struct über die Auftragskennung definierte Aufträge können in die Charge (charge_number) gebucht werden. Für jeden Auftrag wird der Erfolg oder Misserfolg der der Buchung protokolliert. |
| charge.order.dequeue | session_id charge_number element_struct | success ⇒ summary_struct error ⇒ error_struct | Im element_struct über die Auftragskennung definierte Aufträge können aus einer Charge (charge_number) entfernt werden. |
| charge.order.setelementflag | session_id charge_number element_action element_struct | success ⇒ summary_struct error ⇒ error_struct | Setzt im element_struct über die Auftragskennung definierte Aufträge eine Markierung |
| charge.order.progress | session_id charge_number option remark | Alias für charge.progress | |
| charge.order.read | session_id charge_number | Ist ein Alias für charge.read | |
| Chargen Funktionen | |||
| charge.read | session_id charge_number | success ⇒ charge_struct error ⇒ error_struct | Liefert zur angegebenen Charge alle relevanten Daten. |
| charge.progress | session_id charge_number option remark | success ⇒ charge_struct error ⇒ error_struct | Über diese Funktion wird eine Aktion auf die Charge ausgelöst. Zur Auswahl stehen alle in MyBib eDoc definierten Aktionen. |
| charge.getchargelist | session_id search_struct | success ⇒ charges_list error ⇒ error_struc | Liefert eine Liste von Chargen-Nummern anhand der im search_struct definierten Suchparametern. |
| Nummernkreis-Funktionen | |||
| number_range.lookahead | session_id number_range|number_range_id | success ⇒ number error ⇒ error_struct | Liefert den aktuellen „Lookahead“ eines referenzierten Nummernkreises. |
| number_range.trigger | session_id number_range|number_range_id | success ⇒ number error ⇒ error_struct | Triggert einen referenzierten Nummernkreis |