© 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.
SIMS the MIS of choice supporting teachers, senior leaders and wider staff with the tools to efficiently drive improvement in their schools.
Updated 30/5/22 - Current version of GetXmlEmployees has additional data including external id.
This interface gets all the employees from SIMS system which are valid against the date supplied. Sample output from this interface is as below
This interface gets the information of an employee against the personId passed as parameter
Sample code and output is shown below
TPPersonEmployee employeeInfo = new TPPersonEmployee();
string employeeXml = employeeInfo.GetXmlEmployees(1);
This interface gets the information of all Employees present in SIMS system
<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Employees>
<Employee>
<PersonID>9993</PersonID>
<Forename>Jez</Forename>
<Surname>Smith</Surname>
<ChosenName>John</ChosenName>
<MiddleName />
<LegalSurname>Smith</LegalSurname>
<Gender>Male</Gender>
<GenderID>0</GenderID>
<GenderCode>M</GenderCode>
<DOB>1963-09-17T00:00:00</DOB>
<Title>Mr</Title>
<PhotoID />
<Photo />
<ExternalId>2378b75d-3d77-48e6-9999-00f59dadc0eb</ExternalId>
<Initials />
<EmploymentStart />
<EmploymentEnd />
<TeacherCode />
<IsTeachingStaff>F</IsTeachingStaff>
<IsSupportStaff>F</IsSupportStaff>
</Employee>
This will return the salary details of all the staff members defined in the system
<SalaryDetails>
<Version>1.1</Version>
<Contracts>
<Contract>
<Staff>Mr A Blacker</Staff>
<PersonExternalId>E33545C8-4DFE-4334-80B9-D986414B1F8D</PersonExternalId>
<PayrollNumber>PR122277</PayrollNumber>
<PostDescription>Headteacher</PostDescription>
<EmploymentType>Permanent</EmploymentType>
<ServiceTermHoursPerWeek>32.5000</ServiceTermHoursPerWeek>
<ServiceTermWeeksPerYear>52.1430</ServiceTermWeeksPerYear>
<ContractExternalId>EFB0A774-61CD-42A8-973E-8438F4B45FC0</ContractExternalId>
<ContractStartDate>2000-09-01T00:00:00</ContractStartDate>
<ContractHoursPerWeek>32.5000</ContractHoursPerWeek>
<ContractWeeksPerYear>52.1430</ContractWeeksPerYear>
<SalaryScales>
<Scale>
<ContractScaleExternalId>16E99E9F-9B0F-4D01-8191-A1983BD58028</ContractScaleExternalId>
<ScaleCode>HTG5</ScaleCode>
<ScaleDescription>Headteacher Group 5</ScaleDescription>
<ScaleStartDate>2006-09-01T00:00:00</ScaleStartDate>
<ScalePoint>27.0</ScalePoint>
<RegionalPaySpine>Rest of England</RegionalPaySpine>
<SalaryAwards>
<ScaleAward>
<AwardDate>2006-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>64593.0000</Amount>
</ScaleAward>
<ScaleAward>
<AwardDate>2007-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>66210.0000</Amount>
</ScaleAward>
<ScaleAward>
<AwardDate>2008-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>67833.0000</Amount>
</ScaleAward>
<ScaleAward>
<AwardDate>2009-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>69394.0000</Amount>
</ScaleAward>
<ScaleAward>
<AwardDate>2010-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>70991.0000</Amount>
</ScaleAward>
<ScaleAward>
<AwardDate>2013-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>71701.0000</Amount>
</ScaleAward>
<ScaleAward>
<AwardDate>2005-09-01T00:00:00</AwardDate>
<Point>27.0</Point>
<Amount>63015.0000</Amount>
</ScaleAward>
</SalaryAwards>
</Scale>
</SalaryScales>
</Contract>
<Contract>
Retrieve the basic details for employees who do not have a date of leaving or whose date of leaving is before 730 days (dol > (today - 730))
<SuperStarReport>
<Version>1.1</Version>
<Records>
<Record>
<primary_id>26</primary_id>
<ID>26</ID>
<ExternalId>B6BAAAB5-B025-45B8-A2D1-47F4C1754A80</ExternalId>
<LegalSurname>Abell</LegalSurname>
<LegalForename>Anita</LegalForename>
<Title>Mrs</Title>
<Gender>F</Gender>
<DateofBirth>1963-02-11T00:00:00</DateofBirth>
<NINumber>BC172692B</NINumber>
<HouseNumber>10</HouseNumber>
<Street>Dudmore Road</Street>
<Town>Swindon</Town>
<Country>United Kingdom</Country>
<Postcode>SN3 1AF</Postcode>
<HomeTelephone>01632 853922</HomeTelephone>
<HomeEmail>Abell@example.com</HomeEmail>
<SortCode>403020</SortCode>
<AccountNumber>31072006</AccountNumber>
<EmploymentStartDate>1988-09-01T00:00:00</EmploymentStartDate>
<ContinuousServiceStartDate>1986-09-01T00:00:00</ContinuousServiceStartDate>
<TeacherNumber>84/82693</TeacherNumber>
<Ethnicity>White, British</Ethnicity>
<AddressStartDate>1988-09-01T00:00:00</AddressStartDate>
</Record>
</Records>
Retrieve the staff absence details for employees who do not have a date of leaving or whose date of leaving is before 730 days (dol > (today - 730))
<SuperStarReport>
<Version>1.1</Version>
<Records>
<Record>
<multiple_id>49,983,0</multiple_id>
<ID>49</ID>
<ExternalId>C32C88D8-6757-47E9-89BA-7B8ACAEB302D</ExternalId>
<StartDate>2014-12-08T00:00:00</StartDate>
<StartTime>00:00</StartTime>
<EndDate>2014-12-12T23:59:00</EndDate>
<EndTime>23:59</EndTime>
<AbsenceType>Sickness</AbsenceType>
<IllnessCategory>Gastrointestinal Condition</IllnessCategory>
<WorkingDaysLost>5.0000</WorkingDaysLost>
<SSPExclusion>F</SSPExclusion>
<NumberofHoursLost>0.0000</NumberofHoursLost>
</Record>
Retrieve the details regarding the checks the employees have undergone for staff who do not have a date of leaving or whose date of leaving is before 730 days (dol > (today - 730))
1) Calling the interface on referenceDate 04/01/2010 will get all the employees from SIMS system as shown below:
TPPersonEmployee empInfo = new TPPersonEmployee();
string alldata = empInfo.GetXmlChangedEmployees(DateTime.Parse(“04/01/2009”));
2) Modify the Middle Name(s) and ‘Is Support Staff’ of employee Anita Abell
Calling this interface after modifying an employee [with appropriate date] returns only the changed employee information
TPPersonEmployee empInfo = new TPPersonEmployee();
string changeddata = empInfo.GetXmlChangedEmployees(System.DateTime.Now);
Output:
<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Employees>
<Employee>
<PersonID>26</PersonID>
<Forename>Anita</Forename>
<Surname>Abell</Surname>
<ChosenName>Anita</ChosenName>
<MiddleName>Middle Name</MiddleName>
<LegalSurname>Abell</LegalSurname>
<Gender>Female</Gender>
<GenderID>1</GenderID>
<DOB>1963-02-11T00:00:00</DOB>
<Title>Mrs</Title>
<Initials>AA</Initials>
<EmploymentStart>1988-09-01T00:00:00</EmploymentStart>
<EmploymentEnd />
<TeacherCode>8482693</TeacherCode>
<IsTeachingStaff>T</IsTeachingStaff>
<IsSupportStaff>F</IsSupportStaff>
<PhotoID>191</PhotoID>
</Employee>
</Employees>
3) Add a new teacher in SIMS [TestForename, TestSurname] database. Calling this interface with appropriate date will get the newly added teacher from SIMS. Call to this interface after adding the teacher and output is shown below:
TPPersonEmployee empInfo = new TPPersonEmployee();
string changeddata = empInfo.GetXmlChangedEmployees(System.DateTime.Now);
Output:
<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Employees>
<Employee>
<PersonID>7659</PersonID>
<Forename>TestForename</Forename>
<Surname>TestSurname</Surname>
<ChosenName>TestForename</ChosenName>
<MiddleName />
<LegalSurname>TestSurname</LegalSurname>
<Gender>Female</Gender>
<GenderID>1</GenderID>
<DOB>1969-08-16T00:00:00</DOB>
<Title />
<Initials />
<EmploymentStart>2009-05-12T00:00:00</EmploymentStart>
<EmploymentEnd />
<TeacherCode />
<IsTeachingStaff>F</IsTeachingStaff>
<IsSupportStaff>F</IsSupportStaff>
<PhotoID />
</Employee>
</Employees>
4) Delete the employee 7659 [TestForename, TestSurname] from SIMS system. Call this interface after deleting this employee from database.
Sample code and output is shown below:
TPPersonEmployee empInfo = new TPPersonEmployee();
string changeddata = empInfo.GetXmlChangedEmployees(System.DateTime.Now);
Output:
<?xml version="1.0" encoding="iso-8859-1" standalone="yes"?>
<Employees>
<Employee deleted="true">
<PersonID>7659</PersonID>
</Employee>
</Employees>