SOAP-Schnittstelle Dokumentation
Neben unserer neuen REST-API bieten wir auch eine SOAP-Schnittstelle an. Diese enthält einen erweiterten Funktionsumfang, wird aber in Zukunft nicht mehr weiterentwickelt.
Erste Schritte
Um die SOAP-Schnittstelle von ZEP nutzen zu können, benötigen Sie das Modul ZEP-Schnittstellen, welches Sie über das Selfservice-Tool freischalten können. Falls Sie dies getan haben, können Sie sich im neuen Modul den Link zur Wsdl-Datei anzeigen lassen. Diese Datei können Sie in Ihr SOAP-Client-Programm einbinden. Weiterhin können Sie dort den Autorisierungs-Token einsehen, den Sie für die Authentifizierung benötigen.
Hinweise für Update-Operationen
Nur die zu ändernden Felder senden
Ein Feld, das Sie in einem Update-Request nicht mitsenden, bleibt unverändert. Ein Feld, das Sie leer mitsenden (<startDatum></startDatum> oder <startDatum/>), wird dagegen übernommen und leert den gespeicherten Wert. Bei UpdateVorgang entfernt ein leeres startDatum also das Startdatum, ein leerer vorgangName leert die Bezeichnung des Vorgangs.
Senden Sie einen zuvor gelesenen Datensatz deshalb nicht unverändert zurück, wenn er leere Elemente enthält. Lassen Sie leere Elemente weg und senden Sie nur die Felder mit, die Sie ändern möchten.
Meldet ZEP returnCode 0 mit der Meldung „Es gab keine Änderungen“, war der Request gültig, hat aber keinen gespeicherten Wert verändert.
Werte mit besonderer Bedeutung bei UpdateVorgang
| Feld | Wert | Wirkung |
|---|---|---|
parent, parentId | 0 | Der Vorgang erhält keinen übergeordneten Vorgang. |
planStunden, planArbeitsentgelt, planBelege | 0 | Ein vorhandener Planwert wird auf 0 zurückgesetzt. |
kostenstelle | null (als Text) | Die Kostenstelle wird entfernt. |
action | delete | Der Vorgang wird gelöscht. |
action in vorgangMitarbeiterListe | delete | Alle Mitarbeiterzuordnungen des Vorgangs werden entfernt. |
alleProjektmitarbeiterSindAuchVorgangsmitarbeiter | true | Alle Projektmitarbeiter sind dem Vorgang zugeordnet; bestehende Einzelzuordnungen werden entfernt. |
Um einen Vorgang einem anderen unterzuordnen, geben Sie nur parentId an. Eine Vorgangsnummer in parent muss nicht eindeutig sein, die parentId ist es immer. Senden Sie parent und parentId nicht mit unterschiedlichen Angaben.
Dokumentation
Anbei finden Sie das Handbuch und die Schnittstellenbeschreibungen für ZEP und ZEP Clock. Diese enthalten alle Informationen, die Sie benötigen, um die SOAP-Schnittstelle zu nutzen.