Resource type: calendar
With this API call an appointment can be created. The default values for the appointment follow-up on the tab “Tools >> Settings >> Basic settings >> Automatization” for the appointment type are taken into account.
Parameters:
data
OBJECT. The following information can be set when creating an appointment:description:
Appointment descriptionstart_dt:
Start of the appointmentend_dt:
End of the appointmentart:
Type of appointmentganztags:
All-day appointment?allowTransitTime:
Enter transit time?transitTime:
Transit timenote:
Notes on the appointmentabgesagt:
true or false. Sets appointment status on active or cancelled. Default: falseprivate:
Private appointment?erinnerung:
Time of the appointment reminder before the appointment. Possible values are:0 minutes, 15 minutes, 30 minutes, 1 hours, 2 hours, 3 hours, 1 days, 2 days, 3 days, 1 weeks, 3 weeks
origin:
Appointment imported via ICS?
relatedAddressIds
ARRAY. Address IDs to be linked with the appointment.relatedEstateId
INTEGER. Estate ID to be linked with the appointment.location
OBJECT. Place of appointment (see below).subscribers
OBJECT. Participants. Can be users (users
) oder groups (groups
).reminderTypes
ARRAY. Type of appointment reminder. Can accept the valuesemail
,popup
orsms
. For this purpose, the fielderinnerung
must also be set to a time with the parameterdata
.
Example:
... { "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create", "resourceid": "", "identifier": "", "resourcetype": "calendar", "parameters": { "data": { "description": "Besichtigungstermin", "start_dt": "2020-08-01 17:45:00", "end_dt": "2020-08-01 18:00:00", "art": "Besichtigung", "ganztags": 0, "note": "Das ist eine Notiz", "private": 0 }, "relatedAddressIds": [ 1935, 1931 ], "relatedEstateId": 608, "location": { "estate": 608 }, "subscribers": { "users": [ 14 ], "groups": [ 168, 172 ] } } } ...
and the options for the appointment location are estate
, user
, group
, mandant
, sonstiges
:
{ "location" : { "estate" : "39"} } { "location" : { "user" : "21"} } { "location" : { "group" : "39"} } { "location" : { "mandant" : true} } { "location" : { "sonstiges" : "Testr.1, 52062 Aachen"} }
Response:
{ "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create", "resourceid": "", "resourcetype": "calendar", "cacheable": false, "identifier": "", "data": { "meta": { "cntabsolute": null }, "records": [ { "id": 2779, "type": "calendar", "elements": [] } ] }, "status": { "errorcode": 0, "message": "OK" } }