Delete.Calendar.Event

Deletes one or many calendar events (personal or course).

Action

Message with that type will delete calendar events. The operation is synchronous, so the results are available in the message response.

Input parameters

Message type

Name	Description	Type	M/O
SyncKeys	Event SyncKeys array.	SyncKeysType	M
SiteId	Site where action will be executed	Int	O
VendorId	VendorId which will be associated with created content	Text	O
DeleteProtection	If set true checks a content of events to be going to deleted. Events with content (descriptions and connected resources) cannot be deleted. For these events resets DisableDelete flag to allow delete these events from UI.	Boolean	O

SyncKeysType

Name	Description	Type	M/O
SyncKey	Events’ SyncKeys.	ID	M

Output

Finished status

Calendar event deleted.

Warning status

Event '{EventSyncKey}' does not exist in itslearning
Event '{EventSyncKey}' contains content and has not been deleted.

Errors status

Invalid format / parameters (different to specified schema).
Other errors (see the table below)

Message	Description
Event '{SyncKey}' cannot be deleted because the period is locked in given course (Course Id {CourseId}).	Occurs when trying to delete course event which is within "locked" period in given course (not possible to create, edit or delete events before certain date).

Schema

Delete.Calendar.Event schema

<?xml version="1.0" encoding="utf-8"?>
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:message-schema" elementFormDefault="qualified" targetNamespace="urn:message-schema">
    <xs:element name="Message" type="MessageType" />
    <xs:complexType name="MessageType">
        <xs:sequence>
            <xs:element name="SyncKeys" type="SyncKeysType" minOccurs="1" maxOccurs="1" />
            <xs:element name="SiteId" minOccurs="0" maxOccurs="1" type="xs:int" />
            <xs:element name="VendorId" minOccurs="0" maxOccurs="1">
                <xs:simpleType>
                    <xs:restriction base="xs:string">
                        <xs:minLength value="1"/>
                        <xs:maxLength value="36"/>
                    </xs:restriction>
                </xs:simpleType>
            </xs:element>
            <xs:element name="DeleteProtection" minOccurs="0" maxOccurs="1" type="xs:boolean" />
        </xs:sequence>
    </xs:complexType>
    <xs:complexType name="SyncKeysType">
        <xs:sequence>
            <xs:element name="SyncKey" type="xs:string" minOccurs="1" maxOccurs="unbounded" />
        </xs:sequence>
    </xs:complexType>
</xs:schema>

Message content example

Delete.Calendar.Event message content example

<Message xmlns="urn:message-schema">
  <SyncKeys>
    <SyncKey>YK_015</SyncKey>
  </SyncKeys>
  <DeleteProtection>true</DeleteProtection>
</Message>