Open Menu

© 2018 Capita Business Services Ltd. All rights reserved.

Capita Education Software Solutions is a trading name of Capita Business Services Ltd. Our Registered office is 30 Berners Street, London, W1T 3LR and our registered number is 02299747. Further information about Capita plc can be found in our legal statement.

Product / SIMS 7 / SIMS 7 - TPGroupManagement

SIMS 7 - TPGroupManagement

TPGroupManagement.GetXmlCourseClasses(System.DateTime)

This interface gets all the classes related to all the courses within SIMS system valid for date supplied. Sample output from the interface is as below

TPGroupManagement.GetXmlCourseClasses(int courseId)

This interface gets classes related to a course id passed as input. It gets all the classes related to a course irrelevant of the date. Sample output from this interface is as below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<CourseClasses>
  <CourseClass>
    <Course>1904</Course>
    <Class>482</Class>
    <StartDate>2004-09-01T00:00:00</StartDate>
    <EndDate>2005-05-30T23:59:00</EndDate>
  </CourseClass>
  <CourseClass>
    <Course>1904</Course>
    <Class>1851</Class>
    <StartDate>2002-09-01T00:00:00</StartDate>
    <EndDate>2004-07-23T23:59:00</EndDate>
  </CourseClass>
  <CourseClass>
    <Course>1904</Course>
    <Class>2998</Class>
    <StartDate>2005-09-06T00:00:00</StartDate>
    <EndDate>2006-07-21T23:59:00</EndDate>
  </CourseClass>
  <CourseClass>
    <Course>1904</Course>
    <Class>3520</Class>
    <StartDate>2006-09-06T00:00:00</StartDate>
    <EndDate>2007-07-20T23:59:00</EndDate>
  </CourseClass>
  <CourseClass>
    <Course>1904</Course>
    <Class>4379</Class>
    <StartDate>2007-09-04T00:00:00</StartDate>
    <EndDate>2008-07-23T23:59:00</EndDate>
  </CourseClass>
</CourseClasses>

TPGroupManagement.GetXmlGroupChilds(int parentBaseGroupId,System.DateTime)

This interface gets child group id’s for a parent group valid within the date supplied as parameter. Sample output from the interface is as below

TPGroupManagement.GetXmlGroupChilds(int parentBaseGroupId)

This interface gets child group id’s of the parent group supplied as parameter. This interface gets all the child group irrelevant of the date.

Sample output from the interface is as below:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<SubGroups>
  <SubGroup>
    <ParentGroupID>37</ParentGroupID>
    <ChildGroupID>388</ChildGroupID>
    <SubGroupType>CY</SubGroupType>
    <StartDate>2001-09-01T00:00:00</StartDate>
    <EndDate />
  </SubGroup>
  <SubGroup>
    <ParentGroupID>37</ParentGroupID>
    <ChildGroupID>396</ChildGroupID>
    <SubGroupType>CY</SubGroupType>
    <StartDate>2001-09-01T00:00:00</StartDate>
    <EndDate />
  </SubGroup>
  <SubGroup>
    <ParentGroupID>37</ParentGroupID>
    <ChildGroupID>400</ChildGroupID>
    <SubGroupType>CY</SubGroupType>
    <StartDate>2001-09-01T00:00:00</StartDate>
    <EndDate />
  </SubGroup>
<SubGroups>

TPGroupManagement.GetXmlGroupParents(int childBaseGroupId,System.DateTime)

This interface gets all the parents of the child group supplied as parameter. It gets all the child groups valid for the date supplied as parameter. Sample output from the interface is as below

TPGroupManagement.GetXmlGroupParents(int childBaseGroupId)

This interface gets information of parent group id’s of child group supplied as parameter. It gets all the child group id’s irrelevant of the dates. Sample output from the interface is as below

