SIMS 7 - TPPersonStudent

TPPersonStudent.GetXmlStudents(System.DateTime)

This will get all the students and its related information from SIMS system valid within the date supplied. The output returned from the interface will be as below.

TPPersonStudent.GetXmlStudents()

It is similar to above method except that it gets information of All Students. It gets additional information in the Student XML like Birth Certificate Seen, Attendance Mode, Former UPN, English Additional Language, Home Language, Ethnic Data Source etc.

TPPersonStudent.GetXmlStudents(int studentId)

This method gets information of a student passed as a parameter. It gets additional information in the Student XML like Birth Certificate Seen, Attendance Mode, Former UPN, English Additional Language, Home Language, Ethnic Data Source etc.

e.g.

TPPersonStudent studentInfo = new TPPersonStudent();
string data = studentInfo.GetXmlStudents(2447);

Sample return (May be added to over time!)

Output :
<StudentExtendeds>
  <Student>
    <PersonID>2447</PersonID>
    <Forename>Ben</Forename>
    <Surname>Abbot</Surname>
    <ChosenName />
    <MiddleName />
    <LegalSurname>Abbot</LegalSurname>
    <Gender>Male</Gender>
    <GenderID>0</GenderID>
    <DOB>1986-01-17T00:00:00</DOB>
    <BirthCertificateSeen>F</BirthCertificateSeen>
    <AttendanceMode>All Day</AttendanceMode>
    <AttendanceModeID>-1</AttendanceModeID>
    <FormerUPN />
    <UniqueLearnerNumber />
    <YearTaughtIn />
    <YearTaughtInID />
    <EmergencyConsent>F</EmergencyConsent>
    <NHSNumber />
    <BloodGroup />
    <EthnicDataSource>Provided by the parent</EthnicDataSource>
    <EthnicDataSourceID>2019</EthnicDataSourceID>
    <HomeLanguage>English</HomeLanguage>
    <HomeLanguageID>366</HomeLanguageID>
    <FirstLanguage>English</FirstLanguage>
    <FirstLanguageID>2027</FirstLanguageID>
    <EnglishAdditionalLanguage />
    <EnglishAdditionalLanguageID />
    <NationalIdentity />
    <NationalIdentityID />
    <AdmissionNumber>001511</AdmissionNumber>
    <UPN>U820432190122</UPN>
    <Religion>Christian*</Religion>
    <ReligionID>339</ReligionID>
    <RegGroup />
    <RegGroupID />
    <YearGroup />
    <YearGroupID />
    <House />
    <HouseID />
    <RollMode>Single Registration</RollMode>
    <RollModeID>2</RollModeID>
    <AdmissionDate>1997-09-03T00:00:00</AdmissionDate>
    <DateOfLeaving>2004-07-23T23:59:00</DateOfLeaving>
    <ParentalSalutation>Mr F and Mrs R Abbot</ParentalSalutation>
  </Student>
<StudentExtendeds>

TPPersonStudent.GetXmlStudentsNationalities(System.DateTime)

This will get all the nationality description related to all students from SIMS system valid within date supplied. The output returned from the interface will be as below

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<StudentNationalities>
  <StudentNationality>
    <PersonID>6034</PersonID>
    <Nationality>Somalia</Nationality>
  </StudentNationality>
</StudentNationalities

TPPersonStudent.GetXmlChangedStudents(DateTime referenceDate)

1) Calling the interface on referenceDate 04/01/2010 will get all the students from SIMS system as shown below:

TPPersonStudent studInfo = new TPPersonStudent();
string changeddata = studInfo.GetXmlChangedStudents(DateTime.Parse("04/01/2010"));

2) Calling this interface after modifying/deleting/adding students [with appropriate date] returns only the changed student information. Sample code and out for each is shown below:

a) Modifying an existing Student. Add middle name to Student with personId 5253 [Ben Abbot]

TPPersonStudent studInfo = new TPPersonStudent();
string changeddata = studInfo.GetXmlChangedStudents(System.DateTime.Now);

