Calendar (Appointment)

Resource type: calendar

Reads the database fields from an appointment record.

If you specify the resource ID of the appointment, the data of the appointment is returned.

If no resource ID is specified, the data of the appointments of a specific period can be requested via the parameters datestart and dateend. It will return the appointments of the logged-in user and his groups, when the parameters users and groups arent specified.

The user rights on appointments set in enterprise are respected.

Parameters:

  • datestart
    STRING. Start date of the time interval for the requested appointments
  • dateend
    STRING. End date of the time interval for the the requested appointments
  • showcancelled
    BOOLEAN. Flag if cancelled appointments should be requested
  • users
    ARRAY. User IDs. Specify here the appointments of which users you want to read out. Works only in combination with the parameters “datestart” and “dateend”.
  • groups
    ARRAY. Group IDs. Specify here the appointments of which groups you want to read out. Works only in combination with the parameters “datestart” and “dateend”.
  • allusers
    BOOLEAN. Flag for reading out all data. If set on true, the parameters users and groups will be ignored. Default: false

Example: Read appointment by resource ID:

...
{
	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
	"resourceid": "79",
	"identifier": "",
	"resourcetype": "calendar",
	"parameters": {             
	}
}
...

Example: Reading out the appointments of a period:

...
{
	"actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:read",
	"resourceid": "",
	"identifier": "",
	"resourcetype": "calendar",
	"parameters": {
 		"datestart": "2017-08-01 14:45:00",
		"dateend": "2017-08-02 15:45:00",
		"showcancelled": true,
		"users": [17, 25]
	}
}
...

Response:

  • (individually)