Output

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<SubGroups>
  <SubGroup>
    <ParentGroupID>37</ParentGroupID>
    <ChildGroupID>387</ChildGroupID>
    <SubGroupType>RY</SubGroupType>
    <StartDate>2001-09-01T00:00:00</StartDate>
    <EndDate />
  </SubGroup>
  <SubGroup>
    <ParentGroupID>388</ParentGroupID>
    <ChildGroupID>387</ChildGroupID>
    <SubGroupType>U</SubGroupType>
    <StartDate />
    <EndDate />
  </SubGroup>
</SubGroups>

TPGroupManagement.GetXmlGroups(System.DateTime,string baseGroupTypeCode)

This gets information of all the base groups relevant for date supplied as parameter. All the base groups related to baseGroupType are being returned from this interface. Sample output from the interface is as below

Output

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Groups>
  <Group>
    <BaseGroupID>381</BaseGroupID>
    <BaseGroupTypeID>22</BaseGroupTypeID>
    <Code>J</Code>
    <Description>J</Description>
    <ShortName>J</ShortName>
    <PromoteToGroupID>381</PromoteToGroupID>
    <StartDate />
    <EndDate />
    <IsActive>A</IsActive>
  </Group>
<Groups>

TPGroupManagement.GetXmlGroups(System.DateTime)

It returns all the basegroups valid for date supplied as parameter for all the basegrouptypes. Sample output from the interface is as below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Groups>
  <Group>
    <BaseGroupID>37</BaseGroupID>
    <BaseGroupTypeID>24</BaseGroupTypeID>
    <Code> 7</Code>
    <Description>Year  7</Description>
    <ShortName> 7</ShortName>
    <PromoteToGroupID>36</PromoteToGroupID>
    <StartDate />
    <EndDate />
    <IsActive>A</IsActive>
  </Group>
  <Group>
    <BaseGroupID>2128</BaseGroupID>
    <BaseGroupTypeID>2</BaseGroupTypeID>
    <Code>#2128</Code>
    <Description>7x/Pe3 AL</Description>
    <ShortName>7x/Pe3</ShortName>
    <PromoteToGroupID />
    <StartDate />
    <EndDate />
    <IsActive>I</IsActive>
  </Group>
<Groups>

TPGroupManagement.GetXmlGroupSupervisors(int baseGroupId,System.DateTime)

This interface gets supervisor of the basegroup supplied. All the supervisors valid with the date supplied as parameter are being returned. Sample output from the interface is as below

TPGroupManagement.GetXmlGroupSupervisors(int baseGroupId)

This interface gets supervisors from the base group supplied as parameter. This interface will get all the supervisors irrelevant of the date. Sample output from the interface is as below

TPGroupManagement.GetXmlGroupSupervisors(System.DateTime)

This interface gets all the supervisors for all the base groups. It returns the supervisors valid within date supplied as parameter. Sample output from the interface is as below

Output

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<GroupSupervisors>
  <GroupSupervisor>
    <BaseGroupID>387</BaseGroupID>
    <SupervisorID>10</SupervisorID>
    <SupervisorTitleID>11</SupervisorTitleID>
    <StartDate>2001-09-01T00:00:00</StartDate>
    <EndDate>2002-08-31T23:59:00</EndDate>
  </GroupSupervisor>
  <GroupSupervisor>
    <BaseGroupID>387</BaseGroupID>
    <SupervisorID>7100</SupervisorID>
    <SupervisorTitleID>11</SupervisorTitleID>
    <StartDate>2002-09-01T00:00:00</StartDate>
    <EndDate>2003-08-31T23:59:00</EndDate>
  </GroupSupervisor>
  <GroupSupervisor>
    <BaseGroupID>387</BaseGroupID>
    <SupervisorID>7287</SupervisorID>
    <SupervisorTitleID>11</SupervisorTitleID>
    <StartDate>2003-09-01T00:00:00</StartDate>
    <EndDate>2004-08-31T23:59:00</EndDate>
  </GroupSupervisor>  
</GroupSupervisors>

TPGroupManagement.GetXmlGroupTypes()

