Resource type: relation
This call can be used to modify additional information when a relation between the parent and child id already exists. The call can currently only be used to set the confirmation status of linked addresses for appointments via the relationinfo
parameter.
In order to add an additional child to the parent, the “Create relations” call can be used. Similarly the “Delete relations” call can be used to remove a specific child.
Parameters:
parentid
ARRAY. MANDATORY. Record IDschildid
ARRAY. MANDATORY. Record IDsrelationtype
STRING. MANDATORY. Description of the relation. To change therelationinfo
for the confirmation status of an appointment, relationtype'urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:address'
must be set here.relationinfo
STRING. MANDATORY. Further informations about a relation can be modified by the parameterrelationinfo
. For now, only the confirmation status of an appointment can be modified by relationinfo.
Syntax:"relationinfo": {"statusTerminbestaetigung": "gecancelt"}
.
Options are:bestätigt
(confirmed),gesendet
(sent),gecancelt
(cancelled),nicht gesetzt
(not set). See also example below for usage.
A complete list of all relations can be found in the Relations overview.
Example:
{ "actionid": "urn:onoffice-de-ns:smart:2.5:smartml:action:create", "resourceid": "", "identifier": "", "resourcetype": "relation", "parameters": { "relationtype": "urn:onoffice-de-ns:smart:2.5:relationTypes:calendar:address", "relationinfo": {"statusTerminbestaetigung": "gecancelt"}, "parentid": [ 359 ], "childid": [ 281 ] } }