SIMS 7 - TPCalendar

TPCalendar.GetXmlEventTypes()

This interface gets all the events types from SIMS system. Sample output from this interface is as below

<CalendarEventTypes>
  <CalendarEventType>
    <EventTypeID>2</EventTypeID>
    <Code>AcadYear</Code>
    <Description>Academic Year</Description>
    <DefaultDuration>365</DefaultDuration>
  </CalendarEventType>
  <CalendarEventType>
    <EventTypeID>9</EventTypeID>
    <Code>AttSession</Code>
    <Description>Attendance Session</Description>
    <DefaultDuration>0.018</DefaultDuration>
  </CalendarEventType>
</CalendarEventTypes>

TPCalendar.GetXmlEvents()

This interface will get all the events from SIMS system. Sample output from this interface is as below

<CalendarEvents>
  <CalendarEvent>
    <EventId>135</EventId>
    <EventTypeID>2</EventTypeID>
    <Description>Academic Year 1994/1995</Description>
    <DefaultDuration>0</DefaultDuration>
    <DefaultDayOfWeek>0</DefaultDayOfWeek>
    <DefaultStartTime />
    <DefaultEndTime />
    <DisplayOrder>0</DisplayOrder>
    <IsActive>T</IsActive>
    <IsMultipleAllowed>F</IsMultipleAllowed>
  </CalendarEvent>
  <CalendarEvent>
    <EventId>137</EventId>
    <EventTypeID>2</EventTypeID>
    <Description>Academic Year 1995/1996</Description>
    <DefaultDuration>0</DefaultDuration>
    <DefaultDayOfWeek>0</DefaultDayOfWeek>
    <DefaultStartTime />
    <DefaultEndTime />
    <DisplayOrder>0</DisplayOrder>
    <IsActive>T</IsActive>
    <IsMultipleAllowed>F</IsMultipleAllowed>
  </CalendarEvent>
</CalendarEvents

TPCalendar.GetXmlEventInstances(System.DateTime,System.DateTime)

This interface gets all event instances from SIMS system which are valid against the dates supplied. Sample output from this interface is below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<CalendarEventInstances>
  <CalendarEventInstance>
    <EventInstanceID>17711</EventInstanceID>
    <EventId>6</EventId>
    <EventStartDate>2007-10-08T00:00:00</EventStartDate>
    <EventEndDate>2007-10-14T23:59:00</EventEndDate>
    <Narrative>Attendance Week  6</Narrative>
  </CalendarEventInstance>
  <CalendarEventInstance>
    <EventInstanceID>17827</EventInstanceID>
    <EventId>58</EventId>
    <EventStartDate>2007-10-09T09:00:00</EventStartDate>
    <EventEndDate>2007-10-09T12:30:00</EventEndDate>
    <Narrative>Tuesday AM</Narrative>
  </CalendarEventInstance>
</CalendarEventInstances>

TPCalendar.GetXmlTimetableModels()

This method returns all timetable models stored within SIMS System. Sample output from this interface is shown below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<TimeTableModels>
  <TimeTableModel>
    <ModelID>1</ModelID>
    <Description>Model 1</Description>
    <StartDate>2001-09-01T00:00:00</StartDate>
    <EndDate>2005-09-05T23:59:00</EndDate>
    <TimetableDays>5</TimetableDays>
  </TimeTableModel>
  <TimeTableModel>
    <ModelID>2</ModelID>
    <Description>Cycle</Description>
    <StartDate>2005-09-06T00:00:00</StartDate>
    <EndDate />
    <TimetableDays>10</TimetableDays>
  </TimeTableModel>
</TimeTableModels>

TPCalendar.GetXmlDays ()

This method returns all System dates and their details like RegistrationStatus from SIMS System. TimetableDayName and TimetableDayID will only be returned for dates which are valid for SIMS System and have been set in database. These values will not be returned for Holidays, Sat, Sun etc. Sample output from this interface is shown below

Output

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<CalendarDays>
  <CalendarDay>
    <CalendarDate>2007-09-05T00:00:00</CalendarDate>
    <RegistrationStatus>SS</RegistrationStatus>
    <TimetableStatus>F</TimetableStatus>
    <SiteStatus>O</SiteStatus>
    <TimetableDayName>1Wed</TimetableDayName>
    <TimetableDayID>181</TimetableDayID>
  </CalendarDay>
  <CalendarDay>
    <CalendarDate>2007-09-06T00:00:00</CalendarDate>
    <RegistrationStatus>SS</RegistrationStatus>
    <TimetableStatus>F</TimetableStatus>
    <SiteStatus>O</SiteStatus>
    <TimetableDayName>1Thu</TimetableDayName>
    <TimetableDayID>182</TimetableDayID>
  </CalendarDay>
<CalendarDays>

TPGroupManagement.GetXmlEventGroupExceptions()

This method returns all the Event Group Exceptions stored in SIMS System.

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<EventGroupExceptions>
  <EventGroupException>
    <BaseGroupID>4232</BaseGroupID>
    <PersonID>5123</PersonID>
    <StartDate>2007-09-10T00:00:00</StartDate>
    <EndDate>2008-07-23T23:59:00</EndDate>
    <EventGroupExceptionID />
    <EventID>189</EventID>
    <ExceptionType>-</ExceptionType>
  </EventGroupException>
</EventGroupExceptions>