This interface gets information of all the Base Group Types within SIMS system. Sample output from the interface is as below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<BaseGroupTypes>
  <BaseGroupType>
    <BaseGroupTypeID>1</BaseGroupTypeID>
    <Code>Academic</Code>
    <Description>Academic Organisation</Description>
    <ParentBaseGroupTypeID />
  </BaseGroupType>
  <BaseGroupType>
    <BaseGroupTypeID>6</BaseGroupTypeID>
    <Code>Assessment</Code>
    <Description>Assessment User Defined</Description>
    <ParentBaseGroupTypeID>1</ParentBaseGroupTypeID>
  </BaseGroupType>
</BaseGroupTypes>

TPGroupManagement.GetXmlMemberships(System.DateTime,XmlDocument)

This interface gets information of members valid within the date supplied as parameter. It also returns all the memberships which are valid for the current academic year. This in affect means that a member who has changed memberships twice within current academic year, this method will return both these valid memberships. The user needs to do the filtering at their end in case they don’t need some of these memberships after the data has been returned. The base group for which members need to be returned is also supplied as parameter. There can be multiple base groups which can be passed using XMLDocument. Format of XML document for this interface is as below.

Sample parameter

<BaseGroups><BaseGroupID>387</BaseGroupID><BaseGroupID>383</BaseGroupID></BaseGroups>

Sample Output

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Memberships>
  <Membership>
    <BaseGroupID>387</BaseGroupID>
    <PersonD>6347</PersonD>
    <StartDate>2007-09-03T00:00:00</StartDate>
    <EndDate>2008-09-01T23:59:00</EndDate>
  </Membership>
  <Membership>
    <BaseGroupID>387</BaseGroupID>
    <PersonD>6355</PersonD>
    <StartDate>2007-09-03T00:00:00</StartDate>
    <EndDate>2008-09-01T23:59:00</EndDate>
  </Membership>
</Memberships>

TPGroupManagement.GetXmlMiscellMemberships(System.DateTime,XmlDocument)

This interface gets members whose membership is within the date supplied parameter of the base groups of the group type Miscellaneous. It also returns all the memberships which are valid for the current academic year. This in affect means that a member who has changed memberships twice within current academic year, this method will return both these valid memberships. The user needs to do the filtering at their end in case they don’t need some of these memberships after the data has been returned. The base group for which members need to be returned is also supplied as parameter. There can be multiple base groups which can be passed using XMLDocument. Format of XML document for this interface is as below.

Sample parameter

<BaseGroups><BaseGroupID>19</BaseGroupID><BaseGroupID>4426</BaseGroupID></BaseGroups>

Sample output from the interface is as below:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Memberships>
  <Membership>
    <BaseGroupID>19</BaseGroupID>
    <PersonD>6347</PersonD>
    <StartDate>2007-09-03T00:00:00</StartDate>
    <EndDate>2008-09-01T23:59:00</EndDate>
  </Membership>
  <Membership>
    <BaseGroupID>4426</BaseGroupID>
    <PersonD>6355</PersonD>
    <StartDate>2007-09-03T00:00:00</StartDate>
    <EndDate>2008-09-01T23:59:00</EndDate>
  </Membership>
</Memberships>

TPGroupManagement.GetXmlSubGroups(System.DateTime)

This interface gets parent child relationship for all the groups in SIMS system. It returns this relationship valid within the date supplied as parameter. Sample output from the interface is as below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<SubGroups>
  <SubGroup>
    <ParentGroupID>24</ParentGroupID>
    <ChildGroupID>470</ChildGroupID>
    <SubGroupType>CN</SubGroupType>
    <StartDate />
    <EndDate />
  </SubGroup>
  <SubGroup>
    <ParentGroupID>24</ParentGroupID>
    <ChildGroupID>476</ChildGroupID>
    <SubGroupType>CN</SubGroupType>
    <StartDate />
    <EndDate />
  </SubGroup>
<SubGroups>

TPGroupManagement.GetXmlChangedGroups(DateTime referenceDate)

The call to interface on 04/01/2010 will get all the groups from SIMS system.

When the date passed to this interface is on/after the logging date, it will only get the information of groups that have been added/modified/deleted from SIMS System

The below sample code and output is based on following:

