HRM-Archiv, SOAP-Schnittstelle

Folgende Vorgänge werden unterstützt. Eine ausführliche Definition finden Sie in der Dienstbeschreibung.

• checkAllDocuments
  Überprüft alle Dokumente im Archiv auf Manipulation.
  Gibt die Anzahl der geprüften Dokumente und Informationen zu manipulierten Dateien als Liste in einem CheckStatus wieder.
  Parameter: Token token
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  Rückgabewert CheckStatus:
  - Status, welcher enthält ob das Prüfen erfolgreich war, wie viele Dokumente geprüft wurden und eine Liste mit Fehlertexten
• checkDocument
  Überprüft, ob die aktuelle Version des Dokuments mit der übergebenen SyncID noch denselben Hash hat, wie beim Ablegen.
  Parameter: Token token, string syncID
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des zu prüfenden Dokuments
  Rückgabewert Status:
  - Status, ob das prüfen erfolgreich war
• checkDocumentVersion
  Überprüft, ob die angegebene Version des Dokuments mit der übergebenen SyncID noch denselben Hash hat, wie beim Ablegen.
  Parameter: Token token, string syncID, int version
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des zu prüfenden Dokuments
  - version: Version des zu prüfenden Dokuments
  Rückgabewert Status:
  - Status, ob das prüfen erfolgreich war
• countDocuments
  Zählt Dokumente anhand der übergebenen Suchkriterien.
  Parameter: Token token, SearchCriteria searchCriteria
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - searchCriteria: Suchkriterien für die Dokumentenzählung
  Rückgabewert int:
  - Anzahl der Dokumente
• deleteDocument
  Löscht alle Versionen und alle zugehörigen Datenbank Informationen eines Dokuments mit der übergebenen SyncID aus dem Archiv.
  Parameter: Token token, string syncID
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des zu löschenden Dokuments
  Rückgabewert Status:
  - Status, ob das löschen erfolgreich war
• deleteDocumentVersion
  Löscht die angegebene Version und alle zugehörigen Datenbank Informationen eines Dokuments mit der übergebenen SyncID aus dem Archiv.
  Handelt es sich dabei um die einzige Version des Dokuments, wird auch der Haupteintrag und die Attribute aus der Datenbank gelöscht.
  Parameter: Token token, string syncID, int version
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des zu löschenden Dokuments
  - version: Version des zu löschenden Dokuments
  Rückgabewert Status:
  - Status, ob das löschen erfolgreich war
• getArchiveProtocol
  Gibt Protokoll Daten zurück, welche den übergebenen Suchkriterien entsprechen.
  Parameter: Token token, SearchCriteria searchCriteria
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - searchCriteria: Suchkriterien für die Protokoll Einträge
  Rückgabewert List:
  - Liste mit Protokoll Daten, welche mit die Suchkriterien übereinstimmen.
• getArchiveSystem
  Abfrage der Version des HRM-Archivs
  Rückgabewert (String):
  - Version des HRM-Archivs als String
• getArchiveVersion
  Abfrage der Version des HRM-Archivs
  Rückgabewert (ArchiveVersion):
  - Version des HRM-Archivs mit MajorVersion, FeatureReleaseVersion und StableReleaseVersion
• getCapabilities
  Abfrage der Funktionalitäten des HRM-Archivs
  Rückgabewert (List<string>):
  - Liste der Funktionalitäten
• getDistinctMetadata
  Lädt eine Liste an Dokument Metadaten aus dem HRM-Archiv, welche den übergebenen Suchkriterien entsprechen und liefert eine List der eindeutigen Werte eines übergebenen Attributs.
  Parameter: Token token, SearchCriteria searchCriteria, string attributeName
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - searchCriteria: Suchkriterien, für welche Dokument Metadaten geladen werden sollen
  - fieldName: Name des Felds das gefiltert werden soll
  Rückgabewert List:
  - Liste der eindeutigen Werte
• getDocument
  Holt die aktuelle Version des Dokuments mit der übergebenen SyncID als Byte Array aus dem HRM-Archiv.
  Parameter: Token token, string syncID
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des Dokuments, welches heruntergeladen geladen werden soll
  Rückgabewert Byte[]:
  - Byte Array des angeforderten Dokuments
• getDocumentMetadata
  Läd eine Liste an Dokument Metadaten aus dem HRM-Archiv, welche den übergebenen Suchkriterien entsprechen.
  Parameter: Token token, SearchCriteria searchCriteria
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - searchCriteria: Suchkriterien, für welche Dokument Metadaten geladen werden sollen
  Rückgabewert List:
  - Liste der angeforderten Metadaten
• getDocumentVersion
  Holt die angeforderte Version eines Dokuments mit der übergebenen SyncID als Byte Array aus dem HRM-Archiv.
  Parameter: Token token, string syncID, int version
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des Dokuments, welches heruntergeladen geladen werden soll
  - version: Version des Dokuments, welches heruntergeladen geladen werden soll
  Rückgabewert Byte[]:
  - Byte Array des angeforderten Dokuments
• getDocumentVersionMetadata
  Läd die Dokument Metadaten für das Dokument mit übergebener SyncID und Version aus dem HRM-Archiv.
  Parameter: Token token, string syncID, int version
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des Dokuments, für welches Metadaten geladen werden sollen.
  - version: Version des Dokuments, für welches Metadaten geladen werden sollen.
  Ist der Wert 0 wird die aktuelle Version verwendet.
  Rückgabewert DocumentMetadata:
  - Die angeforderten Metadaten