Output:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<StudentExtendeds>
  <Student>
    <PersonID>5253</PersonID>
    <Forename>Benja</Forename>
    <Surname>Abbot</Surname>
    <ChosenName>Ben</ChosenName>
    <MiddleName>Michael</MiddleName>
    <LegalSurname>Abbot</LegalSurname>
    <Gender>Male</Gender>
    <GenderID>0</GenderID>
    <DOB>1993-07-12T00:00:00</DOB>
    <BirthCertificateSeen>T</BirthCertificateSeen>
    <AttendanceMode>All Day</AttendanceMode>
    <AttendanceModeID>-1</AttendanceModeID>
    <FormerUPN />
    <UniqueLearnerNumber />
    <YearTaughtIn>Curriculum Year 12</YearTaughtIn>
    <YearTaughtInID>25</YearTaughtInID>
    <EmergencyConsent>T</EmergencyConsent>
    <NHSNumber />
    <BloodGroup>AB-</BloodGroup>
    <EthnicDataSource>Provided by the parent</EthnicDataSource>
    <EthnicDataSourceID>2019</EthnicDataSourceID>
    <HomeLanguage>English</HomeLanguage>
    <HomeLanguageID>366</HomeLanguageID>
    <FirstLanguage>English</FirstLanguage>
    <FirstLanguageID>2027</FirstLanguageID>
    <EnglishAdditionalLanguage />
    <EnglishAdditionalLanguageID />
    <NationalIdentity>English</NationalIdentity>
    <NationalIdentityID>2</NationalIdentityID>
    <QuickNote />
    <PhotoID>87</PhotoID>
    <AdmissionNumber>002912</AdmissionNumber>
    <UPN>X820432104001</UPN>
    <Religion>Christian</Religion>
    <ReligionID>2099</ReligionID>
    <RegGroup>N</RegGroup>
    <RegGroupID>421</RegGroupID>
    <YearGroup>Year 12</YearGroup>
    <YearGroupID>32</YearGroupID>
    <House>Hooke</House>
    <HouseID>43</HouseID>
    <RollMode>Single Registration</RollMode>
    <RollModeID>2</RollModeID>
    <AdmissionDate>2004-09-01T00:00:00</AdmissionDate>
    <DateOfLeaving />
    <ParentalSalutation>Mr and Mrs Abbot</ParentalSalutation>
  </Student>
</StudentExtendeds>

b) Add a new Student with Surname and Forename as TestSurname and TestForename

Calling this interface will get the information of this newly added student.

TPPersonStudent studInfo = new TPPersonStudent();
string changeddata = studInfo.GetXmlChangedStudents(System.DateTime.Now);

Output :

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<StudentExtendeds>
  <Student>
    <PersonID>7660</PersonID>
    <Forename>TestForename</Forename>
    <Surname>TestSurname</Surname>
    <ChosenName>TestForename</ChosenName>
    <MiddleName />
    <LegalSurname>TestSurname</LegalSurname>
    <Gender>Male</Gender>
    <GenderID>0</GenderID>
    <DOB>1993-07-15T00:00:00</DOB>
    <BirthCertificateSeen>T</BirthCertificateSeen>
    <AttendanceMode>All Day</AttendanceMode>
    <AttendanceModeID>-1</AttendanceModeID>
    <FormerUPN />
    <UniqueLearnerNumber />
    <YearTaughtIn>Curriculum Year 12</YearTaughtIn>
    <YearTaughtInID>25</YearTaughtInID>
    <EmergencyConsent>F</EmergencyConsent>
    <NHSNumber />
    <BloodGroup />
    <EthnicDataSource />
    <EthnicDataSourceID />
    <HomeLanguage />
    <HomeLanguageID />
    <FirstLanguage />
    <FirstLanguageID />
    <EnglishAdditionalLanguage />
    <EnglishAdditionalLanguageID />
    <NationalIdentity />
    <NationalIdentityID />
    <QuickNote />
    <PhotoID />
    <AdmissionNumber>003762</AdmissionNumber>
    <UPN>P823432109001</UPN>
    <Religion />
    <ReligionID />
    <RegGroup>N</RegGroup>
    <RegGroupID>421</RegGroupID>
    <YearGroup>Year 12</YearGroup>
    <YearGroupID>32</YearGroupID>
    <House>Newton</House>
    <HouseID>44</HouseID>
    <RollMode>Single Registration</RollMode>
    <RollModeID>2</RollModeID>
    <AdmissionDate>2010-01-12T00:00:00</AdmissionDate>
    <DateOfLeaving />
    <ParentalSalutation />
  </Student>
</StudentExtendeds>

c) Deleting the Student [personId - 7660 ] added above in Step 2b) and calling this interface:

TPPersonStudent studInfo = new TPPersonStudent();
string changeddata = studInfo.GetXmlChangedStudents(System.DateTime.Now);

Output:

<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<StudentExtendeds>
  <Student deleted="true">
    <PersonID>7660</PersonID>
  </Student
</StudentExtendeds