Change the Description of ‘Year 7’ to ‘Year 7 – Changed for Test’. Add a new Registration Group called ‘7G’ to Year 7 in SIMS Database.

Sample code and output is shown below:

TPGroupManagement groupInfo = new TPGroupManagement();
string changeddata = groupInfo.GetXmlChangedGroups(System.DateTime.Now);

Output:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Groups>
  <Group>
    <BaseGroupID>37</BaseGroupID>
    <BaseGroupTypeID>24</BaseGroupTypeID>
    <Code>7</Code>
    <Description>Year 7 - Changed</Description>
    <ShortName>7</ShortName>
    <PromoteToGroupID>36</PromoteToGroupID>
    <StartDate />
    <EndDate />
    <IsActive>A</IsActive>
  </Group>
  <Group>
    <BaseGroupID>5455</BaseGroupID>
    <BaseGroupTypeID>22</BaseGroupTypeID>
    <Code>7G</Code>
    <Description>7G</Description>
    <ShortName>7G</ShortName>
    <PromoteToGroupID />
    <StartDate>2010-01-12T00:00:00</StartDate>
    <EndDate />
    <IsActive>A</IsActive>
  </Group>
</Groups>

TPGroupManagement.GetXmlChangedGroupSupervisors(DateTime referenceDate)

The call to interface on 04/01/2010 will get all the supervisors linked to groups from SIMS system.

When the date passed to this interface is on/after the logging date, it will only get the information of supervisors linked to a group have been changed, added a new supervisor to a group. It will not get the information of a supervisor deleted from its associated group. The below sample code and output is based on following:

Attached a new supervisor ‘Julia Estaphan, PersonId - 25’ to Reg Group ‘8A, BaseGroupId - 383’. The old Supervisor ‘Anita Abell’ has been removed [26].

Attach a supervisor ‘Mary Anderson, PersonId - 6903’ to Group ‘8E, BaseGroupId - 457’. 

Sample code and output is shown below:

TPGroupManagement groupInfo = new TPGroupManagement();
string changeddata = groupInfo.GetXmlChangedGroupSupervisors(System.DateTime.Now);

Output :


Output :
<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<GroupSupervisors>
  <GroupSupervisor>
    <BaseGroupID>383</BaseGroupID>
    <SupervisorID>19422</SupervisorID>
    <personID>25</personID>
    <SupervisorTitleID>3</SupervisorTitleID>
    <StartDate>2010-01-12T00:00:00</StartDate>
    <EndDate />
  </GroupSupervisor>
  <GroupSupervisor>
    <BaseGroupID>457</BaseGroupID>
    <SupervisorID>19423</SupervisorID>
    <personID>6903</personID>
    <SupervisorTitleID>3</SupervisorTitleID>
    <StartDate>2010-01-12T00:00:00</StartDate>
    <EndDate />
  </GroupSupervisor>
</GroupSupervisors>

TPGroupManagement.GetXmlChangedMemberships(DateTime referenceDate)

The call to interface on 04/01/2010 will get all the memberships from SIMS System. When the date passed to this interface is on/after the logging date, it will only get the changed memberships from the SIMS System.

In the Sample output a student [7367, Susan Abbot] has been moved from one Curriculum Group 7y[4974] to Curriculum Group 7x[4973].

TPGroupManagement groupInfo = new TPGroupManagement();
string changeddata = groupInfo.GetXmlChangedMemberships(System.DateTime.Now);

Output:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Memberships>
  <Membership deleted="true">
    <BaseGroupID>4974</BaseGroupID>
    <PersonID>7367</PersonID>
    <StartDate>2009-09-02T00:00:00</StartDate>
  </Membership>
  <Membership>
    <BaseGroupID>4973</BaseGroupID>
    <PersonID>7367</PersonID>
    <StartDate>2009-09-02T00:00:00</StartDate>
    <EndDate>2010-07-23T23:59:00</EndDate>
    <PersonD>7367</PersonD>
  </Membership>
</Memberships>

 

 

 

 

SIMS 7 RESOURCES

Related resources for SIMS 7