• getDocumentVersionMetadataXML
  Holt die Metadaten als XML des Dokuments mit übergebener SyncID und Version als Byte Array aus dem HRM-Archiv.
  Parameter: Token token, string syncID, int version
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des Dokuments, von welchem Metadaten geladen werden sollen
  - version: Version des Dokuments, von welchem Metadaten geladen werden sollen
  Rückgabewert Byte[]:
  - Byte Array der Metadaten in XML-Format des angeforderten Dokuments
• getDocumentVersions
  Läd alle Versionsinformationen eines Dokuments mit der übergebenen SyncID aus dem HRM-Archiv.
  Parameter: Token token, string syncID
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des Dokuments, für welches alle Versionsinformationen geladen werden sollen
  Rückgabewert List:
  - Liste mit allen Versionsinformationen
• importDocument
  Importiert die zwei als ByteStream übergebenen Dateien als Dokument ins Archiv.
  document ist hierbei die abzulegende Datei, währrend metadatDocument ein XML darstellt, welches alle informationen zu der Datei beinhält.
  Parameter: Token token, Byte[] document, Byte[] metadataDocument
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - document: Abzulegende Datei.
  - metadataDocument: XML-Datei, welche Metadaten zu der abzulegenden Datei enthält.
  Rückgabewert Byte[]:
  - Status, ob das importieren erfolgreich war.
• linkDocument
  Verbindet das übergebene Dokument im Archiv mit der übergebenen Mandanten Nummer und Personal Nummer.
  Parameter: Token token, string sourceSyncID, DocumentMetadata documentMetadata
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - sourceSyncID: Quelldokument
  - documentMetadata: Metadaten des Dokuments
  Rückgabewert VersionStatus:
  - Status, ob das Verbinden erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• login
  Überprüft Login Daten, bei richtigem Login wird ein Token zurückgegeben.
  Parameter: String user, String password
  - user: Username
  - password: Passwort
  Rückgabewert Token:
  - Token mit eindeutigem Identifier, Anleg Datum und Gültigkeits Datum
• logout
  Überprüft das übergebene Token und löscht dieses.
  Parameter: Token token
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  Rückgabewert IStatus:
  - Status, ob das Logout erfolgreich war, oder der Token bereits ungültig war
• migrateFromFileArchive
  Migriert das Dokument mit dem übergebenen Metadaten aus dem alten Datei Archiv in das neue HRM-Archiv.
  Parameter: Token token, DocumentMetadata documentMetadata, int mappingId
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - documentMetadata: Metadaten des Dokuments.
  - mappingId: ID des Dokuments in der Mapping Tabelle, welche für die Migration relevante Informationen enthält.
  Rückgabewert VersionStatus:
  - Status, ob das Migrieren erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• migrateFromWebArchive
  Migriert das Dokument mit dem übergebenen Metadaten anhand der MappingID aus dem alten Web-Archiv in das neue HRM-Archiv.
  Parameter: Token token, DocumentMetadata documentMetadata, int mappingId
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - documentMetadata: Metadaten des Dokuments.
  - mappingId: ID des Dokuments in der Mapping Tabelle, welche für die Migration relevante Informationen enthält.
  Rückgabewert VersionStatus:
  - Status, ob das Migrieren erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• migrateLinkedDocument
  Migriert das übergebene verknüpfte Dokument in das HRM-Archiv.
  Parameter: Token token, string sourceSyncID, DocumentMetadata documentMetadata
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - sourceSyncID: Quelldokument
  - documentMetadata: Metadaten des Dokuments
  Rückgabewert VersionStatus:
  - Status, ob das Verbinden erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• newDocument
  Legt das übergebene Dokument im Archiv ab und erstellt Datenbank Einträge aus den übergebenen Metadaten.
  Parameter: Token token, DocumentMetadata documentMetadata, Byte[] document
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - documentMetadata: Metadaten des Dokuments
  - document: Dokument in Byte Form
  Rückgabewert VersionStatus:
  - Status, ob das Ablegen erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• newDocumentVersion
  Legt das übergebene Dokument im Archiv als neue Version ab und erstellt Datenbank Einträge aus den übergebenen Daten.
  Parameter: Token token, string user, string syncID, Byte[] document, string comment
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - user: Username, der die neue Version erstellt hat
  - syncID: SyncID des Dokuments
  - document: Dokument in Byte Form
  Rückgabewert VersionStatus:
  - Status, ob das Ablegen erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• newMetadata
  Erstellt Datenbank Einträge aus den übergebenen Metadaten.
  Parameter: Token token, DocumentMetadata documentMetadata
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - documentMetadata: Metadaten des Dokuments
  Rückgabewert VersionStatus:
  - Status, ob das Ablegen erfolgreich war. Status enthält außerdem die SyncID und Version des Dokuments
• updateDocument
  Updated das Dokuments mit der übergebenen SyncID mit den übergebenen Metadaten.
  Parameter: Token token, string syncID, DocumentMetadata documentMetadata, string user
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des zu updatenden Dokuments
  - documentMetadata: Metadaten des zu updatenden Dokuments
  - user: Benutzer, welcher das update durchgeführt hat
  Rückgabewert Status:
  - Status, ob das updaten erfolgreich war
• updateDocumentVersion
  Updated das Dokument mit der übergebenen SyncID und Version mit den entsprechenden DokumentMetadaten.
  Parameter: Token token, string syncID, int version, DocumentMetadata documentMetadata, string user
  - token: Token mit Identifier, Anleg Datum und Gültigkeits Datum
  - syncID: SyncID des zu updatenden Dokuments
  - version: Version des zu updatenden Dokuments
  - documentMetadata: Metadaten des zu updatenden Dokuments
  - user: Benutzer, welcher das update durchgeführt hat
  Rückgabewert Status:
  - Status, ob das updaten erfolgreich war