News

API release news 09/24

SEPTEMBER 2024

1. New response parameter fileSize for “Read address files” and “Read estate files”

New response parameter fileSize for “Read address files” and “Read estate files” that specifies the file size in bytes.

Estate files

Address files

2. Request parameter listlimit and response parameter IDs in “Read records last seen”

Request parameter listlimit is now functional.
The IDs of the affected data records are now output in the response parameter records.

Records last seen

3. Response parameter “language” and “additionalTranslations” in “Get SearchCriteriaFields”

Response parameter language and additionalTranslations in “Get SearchCriteriaFields”.

Search criteria fields

API release news 08/24

AUGUST 2024

1. Unlink property in “Modify appointments”:

If the request parameter relatedEstateId is set to 0 or null, the link between the appointment and the estate is removed.

Appointments

2. Link new task directly to email in “Create task”:

If the request parameter mailMessageId is set, the newly created task is linked to the email with the specified message ID.

Tasks

3. New parameters filterId and filter in “Search” call:

The request parameters filterId and filter have been added to the API call for searching for estates or other data records. They function in the same way as the parameters of the same name in the “Read estate” call.

Search for Estates (Quick Search for Estate address, Owner and external Estate number)

Search

4. New request parameter showEfforts in “Read tasks”:

If the new request parameter showEfforts is specified, the response is extended to include the response parameter efforts. The parameter outputs the values “Aufwand offen / Remaining workload”, “Ist Aufwand / Actual effort” and the processing time of the individual users as an object.

Tasks

API release news 07/24

JULY 2024

1. Request parameters for recurring appointments documented in “Create and Modify appointments”:

Request parameters rp_flag, rp_type, rp_tage, rp_beginn_datum, rp_ende_datum, rp_ende_status and rp_exception for setting recurring appointments have been added to the documentation for the API calls “Create appointments” and “Modify appointments”.

Appointments

Appointments

2. New values for time of the appointment reminder in the “Create and Modify appointments” call

For the request parameter erinnerung (time of the appointment reminder) in the API calls “Create and Modify appointment” there are the new values 5 minutes, 12 hours and 15 hours.

Appointments

Appointments

3. New request parameter for appointment status in “Create and Modify appointments”

Possible values: active, completed, canceled, participantsAvailable. Overwrites the value abgesagt if both are specified in the same call.

Appointments

Appointments

4. New request parameter listoffset in “Read users” call

User

5. API users can now be selected under “Extras >> Log” in the user selector.

API release news 06/24

JUNE 2024

Request parameters for recurring appointments documented in “Create appointments” and “Modify appointments”:

Request parameters rp_flag, rp_type, rp_tage, rp_beginn_datum, rp_ende_datum, rp_ende_status and rp_exception for setting recurring appointments have been added to the documentation for the API calls “Create appointments” and “Modify appointments”.

Appointments

Appointments

API release news 05/24

MAY 2024

New API call “Get email info”:

A new API call “Get email info” has been created, which reads out all property and address links in an email.

This call replaces “Get email links“, which can only read 1 address link per email.

Email info

New parameter “addressIds” in API call “Do Email links”:

The new parameter addressIds in the API call “Do Email links” can be used to transfer an array of addresses that are to be linked to the email. The parameter can be used instead of addressid, which can only be used to link 1 address.

Do Email links

New parameter “useDefaultMailAccount” in API call “Send Appointment confirmation”:

The new parameter useDefaultMailAccount can be used to set whether the sender mail address from the user settings should be used for sending.

Send Appointment confirmation