© 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.

Example calls and responses for SIMS Primary Standard V2 APIs

Example calls and responses for SIMS Primary Standard V2 APIs

SIMS Primary APIS - Lookups - General - Genders

https://pmapis.azure-api.net/sp-api-partner-live/V2/Lookup/General/Genders

SIMS Primary APIS - Lookups - General - Titles

https://pmapis.azure-api.net/sp-api-partner-live/V2/Lookup/General/Titles

SIMS Primary APIS - Lookups - General - LocationTypes

https://pmapis.azure-api.net/sp-api-partner-live/V2/Lookup/General/LocationTypes

SIMS Primary APIS - Lookups - Staff - Staff Roles

https://pmapis.azure-api.net/sp-api-partner-live/V2/Lookup/Staff/StaffRoles

SIMS Primary APIS - Staff - Contact Details - Emails

https://pmapis.azure-api.net/sp-api-partner-live//V2/Staff/Staffs?$expand=ContactDetails($expand=StaffEmails)

SIMS Primary APIS - Staff - Contact Details - Telephones

https://pmapis.azure-api.net/sp-api-partner-live/V2/Staff/Staffs?$expand=ContactDetails($expand=StaffTelephones($expand=LocationType))

SIMS Primary APIS - Staff - Contact Details - Addresses

https://pmapis.azure-api.net/sp-api-partner-live//V2/Staff/Staffs?$expand=ContactDetails($expand=StaffAddresses($expand=Address))

SIMS Primary APIS - Staff- Basic and Extended

https://pmapis.azure-api.net/sp-api-partner-live/V2/Staff/Staffs?$expand=Basic($expand=Title,Gender),Extended($expand=StaffVehicleDetail)

SIMS Primary APIS - Staff - Employee - Contractual

https://pmapis.azure-api.net/sp-api-partner-live//V2/Staff/Staffs?$expand=Contractual($expand=Employee($expand=EmploymentContract),StaffRoleAssignment($expand=StaffRole))

SIMS Primary APIS - Schools- School - Primary Classes

https://pmapis.azure-api.net/sp-api-partner-live/V2/School/Schools?$expand=Group($expand=PrimaryClasses)&$filter=Details/IsRegistered eq true

SIMS Primary APIS - Schools- School - Year Groups

https://pmapis.azure-api.net/sp-api-partner-live//V2/School/Schools?$expand=Group($expand=YearGroups)&$filter=Details/IsRegistered eq true

SIMS Primary APIS - Schools- School -House

https://pmapis.azure-api.net/sp-api-partner-live//V2/School/Schools?$expand=Group($expand=Houses)&$filter=Details/IsRegistered eq true

SIMS Primary APIS - Attendance - Statutory School Attendance Sessions

https://pmapis.azure-api.net/sp-api-partner-live/V2/Attendance/StatutoryAttendanceSessionAttendanceSessions

SIMS Primary APIS - Learner- Registration - YearGroups

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$expand=Registration($expand=CurrentYearGroup,LearnerYearGroupMemberships($expand=YearGroup))

SIMS Primary APIS - Attendance - School Attendance Codes

https://pmapis.azure-api.net/sp-api-partner-live/V2/Lookup/Attendance/SchoolAttendanceCodes

SIMS Primary APIS - Learner- Registration - Learner Enrolments

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$expand=Registration($expand=LearnerEnrolments)

SIMS Primary APIS - Learner- Registration - Current Primary Class

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$expand=Registration($expand=CurrentPrimaryClass,LearnerPrimaryClassMemberships($expand=PrimaryClass))

SIMS Primary APIS - Learner- Personal

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$expand=Personal($expand=Gender)

SIMS Primary APIS - Learner- LearnerContact - Learner Contact Address

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$select=ExternalID&$expand=ContactDetails($select=ExternalID;$expand=LearnerAddresses($select=ExternalID,StartDate,EndDate;$expand=Address($select=ExternalID,PAONDescription,...

SIMS Primary APIS - Learner- LearnerContact - Learner Contact Emails and Phones

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$select=ExternalID&$expand=ContactDetails($select=ExternalID;$expand=LearnerEmails($select=ExternalID,EmailAddress,UseForTextMessages),LearnerTelephones ...

SIMS Primary APIS - Learner- Learner Medical - Learner Medical Practices

https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$select=ExternalID&$expand=Medical($select=ExternalID,NHSNumber;$expand=LearnerMedicalPractices($expand=Doctor($select=ExternalID,Forename,Surname),MedicalPractice ...

SIMS Primary APIS - LearnerContact- LearnerContact

https://pmapis.azure-api.net/sp-api-partner-live/V2/LearnerContact/LearnerContacts?$expand=Basic($expand=Title,LearnerContactRelationships($expand=Learner))

SIMS Primary RESOURCES

Related resources for SIMS Primary

Working with SIMS Primary APIs

Working with the SIMS 8 APIs

Explore

SIMS Primary Standard APIs – V2.

Explore

SIMS Primary Enhanced APIs

Enhanced APIs

Explore