SOAP Interface Documentation

In addition to our new REST API, we also offer a SOAP interface. This includes an extended range of functions, but will not be further developed in the future.

Getting Started

To use the SOAP interface of ZEP, you need the ZEP interface module, which you can activate via the self-service tool. If you have done this, you can display the link to the Wsdl file in the new module. You can integrate this file into your SOAP client program. Furthermore, you can view the authorization token there, which you need for authentication.

Notes on update operations

Send only the fields you want to change

A field you leave out of an update request stays unchanged. A field you send empty (<startDatum></startDatum> or <startDatum/>) is applied and clears the stored value. With UpdateVorgang, an empty startDatum therefore removes the start date, and an empty vorgangName clears the name of the task.

So do not send a record you read earlier back unchanged if it contains empty elements. Leave empty elements out and send only the fields you want to change.

If ZEP answers returnCode 0 with the message “Es gab keine Änderungen” (no changes), the request was valid but did not change any stored value.

Values with a special meaning in UpdateVorgang

FieldValueEffect
parent, parentId0The task has no parent task.
planStunden, planArbeitsentgelt, planBelege0An existing planned value is reset to 0.
kostenstellenull (as text)The cost centre is removed.
actiondeleteThe task is deleted.
action in vorgangMitarbeiterListedeleteAll employee assignments of the task are removed.
alleProjektmitarbeiterSindAuchVorgangsmitarbeitertrueAll project members are assigned to the task; existing individual assignments are removed.

To move a task under another one, send only parentId. A task number in parent need not be unique, the parentId always is. Do not send parent and parentId with differing values.

Documentation

Enclosed you will find the manual and interface descriptions for ZEP and ZEP Clock. These contain all the information you need to use the SOAP interface.

ZEP SOAP Interface Manual 6.10.pdf

ZEP SOAP Service V10.pdf

ZEP Clock SOAP Service V10.pdf