APIs and systems integration

Reads one or many calendar events (personal or course) from itslearning.

This operation doesn't use AddMessage method for processing. ReadCalendarEvent method of ReadDataService service is used instead. The method returns a collection of calendar events, which are requested by their sync keys.

Input parameters

Name	Description	Type	Mandatory/Optional
SiteId	Site where action will be executed.	Integer	Optional
VendorId	VendorId. Currently not used.	Text	Optional
SyncKeys	String array containing events' sync keys	Array of Text	Mandatory

Message request example:

ReadCalendarEvent request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:tem="http://tempuri.org/" xmlns:its="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CalendarEvent" xmlns:arr="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
   <soapenv:Header/>
   <soapenv:Body>
      <tem:ReadCalendarEvent>
         <tem:request>
            <its:SyncKeys>
               <arr:string>YK_013</arr:string>
               <arr:string>YK_014</arr:string>
            </its:SyncKeys>
         </tem:request>
      </tem:ReadCalendarEvent>
   </soapenv:Body>
</soapenv:Envelope>

Output

The method returns the array of corresponding Event objects.

Note: The following properties are the part of the Event object only in case if "Enable French calendar layout" customer setting is on:

ShowExtraDescription
ExtraDescription
NextEventId
NextEventSyncKey

Message response example:

ReadCalendarEvent response

<s:Envelope xmlns:s="http://schemas.xmlsoap.org/soap/envelope/" xmlns:u="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
   <s:Header>
      <o:Security s:mustUnderstand="1" xmlns:o="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <u:Timestamp u:Id="_0">
            <u:Created>2012-05-10T08:04:02.215Z</u:Created>
            <u:Expires>2012-05-10T08:09:02.215Z</u:Expires>
         </u:Timestamp>
      </o:Security>
   </s:Header>
   <s:Body>
      <ReadCalendarEventResponse xmlns="http://tempuri.org/">
         <ReadCalendarEventResult xmlns:a="http://schemas.datacontract.org/2004/07/Itslearning.Integration.ContentImport.Model.ServiceEntities.CalendarEvent" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
            <a:Events>
               <a:Event>
                  <a:CourseId>1</a:CourseId>
                  <a:CourseSyncKey/>
                  <a:Description>&lt;p>This COURSE event has been imported through Migration toolkit&lt;/p></a:Description>
                  <a:EndDateTime>2012-05-05T15:00:00Z</a:EndDateTime>
                  <a:GroupHierarchyId>1</a:GroupHierarchyId>
                  <a:GroupHierarchySyncKey>YYY</a:GroupHierarchySyncKey>
                  <a:Id>17</a:Id>
                  <a:IsLesson>true</a:IsLesson>
                  <a:PlanId>4997</a:PlanId>
                  <a:StartDateTime>2012-05-05T14:00:00Z</a:StartDateTime>
                  <a:SyncKey>YK_013</a:SyncKey>
                  <a:Title>Coding practice</a:Title>
                  <a:UserId>2</a:UserId>
                  <a:UserSyncKey/>
                  <a:DisableDelete>false</a:DisableDelete>
                  <a:TitleReadOnlyInUi>true</a:TitleReadOnlyInUi>
               </a:Event>
               <a:Event>
                  <a:CourseId>1</a:CourseId>
                  <a:CourseSyncKey/>
                  <a:Description>&lt;p>This PERSONAL event has been imported through Migration toolkitsdf&lt;/p></a:Description>
                  <a:EndDateTime>2012-05-07T14:00:00Z</a:EndDateTime>
                  <a:GroupHierarchyId i:nil="true"/>
                  <a:GroupHierarchySyncKey/>
                  <a:Id>18</a:Id>
                  <a:IsLesson>true</a:IsLesson>
                  <a:PlanId i:nil="true"/>
                  <a:StartDateTime>2012-05-07T13:00:00Z</a:StartDateTime>
                  <a:SyncKey>YK_014</a:SyncKey>
                  <a:Title>Coding practice</a:Title>
                  <a:UserId>2</a:UserId>
                  <a:UserSyncKey/>
                  <a:DisableDelete>true</a:DisableDelete>
                  <a:TitleReadOnlyInUi>false</a:TitleReadOnlyInUi>
               </a:Event>
            </a:Events>
         </ReadCalendarEventResult>
      </ReadCalendarEventResponse>
   </s:Body>
</s:Envelope>

Error states

In the following cases the service will return an error:

There are not any events with requested SyncKeys.