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

Sample OData Queries

Who should read this document?


Developers first and foremost
Technical Leads may want to make themselves aware of the existence of the document.
Technical Leads are asked to encourage developers to submit additional samples to partner.support@capita.co.uk using the tag #SIMSPRIMARYEXAMPLES in the subject line.

What’s in the document?

This document is intended to showcase a set of Sample OData queries for SIMS Primary. The expectation is that it will cover many of the areas needed by partners but at the very least it will offer useful examples.

What Should Developers Read in Addition to this Document?

http://www.odata.org/ offers a whole host of excellent documentation and tools to support the creation of OData requests.

Please note that OData is a framework and offers many optional extensions.

  • SIMS Primary APIs do not support every possible extension.
  • Some SIMS Primary calls may support additional optional extensions.

 


    Admissions – Domain Namespace

    Details of applications made to the school and associated enrolments for learners along with the school intake groups.

    Admissions.Application - Domain

    Details of applications and enrolments for a school from an application perspective.

    Applications and their associated learner - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Admissions/Applications?$select=ExternalID,ApplicationReferenceNumber,CurrentYearGroup,DateOf
    Application,IsLateApplication&$expand=ProposedEnrolmentStatus($select=ExternalID)

    Expand lookups for enrolment status.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/EnrolmentStatus

     

    {
                "IsDeleted": false, 
                "ExternalID": "8ffc6a67-a318-4674-a66b-0250be4b7dab", 
                "Code": "C", 
                "Description": "Single Registration", 
                "DisplayOrder": 1, 
                "IsVisible": true, 
                "IsGuest": false
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "ceb4e080-991a-4569-81bf-45b2e2a976a0", 
                "Code": "M", 
                "Description": "Main – Dual Registration", 
                "DisplayOrder": 3, 
                "IsVisible": true, 
                "IsGuest": false
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "e4817aa2-611a-4065-80e2-c090ee313cbc", 
                "Code": "S", 
                "Description": "Subsidiary – Dual Registration", 
                "DisplayOrder": 4, 
                "IsVisible": true, 
                "IsGuest": false
            }, ...

    Applications and the logs of their status es- Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Admissions/Applications?
    $select=ExternalID&$expand=ApplicationStatusLogs($select=ExternalID,
    ChangedBy,ChangedDateTime;$expand=ApplicationStatus($select=ExternalID))

    Lookup values for application statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/ApplicationStatus

    Admission groups for applications - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Admissions/Applications?$select=ExternalID&$expand=AdmissionGroup($select=ExternalID)

    Lookup values for admission groups

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Admissions/GroupsSchoolIntakes?$select=ExternalID&$expand=AdmissionGroups($select=ExternalID,Capacity,DateOfAdmission,Name,IsActive)

    Applications and their enrolments - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Admissions/Applications?$select=ExternalID&$expand=ProposedEnrolmentStatus($select=ExternalID),LearnerEnrolment($select=ExternalID)

    Lookup values for enrolment statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/EnrolmentStatus

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "8ffc6a67-a318-4674-a66b-0250be4b7dab",
    
    "Code" : "C",
    
    "Description" : "Single Registration",
    
    "DisplayOrder" : 1,
    
    "IsVisible" : true,
    
    "IsGuest" : false
    
    },
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "ceb4e080-991a-4569-81bf-45b2e2a976a0",
    
    "Code" : "M",
    
    "Description" : "Main – Dual Registration",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true,
    
    "IsGuest" : false
    
    }, ...

    Lookup enrolments.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Registration($select=ExternalID;$expand=LearnerEnrolments($select=ExternalID))

    Admissions.Groups - Domain

    A school can have multiple intakes over the school year and within each intake multiple intake groups.

    All intakes along and any associated intake groups - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Admissions/GroupsSchools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$select=ExternalID&$expand=SchoolIntakes($select=ExternalID,Name,IsActive,PlannedAdmissionNumber,YearOfAdmission;$expand=AdmissionGroups($select=ExternalID,Capacity,DateOfAdmission,IsActive,Name),YearGroup($select=ExternalID))

    {
        "ExternalID": "f2e1813a-b266-42f2-b786-43e1a5bc3da1", 
        "SchoolIntakes": [
            {
                "ExternalID": "f8b01de7-db73-49a9-9a79-0db18a020179", 
                "Name": null, 
                "IsActive": false, 
                "PlannedAdmissionNumber": 0, 
                "AdmissionGroups": [ ], 
                "YearGroup": null
            }
        ]
    }, ...

    Lookup values for year groups.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$select=ExternalID&$expand=Group($select=ExternalID;$expand=YearGroups($select=ExternalID,FullName,ShortName)) 

    {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "Group" : {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "YearGroups" : [
    
    {
    
    "ExternalID" : "83acc144-0681-4ab6-8188-f393c7510da8",
    
    "FullName" : "Year 1",
    
    "ShortName" : "1"
    
    } ,
    
    {
    
    "ExternalID" : "9012d8d3-4a2f-4436-804d-2d8449bd36ff",
    
    "FullName" : "Year 2",
    
    "ShortName" : "2"
    
    } ,
    
    {
    
    "ExternalID" : "fef6879b-b526-4cef-9eab-f320467becaa",
    
    "FullName" : "Year 6",
    
    "ShortName" : "6"
    
    } ,
    
    {
    
    "ExternalID" : "a6beeec4-1726-4a5b-b4d1-d274cc03cc06",
    
    "FullName" : "Year N1",
    
    "ShortName" : "N1"
    
    } ,
    
    {
    
    "ExternalID" : "472bf8d1-0c9e-40d6-bf60-a6a001ed4e3e",
    
    "FullName" : "Year 5",
    
    "ShortName" : "5"
    
    } ,
    
    {
    
    "ExternalID" : "0a85a667-7cac-4302-a3d7-fa06329bae64",
    
    "FullName" : "Year R",
    
    "ShortName" : "R"
    
    } ,
    
    {
    
    "ExternalID" : "d0e3246c-f65a-4e20-b30e-db9eb3f955be",
    
    "FullName" : "Year N2",
    
    "ShortName" : "N2"
    
    } ,
    
    {
    
    "ExternalID" : "3a5f1a26-8c42-4a70-918c-be4ad4642e1a",
    
    "FullName" : "Year 4",
    
    "ShortName" : "4"
    
    } ,
    
    {
    
    "ExternalID" : "19afb758-d965-4ae2-bbad-f6d46181f52c",
    
    "FullName" : "Year 3",
    
    "ShortName" : "3"
    
    }
    
    ]
    
    }
    
    }
    


    Agency – Domain Namespace

    Details of agencies which work with the school.

    Agency.Detail - Domain

    Details of agencies which work with the school.

    All agencies including their name, telephone numbers and email addresses - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Agency/Agencies?$select=ExternalID&$expand=Detail($select=ExternalID,AgencyName,Website;$expand=AgencyEmails($select=ExternalID,EmailAddress,IsMainEmail),AgencyTelephones($select=ExternalID,TelephoneNumber,IsMainTelephone))

    {
    
    "ExternalID" : "3c179f8e-975d-47ef-836b-fd677a3ff7ce",
    
    "Detail" : {
    
    "ExternalID" : "3c179f8e-975d-47ef-836b-fd677a3ff7ce",
    
    "AgencyName" : "Speech Therapy Unit",
    
    "Website" : null,
    
    "AgencyEmails" : [
    
    {
    
    "ExternalID" : "d4540ba0-4227-478f-ae70-f7a378829ec0",
    
    "EmailAddress" : "spt@barset.org",
    
    "IsMainEmail" : true
    
    }
    
    ] ,
    
    "AgencyTelephones" : [
    
    {
    
    "ExternalID" : "fd8e49c8-ab6c-45c3-9418-83d2375c72bc",
    
    "TelephoneNumber" : "01201 320981",
    
    "IsMainTelephone" : true
    
    }
    
    ]
    
    }
    
    }
    

    All services provided by an agency - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/AgentAgency/Agencies?$expand=ServiceProvideds($select=ExternalID;$expand=ServiceType($select=ExternalID,Code,Description))

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "d1ba087c-4694-47b9-b574-42240f4001b4",
    
    "ServiceProvideds" : [
    
    {
    
    "ExternalID" : "eb273728-d34a-411c-be92-67aa84f9e414",
    
    "ServiceType" : {
    
    "ExternalID" : "550206fe-7864-4e9c-a314-6f2e645f2110",
    
    "Code" : "OTH",
    
    "Description" : "Other"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "90cf3c5e-dedb-4aae-b21d-c0bbf4e2080c",
    
    "ServiceType" : {
    
    "ExternalID" : "01c3199e-30af-4908-afde-ff9adf22e4bd",
    
    "Code" : "ST",
    
    "Description" : "Speech Therapist"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "a7ef57c1-9ff5-484a-b5c7-88283070d80d",
    
    "ServiceType" : {
    
    "ExternalID" : "3c0a9b17-5ca5-4773-853c-9f6b10a3c386",
    
    "Code" : "BMT",
    
    "Description" : "Behaviour Modification Therapist"
    
    }
    
    }
    
    ]
    
    }
    


    Agent - Domain Namespace

    Details of individuals who work with the school.

    Agent.Detail - Domain

    Details of individuals who work with the school.

    All agents’ telephone numbers and email addresses - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Agent/Agents?$select=ExternalID&$expand=Detail($select=ExternalID,PreferredForename,PreferredSurname;$expand=AgentTelephones($select=ExternalID,TelephoneNumber,IsMainTelephone),AgentEmails($select=ExternalID,EmailAddress,IsMainEmail))

    {
        "ExternalID": "24b512ce-80ad-4566-855c-8e2628016790", 
        "Detail": {
            "ExternalID": "24b512ce-80ad-4566-855c-8e2628016790", 
            "PreferredForename": "Colin", 
            "PreferredSurname": null, 
            "AgentTelephones": [
                {
                    "ExternalID": "e6a2c097-31bd-430d-9170-8e3f25912ef6", 
                    "TelephoneNumber": "01632 567098", 
                    "IsMainTelephone": true
                }
            ], 
            "AgentEmails": [
                {
                    "ExternalID": "613921ef-e917-40fb-997c-17c9d3e11d9f", 
                    "EmailAddress": "chorton@example.com", 
                    "IsMainEmail": true
                }
            ]
        }
    }

    Lookup details of services provided by all agents - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/AgentAgency/Agents?$expand=ServiceProvideds($select=ExternalID;$expand=ServiceType($select=ExternalID,Code,Description))

    {
    
    "ExternalID" : "24b512ce-80ad-4566-855c-8e2628016790",
    
    "ServiceProvideds" : [
    
    {
    
    "ExternalID" : "7ed00ecd-4241-4c5f-8135-94bdd6ff2623",
    
    "ServiceType" : {
    
    "ExternalID" : "a66bc9ab-13ad-49d1-90e7-f9d5ecd5da76",
    
    "Code" : "CAM",
    
    "Description" : "Childcare & Adolescent Mental Health Therapist"
    
    }
    
    }
    
    ]
    
    } , ...


    Assessment – Domain Namespace

    Details relating to the assessment of learners.

    Assessment.Aspect – Domain

    Describes the ‘aspect’, which defines the purpose for an assessment, the methodology being used and the learning activity it relates to. A gradeset, containing details of possible marks, is combined with an ‘aspect’ to complete the definition of why marks are taken and which mark values are recorded.

    Get all aspects, their purpose and parent gradeset (result type) - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/Aspects?$select=ExternalID,Code,Description,IsStatutory,StatutoryCode&$expand=ResultType($select=ExternalID),AssessmentPurpose($select=ExternalID) Lookup

    {
    
    "ExternalID" : "89a70aac-c682-413f-a7dc-1d84656fc463",
    
    "Code" : "KS1-ENG-RDT-TT-NS",
    
    "Description" : "Used to store the total test mark for the KS1 Reading (1 and 2) Tests of the reformed curriculum (Assessment without Levels) tests from 2016 onwards",
    
    "IsStatutory" : true,
    
    "StatutoryCode" : "RDT",
    
    "ResultType" : {
    
    "ExternalID" : "2ff4e261-96b5-4f72-9b89-abae7f1bb6ba"
    
    } ,
    
    "AssessmentPurpose" : {
    
    "ExternalID" : "43e20eb8-8fe6-42c5-94ab-86e7b2573f4a"
    
    }
    
    }, ...
    

    gradesets (result type) and their instances each of which is valid for a period of time.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/GradeSetAssessmentGradesets?$select=ExternalID,Code,Description&$expand=AssessmentGradesetInstances($select=ExternalID,StartDate,EndDate)

    {
        "ExternalID": "56627f5f-24bf-43b7-bb25-01c39520acd8", 
        "Code": "Q49AR", 
        "Description": "QCA Year 4 Mental Arithmetic Raw Score", 
        "AssessmentGradesetInstances": [
            {
                "ExternalID": "e289c4ec-3773-4806-9cbc-f88a2e6a961c", 
                "StartDate": "2000-09-01T00:00:00Z", 
                "EndDate": "2001-08-31T00:00:00Z"
            }, 
            {
                "ExternalID": "da5a5295-4a28-46b1-95e5-7a968a30e2a5", 
                "StartDate": "1990-09-01T00:00:00Z", 
                "EndDate": "2000-08-31T00:00:00Z"
            }, 
            {
                "ExternalID": "2ad30ea5-d8c8-428f-8159-80875fab13df", 
                "StartDate": "2002-09-01T00:00:00Z", 
                "EndDate": "2003-08-31T00:00:00Z"
            }, 
            {
                "ExternalID": "a1fe6adb-8465-45f5-b106-079018a45bac", 
                "StartDate": "2003-09-01T00:00:00Z", 
                "EndDate": "0001-01-01T00:00:00Z"
            }, 
            {
                "ExternalID": "f52f1cf5-a1db-478a-8322-c9b1627a97ea", 
                "StartDate": "2001-09-01T00:00:00Z", 
                "EndDate": "2002-08-31T00:00:00Z"
            }
        ]
    }

    Lookup assessment purposes.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Assessment/AssessmentPurposes

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "43e20eb8-8fe6-42c5-94ab-86e7b2573f4a",
    
    "Code" : "ATN",
    
    "Description" : "Attainment",
    
    "DisplayOrder" : 1,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "fc684c7e-30f7-4352-b9a3-d235d0101a29",
    
    "Code" : "BHV",
    
    "Description" : "Behaviour",
    
    "DisplayOrder" : 2,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "279056bc-4e15-4d30-b39e-ca21c5980ef1",
    
    "Code" : "PROGRESS",
    
    "Description" : "Progress",
    
    "DisplayOrder" : 5,
    
    "IsVisible" : true
    
    }

    Assessment.AssessmentPeriod - Domain

    Details of an assessment period, which will relate to a named date range used by the school or a formal assessment period. Each assessment period would typically have a National Curriculum year associated with it.

    Named assessment periods along with associated date ranges and NC year - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/AssessmentPeriods?$select=ExternalID,Name,ReferenceDateDay,ReferenceDateMonth,ValidFrom,ValidTo,Code&$expand=AssessmentPeriodDateRanges($select=ExternalID;$expand=NamedDateRange($select=ExternalID)),NCYear

    {
        "ExternalID": "d6657504-bfc9-463e-b6d7-56e7e67c594f", 
        "Name": "Year 1 Phonics Check", 
        "ReferenceDateDay": 12, 
        "ReferenceDateMonth": 6, 
        "ValidFrom": "0001-01-01T00:00:00Z", 
        "ValidTo": "0001-01-01T00:00:00Z", 
        "Code": "KS1PhonicsCheck", 
        "AssessmentPeriodDateRanges": [ ], 
        "NCYear": {
            "IsDeleted": false, 
            "ExternalID": "c0928822-feb4-4289-b1d8-2b8556da51c7"
        }
    }, ...

    Get lookup values for the NCYears

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/School/NCYears

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "5d42e1ae-5144-419b-9970-93f282e79b74",
    
    "ShortName" : "N2",
    
    "FullName" : "Curriculum Year N2",
    
    "DisplayOrder" : 4,
    
    "IsVisible" : false
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "5fb69c5c-ea84-498a-948b-01a7e219826b",
    
    "ShortName" : "R",
    
    "FullName" : "Curriculum Year R",
    
    "DisplayOrder" : 5,
    
    "IsVisible" : false
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "c0928822-feb4-4289-b1d8-2b8556da51c7",
    
    "ShortName" : "1",
    
    "FullName" : "Curriculum Year 1",
    
    "DisplayOrder" : 6,
    
    "IsVisible" : false
    
    }, ...
    

    Formal assessment periods for the school and the National Curriculum year - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/AssessmentPeriods?$select=ExternalID,Name,ReferenceDateDay,ReferenceDateMonth,ValidFrom,ValidTo,Code&$expand=FormalAssessmentPeriod($select=ExternalID),NCYear($select=ExternalID)

    Assessment. Gradeset – Domain

    Contains details relating to gradesets. A single gradeset, such as ‘SC KS2: Science Test A’, would typically contain several gradeset instances, each of which holds details about the possible grades which apply for a particular period of time. A gradeset is combined with an aspect to complete the definition of why and how a set of marks are taken.

    Gradesets and their instances - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/GradeSetAssessmentGradesets?$select=ExternalID,Code,Description&$expand=AssessmentGradesetType($select=ExternalID),AssessmentGradesetInstances($select=ExternalID,StartDate,EndDate,DecimalPlaces,MinimumValue,MaximumValue;$expand=AssessmentGrades($select=ExternalID,Code,Description,Style,Value))

    {
    
    "ExternalID" : "63001ded-6843-43e5-bdb6-fbe51d0a72fe",
    
    "Code" : "KS1-ENG-REM-TT-NE-Grade",
    
    "Description" : null,
    
    "AssessmentGradesetType" : {
    
    "ExternalID" : "a6ec3cfc-05e0-4c4c-bb2d-bd091cf0553c"
    
    } ,
    
    "AssessmentGradesetInstances" : [
    
    {
    
    "ExternalID" : "02556ddf-9132-4908-8521-0798d57f5210",
    
    "StartDate" : "2016-10-01T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "DecimalPlaces" : 0,
    
    "MinimumValue" : 0,
    
    "MaximumValue" : 0,
    
    "AssessmentGrades" : [
    
    {
    
    "ExternalID" : "2d9e77a4-5a4a-484b-9eef-8354ae2efa71",
    
    "Code" : "AS",
    
    "Description" : "Achieved Standard",
    
    "Style" : null,
    
    "Value" : 0
    
    } ,
    
    {
    
    "ExternalID" : "2b7c7ef1-881b-4dd1-a0af-4b8f9cd1006b",
    
    "Code" : "NS",
    
    "Description" : "Not Achieved Standard",
    
    "Style" : null,
    
    "Value" : 0
    
    } , ...
    
    ]
    
    }
    
    ]
    
    }
    

     

    Get lookup values for the gradeset type

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Assessment/AssessmentGradesetTypes

    {
                "IsDeleted": false, 
                "ExternalID": "6319e04b-a011-435a-a456-4c0af6401e69", 
                "Code": "A", 
                "Description": "Age", 
                "IsVisible": false, 
                "DisplayOrder": 0
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "a6ec3cfc-05e0-4c4c-bb2d-bd091cf0553c", 
                "Code": "G", 
                "Description": "Grade", 
                "IsVisible": false, 
                "DisplayOrder": 0
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "e7ac680d-8090-45cc-8802-c11cab82293b", 
                "Code": "M", 
                "Description": "Marks", 
                "IsVisible": false, 
                "DisplayOrder": 0
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "f373e4cb-6b21-41dc-9b32-972e26837935", 
                "Code": "C", 
                "Description": "Comment", 
                "IsVisible": false, 
                "DisplayOrder": 0
            }
    

    Assessment.KPI - Domain

    A KPI relates the ‘aspect’ to expected results and an assessment period. An ‘aspect’ represents the purpose and method of assessment. Groups of learners’ results will be compared to these KPIs.

    KPI threshold and target values for all KPIs, years and assessment periods - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/KPIAspects?$select=ExternalID&$expand=TargetExpectations($select=ExternalID,MaxThresholdValue,MinThresholdValue,TargetValue;$expand=MaxThresholdGrade($select=ExternalID),MinThresholdGrade($select=ExternalID))

    {
    
    "ExternalID" : "8ade605a-9ae5-4472-b54f-35217e280a02",
    
    "TargetExpectations" : [
    
    {
    
    "ExternalID" : "55f3d2e3-3663-4de5-8607-49ea958a0ee5",
    
    "MaxThresholdValue" : 0,
    
    "MinThresholdValue" : 0,
    
    "TargetValue" : 0,
    
    "MaxThresholdGrade" : {
    
    "ExternalID" : "0ef84fc2-3d3c-4312-8585-de60ec95cd7a"
    
    } ,
    
    "MinThresholdGrade" : {
    
    "ExternalID" : "ff72e488-3bc3-458b-9b26-4834bd482548"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "0f860e79-d91c-4332-9e54-a034271d92f2",
    
    "MaxThresholdValue" : 0,
    
    "MinThresholdValue" : 0,
    
    "TargetValue" : 0,
    
    "MaxThresholdGrade" : {
    
    "ExternalID" : "0ef84fc2-3d3c-4312-8585-de60ec95cd7a"
    
    } ,
    
    "MinThresholdGrade" : {
    
    "ExternalID" : "ff72e488-3bc3-458b-9b26-4834bd482548"
    
    }
    
    }, ...
    
    ]
    
    }, ...
    

    KPI threshold values for an Aspect along with the period it relates to - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Assessment/KPIAspects?$select=ExternalID&$expand=TargetExpectations($select=ExternalID,MaxThresholdValue,MinThresholdValue,TargetValue;$expand=AssessmentPeriod($select=ExternalID),SchoolYear($select=ExternalID))

    {
        "ExternalID": "8ade605a-9ae5-4472-b54f-35217e280a02", 
        "TargetExpectations": [
            {
                "ExternalID": "55f3d2e3-3663-4de5-8607-49ea958a0ee5", 
                "MaxThresholdValue": 0, 
                "MinThresholdValue": 0, 
                "TargetValue": 0, 
                "AssessmentPeriod": {
                    "ExternalID": "64549012-1d94-4a98-b72d-c2583201b5d3"
                }, 
                "SchoolYear": null
            }, 
            {
                "ExternalID": "0f860e79-d91c-4332-9e54-a034271d92f2", 
                "MaxThresholdValue": 0, 
                "MinThresholdValue": 0, 
                "TargetValue": 0, 
                "AssessmentPeriod": {
                    "ExternalID": "4b16bcde-2567-41c5-9822-7ab19e9fa455"
                }, 
                "SchoolYear": null
            }
        ]
    }
    


    Attendance – Domain Namespace

    Information from an individual attendance record perspective, rather than a learner’s perspective.

    Attendance.StatutoryAttendanceSession

    An attendance session is one example of an attendable event which represents a well-known period of time. All possible attendance sessions are stored here. There are other examples periods of time representing an attendable event; an attendable event is an abstract concept. This particular type of attendable event is statutory and represents either one of the schools sessions which must be attended or a school administration day. The attendance session can be defined by the school’s definition of a working week session such as AM, PM or a lesson. The attendance session can also be defined by the school’s particular administration days.

    All working week sessions and school administrations days - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Attendance/StatutoryAttendanceSessionAttendanceSessions?$select=ExternalID,StartDateTime,EndDateTime,IsInsetDay&$expand=WorkingWeekSession($select=ExternalID),SchoolAdministrationDay($select=ExternalID)

    {
    
    "ExternalID" : "a7449cc6-d8c0-4cd0-b022-30dee9e90a7e",
    
    "StartDateTime" : "2014-02-26T13:00:00Z",
    
    "EndDateTime" : "2014-02-26T15:30:00Z",
    
    "IsInsetDay" : false,
    
    "WorkingWeekSession" : {
    
    "ExternalID" : "1f474d18-0b66-4495-a640-3efd7029c4c6"
    
    } ,
    
    "SchoolAdministrationDay" : {
    
    "ExternalID" : "67035d07-48b9-4533-b83b-3df2e5fcac26"
    
    }
    
    }, ...
    
    

    Lookup values for the dates of the school administration days.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$select=ExternalID&$expand=Event($select=ExternalID;$expand=SchoolAdministrationDays($select=ExternalID,Date)) 

    
    
    {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "Event" : {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "SchoolAdministrationDays" : [
    
    {
    
    "ExternalID" : "56f6baa8-8548-49e2-8018-4ee9b01643cc",
    
    "Date" : "2010-10-25T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "9a3572ea-5095-4351-8156-794f22919914",
    
    "Date" : "2003-01-07T00:00:00Z"
    
    }
    
    ]
    
    }
    
    }
    

    Lookup the values for working week sessions defined by the school.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$select=ExternalID&$expand=Event($select=ExternalID;$expand=AcademicYears($select=ExternalID;$expand=WorkingWeekPatterns($select=ExternalID;$expand=WorkingWeekSession($select=ExternalID,Name,StartTime,EndTime))))

    {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "Event" : {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "AcademicYears" : [
    
    {
    
    "ExternalID" : "a1002b09-fc62-4ce7-8ff6-eef4cc42f4e3",
    
    "WorkingWeekPatterns" : [
    
    {
    
    "ExternalID" : "a2099399-a1dc-4651-81a1-5064cbd9a2b0",
    
    "WorkingWeekSession" : {
    
    "ExternalID" : "165a3ef9-85f7-4212-bad3-0dc221c67713",
    
    "Name" : "AM",
    
    "StartTime" : "0001-01-01T09:00:00Z",
    
    "EndTime" : "0001-01-01T12:30:00Z"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "8789979d-0cb6-4b19-8d88-bf1eee336c23",
    
    "WorkingWeekSession" : {
    
    "ExternalID" : "b7a195ac-3cc8-4354-bd78-b37a683ce7d0",
    
    "Name" : "PM",
    
    "StartTime" : "0001-01-01T13:00:00Z",
    
    "EndTime" : "0001-01-01T15:30:00Z"
    
    }
    
    }
    
    ]
    
    }
    
    ]
    
    }
    
    }
    


    KPI – Domain Namespace

    Details of KPI values for attendance percentage, achievement Points and behaviour points.

    KPI.Detail – Domain

    Details of KPI values for attendance percentage, achievement points and behaviour points etc. There is no relationship to learners these KPI values are only for displaying a representation the KPI itself. These KPIs exist separately from the set of KPIs which are related to aspects.
    For attendance for example:
    > School Target 96%
    > National Average 96%
    > Display Green if above or equal to 96%
    > Display Red if below 95%

    All KPI codes and descriptions, along with their target values and thresholds - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/KPI/KPIs?$select=ExternalID&$expand=Detail($select=ExternalID,Name;$expand=KPIType($select=ExternalID,Code,Description),KPITargets($select=ExternalID,Code,Name;$expand=KPITargetValues($select=ExternalID,MaxThreshold,MinThreshold,TargetValue)))

    {
    
    "ExternalID" : "fc19e20d-5f4c-45c9-b685-bb618d6ce69b",
    
    "Detail" : {
    
    "ExternalID" : "fc19e20d-5f4c-45c9-b685-bb618d6ce69b",
    
    "Name" : "Attendance",
    
    "KPIType" : {
    
    "ExternalID" : "d54a673c-11f6-434c-a592-be19efc4ca98",
    
    "Code" : "ATT",
    
    "Description" : "Attendance"
    
    } ,
    
    "KPITargets" : [
    
    {
    
    "ExternalID" : "f791b99f-ab64-4c60-8cfd-caad60349242",
    
    "Code" : "SA",
    
    "Name" : "School Attendance Target",
    
    "KPITargetValues" : [
    
    {
    
    "ExternalID" : "a8a5bd7d-8fcb-48ff-9fba-fbde71c4788a",
    
    "MaxThreshold" : 96,
    
    "MinThreshold" : 95,
    
    "TargetValue" : 95
    
    } ,
    
    {
    
    "ExternalID" : "396a6842-f387-438a-af91-27a5b45e8f6a",
    
    "MaxThreshold" : 96,
    
    "MinThreshold" : 95,
    
    "TargetValue" : 95
    
    }
    
    ]
    
    } ,
    
    {
    
    "ExternalID" : "84dfdeef-b975-4b91-a815-7cec86bbdc69",
    
    "Code" : "B",
    
    "Name" : "Benchmark",
    
    "KPITargetValues" : [
    
    {
    
    "ExternalID" : "314e9e4d-97cf-4b56-8a11-93001f7f0765",
    
    "MaxThreshold" : 0,
    
    "MinThreshold" : 0,
    
    "TargetValue" : 96
    
    } ,
    
    {
    
    "ExternalID" : "15ad0953-cea4-4a2d-a418-f8c5a145f82b",
    
    "MaxThreshold" : 0,
    
    "MinThreshold" : 0,
    
    "TargetValue" : 96
    
    }
    
    ]
    
    }
    
    ]
    
    }
    
    }, ...
    


    Learner – Rooted Domain Namespace

    A rooted information domain containing details focusing on a learner, which could be a prospective student, active student or leaver.

    Learner.Assessment – Sub Domain

    Details of assessments made for learners, providing an assessment result, period and an ‘aspect’ which is the reason why an assessment was made.

    Assessments for a specific learner - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners(855dea56-d406-47e7-900a-93fb3791d34e)?$select=ExternalID&$expand=Assessment($select=ExternalID;$expand=Results($select=ExternalID,AssessmentDate,RecordedByAuthorisedUser,RecordedOn,ReferenceDate;$expand=ReferenceAcademicYear($select=ExternalID),AssessmentPeriod($select=ExternalID)))

    Lookup assessment periods.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Assessment/FormalAssessmentPeriods

    Lookup academic years.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(fbdb47cf-b07a-4891-8615-80ceaae0eebb)?$select=ExternalID&$expand=NamedDateRange($select=ExternalID;$expand=AcademicYears($select=ExternalID,Name,StartDate,EndDate))

    Learner.Attendance – Sub Domain

    Details of each learner’s attendance records from a learner perspective.

    Learner Attendance Records - Query

    Select all attendance records for a specific learner.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners(6f84d6e7-c2af-4de5-ab73-55a643be1bac)?$expand=Attendance($select=ExternalID;$expand=AttendanceRecords($select=ExternalID,IsPresent,IsAbsent;$expand=SchoolAttendanceCode($select=ExternalID),AttendableEvent($select=ExternalID)))

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "6f84d6e7-c2af-4de5-ab73-55a643be1bac",
    
    "Attendance" : {
    
    "ExternalID" : "6f84d6e7-c2af-4de5-ab73-55a643be1bac",
    
    "AttendanceRecords" : [
    
    {
    
    "ExternalID" : "a3b4d78b-71a5-4bbe-8c6d-5bd29f47608c",
    
    "IsPresent" : true,
    
    "IsAbsent" : false,
    
    "SchoolAttendanceCode" : {
    
    "ExternalID" : "91a1969a-739d-4268-89c0-bd6a3384b031"
    
    } ,
    
    "AttendableEvent" : {
    
    "ExternalID" : "43e39aed-0afa-4bab-8c94-396a567adc4b"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "083430b7-85a8-4d81-8ec0-df18aa057358",
    
    "IsPresent" : true,
    
    "IsAbsent" : false,
    
    "SchoolAttendanceCode" : {
    
    "ExternalID" : "27163a1a-02f0-4069-a33e-f51c620bc35f"
    
    } ,
    
    "AttendableEvent" : {
    
    "ExternalID" : "87eba2a8-00a9-4ef3-8061-178cad2d1871"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "89174893-0cf8-48ba-8739-b60e917fa814",
    
    "IsPresent" : true,
    
    "IsAbsent" : false,
    
    "SchoolAttendanceCode" : {
    
    "ExternalID" : "91a1969a-739d-4268-89c0-bd6a3384b031"
    
    } ,
    
    "AttendableEvent" : {
    
    "ExternalID" : "bca6b1f5-e681-4fe0-bdbe-3f383dcae050"
    
    }
    
    }
    
    ]
    
    }
    
    }
    
     
    Lookup values for StatutoryAttendanceSessionAttendanceSessions which correspond to the AttendableEvent.
    {
        "IsDeleted": false, 
        "ExternalID": "a7449cc6-d8c0-4cd0-b022-30dee9e90a7e", 
        "StartDateTime": "2014-02-26T13:00:00Z", 
        "EndDateTime": "2014-02-26T15:30:00Z", 
        "IsInsetDay": false
    },
    {
        "IsDeleted": false, 
        "ExternalID": "8f0ad216-57ef-49fc-840e-ee5ab54839f1", 
        "StartDateTime": "2007-11-29T13:00:00Z", 
        "EndDateTime": "2007-11-29T15:30:00Z", 
        "IsInsetDay": false
    }, …
     

    Lookup values for school attendance codes.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Attendance/SchoolAttendanceCodes

    {
        "@odata.context": "http://pm-sims-primary-api-partner-dev.azurewebsites.net/Lookup/Attendance/$metadata#SchoolAttendanceCodes", 
        "value": [
            {
                "IsDeleted": false, 
                "ExternalID": "27163a1a-02f0-4069-a33e-f51c620bc35f", 
                "Code": "\\", 
                "Description": "Present (PM)", 
                "DisplayOrder": 2, 
                "IsVisible": true
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "976d282c-bcfa-46f9-a986-403c693bde53", 
                "Code": "B", 
                "Description": "Educated off site (not Dual reg.)", 
                "DisplayOrder": 3, 
                "IsVisible": true
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "e8502b05-bf6f-4f26-a8cd-9453695ac22d", 
                "Code": "L", 
                "Description": "Late (before registers closed)", 
                "DisplayOrder": 11, 
                "IsVisible": true
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "3188db41-daf7-4acb-a04b-4d4483460815", 
                "Code": "E", 
                "Description": "Excluded", 
                "DisplayOrder": 6, 
                "IsVisible": true
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "5b2758de-9a91-4c75-9076-0d1430979767", 
                "Code": "I", 
                "Description": "Illness", 
                "DisplayOrder": 9, 
                "IsVisible": true
            }, ...
     
        ]
    }
    

    Learner.Consent – Sub Domain

    Details of consents which have been provided for learners such as consent to have photographs taken or attend a school visit.

    Consent Types and Statuses - Query

    Select the consent types and statuses for all learners. These values are school-defined so may be of little practical use for general purpose processing.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$expand=Consent($select=ExternalID;$expand=LearnerConsentTypes($select=ExternalID,ConsentDate,ConsentingAdult,ConsentStatus,ConsentType,Learner))

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "db0d9dab-637e-4b78-9190-3aaa00c6e64c",
    
    "Consent" : {
    
    "ExternalID" : "db0d9dab-637e-4b78-9190-3aaa00c6e64c",
    
    "LearnerConsentTypes" : [
    
    {
    
    "ExternalID" : "90ceb844-a415-48aa-90c3-e2fda2063cde",
    
    "ConsentDate" : "0001-01-01T00:00:00Z",
    
    "ConsentingAdult" : null
    
    } ,
    
    {
    
    "ExternalID" : "cab90a8e-8514-40e9-930b-5054b845227f",
    
    "ConsentDate" : "0001-01-01T00:00:00Z",
    
    "ConsentingAdult" : null
    
    } ,
    
    {
    
    "ExternalID" : "092716f9-dd22-4f32-be00-43b9e7efeae1",
    
    "ConsentDate" : "0001-01-01T00:00:00Z",
    
    "ConsentingAdult" : null
    
    } ,
    
    {
    
    "ExternalID" : "54069c32-8914-4a3c-88b2-de01b5e62522",
    
    "ConsentDate" : "0001-01-01T00:00:00Z",
    
    "ConsentingAdult" : null
    
    } ,
    
    {
    
    "ExternalID" : "f9426c28-d54e-41c3-a34d-4fd236541863",
    
    "ConsentDate" : "0001-01-01T00:00:00Z",
    
    "ConsentingAdult" : null
    
    } ,
    
    {
    
    "ExternalID" : "055e2429-7407-4d0b-a186-bafdd62d6c0b",
    
    "ConsentDate" : "0001-01-01T00:00:00Z",
    
    "ConsentingAdult" : null
    
    }
    
    ]
    
    }
    
    }

    Lookup values for consent statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/ConsentStatus

    {
        "value": [
            {
                "IsDeleted": false, 
                "ExternalID": "a4485bb9-5983-45f3-ab3c-bcb92a1e79f8", 
                "Code": "RE", 
                "Description": "Received", 
                "DisplayOrder": 1, 
                "IsVisible": true, 
                "IsDefault": false
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "9de61e39-152f-43fb-9e75-c69a5f5eb93b", 
                "Code": "RF", 
                "Description": "Refused", 
                "DisplayOrder": 2, 
                "IsVisible": true, 
                "IsDefault": false
            }
        ]
    }
    
    Lookup values for consent types.
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "0fcda26b-def6-4926-9ac6-678e2144d46e",
    
    "Code" : "P",
    
    "Description" : "Photograph Student",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true
    
    },
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "ffa8e24e-bd86-49f3-81c9-23fb6a48d36c",
    
    "Code" : "I",
    
    "Description" : "Internet Access",
    
    "DisplayOrder" : 2,
    
    "IsVisible" : true
    
    },
    
    {
    "IsDeleted" : false,
    
    "ExternalID" : "d45d1e3f-dbdf-403a-afca-3ed649588719",
    
    "Code" : "V",
    
    "Description" : "School Visit",
    
    "DisplayOrder" : 6,
    
    "IsVisible" : true
    
    }

    Learner.ContactDetails – Sub Domain

    Information relating to contacting learners and any related contacts such as carers. Includes email addresses, phone numbers, physical addresses for the learners and their related contacts.

     

    All Addresses for all Learners - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=ContactDetails($select=ExternalID;$expand=LearnerAddresses($select=ExternalID,StartDate,EndDate;$expand=Address($select=ExternalID,PAONDescription,PAONRange,SAON, Street,Town,PostCode)))

    {
    
    "ExternalID" : "407a6dcb-4a82-451c-8304-ddd0635b2a89",
    
    "ContactDetails" : {
    
    "ExternalID" : "407a6dcb-4a82-451c-8304-ddd0635b2a89",
    
    "LearnerAddresses" : [
    
    {
    
    "ExternalID" : "7a5e65c4-dc35-43f3-b0f4-5ff6d720a46c",
    
    "StartDate" : "2003-09-01T00:00:00Z",
    
    "EndDate" : "2004-03-25T00:00:00Z",
    
    "Address" : {
    
    "ExternalID" : "96fdbcaf-622f-47b7-ab38-59e4539ea877",
    
    "PAONDescription" : null,
    
    "PAONRange" : "54",
    
    "SAON" : null,
    
    "Street" : "Harlescott Lane",
    
    "Town" : "East Town",
    
    "PostCode" : "SI1 3AP"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "e8faae2f-f4a7-464b-8c38-44c661d40751",
    
    "StartDate" : "2004-03-26T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "Address" : {
    
    "ExternalID" : "82e06df5-c1e1-4aa2-a82f-f8c3610517ed",
    
    "PAONDescription" : null,
    
    "PAONRange" : "54",
    
    "SAON" : null,
    
    "Street" : "Harlestone Court",
    
    "Town" : "Milton Keynes",
    
    "PostCode" : "MK14 5PD"
    
    }
    
    }
    
    ]
    
    }
    
    } ,
    

    Telephone Numbers and Email Addresses for all Learners - Query

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

    {
        "ExternalID": "ed12e303-fdaa-4036-9379-f18a03b242c4", 
        "ContactDetails": {
            "ExternalID": "ed12e303-fdaa-4036-9379-f18a03b242c4", 
            "LearnerEmails": [
                {
                    "ExternalID": "8960e2c4-7915-419d-be2a-b66d98ecb06c", 
                    "EmailAddress": "Hussain@wes.net", 
                    "UseForTextMessages": false
                }, 
                {
                    "ExternalID": "1840763d-2f08-412b-8e23-4a97d5676bb8", 
                    "EmailAddress": "Hussain@example.com", 
                    "UseForTextMessages": false
                }
            ], 
            "LearnerTelephones": [
                {
                    "ExternalID": "2874694a-f2cf-446c-857c-dd6c92f669fa", 
                    "TelephoneNumber": "01632 451020", 
                    "IsMainTelephone": false, 
                    "UseForTextMessages": false
                }, 
                {
                    "ExternalID": "d49cb362-8ed7-49f0-b181-5b4a7fae2ba3", 
                    "TelephoneNumber": "07333 812091", 
                    "IsMainTelephone": true, 
                    "UseForTextMessages": true
                }
            ]
        }
    }
    

    Learner Contact Names - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=ContactDetails($select=ExternalID;$expand=LearnerContactRelationships($select=ExternalID,HasParentalResponsibility;$expand=LearnerContact($select=Forename,MiddleName,Surname),LearnerContactRelationshipType($select=ExternalID)))

    {
    
    "ExternalID" : "a2c55667-f98b-4fa1-bd8d-15c20e8aba9b",
    
    "Personal" : {
    
    "ExternalID" : "a2c55667-f98b-4fa1-bd8d-15c20e8aba9b",
    
    "PreferredForename" : "Grish",
    
    "PreferredSurname" : "Przybylak"
    
    } ,
    
    "ContactDetails" : {
    
    "ExternalID" : "a2c55667-f98b-4fa1-bd8d-15c20e8aba9b",
    
    "LearnerContactRelationships" : [
    
    {
    
    "ExternalID" : "576835d9-ef4f-4de0-87ed-78cebc10a692",
    
    "HasParentalResponsibility" : true,
    
    "LearnerContact" : {
    
    "Forename" : "Yvonna",
    
    "MiddleName" : null,
    
    "Surname" : "Przybylak"
    
    } ,
    
    "LearnerContactRelationshipType" : {
    
    "ExternalID" : "6d5cb9c5-3fa5-4749-8eb4-33a3b1166210"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "7cc1d5f5-9bdc-459c-b57e-7fb79a8cadd1",
    
    "HasParentalResponsibility" : true,
    
    "LearnerContact" : {
    
    "Forename" : "Piotr",
    
    "MiddleName" : null,
    
    "Surname" : "Przybylak"
    
    } ,
    
    "LearnerContactRelationshipType" : {
    
    "ExternalID" : "f7c0c9ea-be0f-4ad5-9793-0c6c597a9174"
    
    }
    
    }
    
    ]
    
    }
    
    }
    

    Select lookup values for learner contact relationship types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/LearnerContactRelationshipTypes?$select=ExternalID,Code,Description

    {
    
    "ExternalID" : "6d5cb9c5-3fa5-4749-8eb4-33a3b1166210",
    
    "Code" : "PAM",
    
    "Description" : "Mother"
    
    } ,
    
    {
    
    "ExternalID" : "396fff9c-6de7-4583-add7-c4c5a0a9cff3",
    
    "Code" : "CAR",
    
    "Description" : "Carer"
    
    } ,
    
    {
    
    "ExternalID" : "3f610888-52cb-455d-b988-3c2e0ff2c13f",
    
    "Code" : "FOF",
    
    "Description" : "Foster Father"
    
    } ,
    
    {
    
    "ExternalID" : "cc41a191-02e9-4818-aa27-be7dcf1c30b0",
    
    "Code" : "SWR",
    
    "Description" : "Social Worker"
    
    } ,
    
    {
    
    "ExternalID" : "ce8b8da1-e695-480e-9a6d-a60d24a1f676",
    
    "Code" : "STF",
    
    "Description" : "Step Father"
    
    } , ...
    

    Learner Contact Email Addresses and Telephone Numbers - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=ContactDetails($select=ExternalID;$expand=LearnerContactRelationships($select=ExternalID;$expand=LearnerContact($select=ExternalID,Forename,Surname;$expand=LearnerContactTelephones($select=ExternalID,TelephoneNumber),LearnerContactEmails($select=ExternalID,EmailAddress))))

    {
        "ExternalID": "31fee134-e17b-49a0-a989-f2a973a055d1", 
        "LearnerContact": {
            "ExternalID": "3c32eb0d-b6be-49ce-aa34-c2a1e37b1cc1", 
            "Forename": "Adam", 
            "Surname": "Emerston", 
            "LearnerContactTelephones": [
                {
                    "ExternalID": "15d97018-e638-4f3c-82f2-cf01e03f762b", 
                    "TelephoneNumber": "01632 665535"
                }, 
                {
                    "ExternalID": "34b317f6-a249-4aa0-b8d3-e6558b9ad8e0", 
                    "TelephoneNumber": "01632 665123"
                }
            ], 
            "LearnerContactEmails": [
                {
                    "ExternalID": "e0bf1eff-ab87-4147-831c-4580881f2354", 
                    "EmailAddress": "Emerston@example.com"
                }
            ]
        }
    }
    

    Learner Contact Addresses - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=ContactDetails($select=ExternalID;$expand=LearnerContactRelationships($select=ExternalID;$expand=LearnerContact($select=ExternalID,Forename,Surname;$expand=LearnerContactAddresses($select=ExternalID,StartDate,EndDate;$expand=Address($select=ExternalID,PAONDescription,PAONRange,SAON,Street,Town,PostCode)))))

    {
        "ExternalID": "2089f7ec-1bd3-43e1-b7f6-df60f614e229", 
        "ContactDetails": {
            "ExternalID": "2089f7ec-1bd3-43e1-b7f6-df60f614e229", 
            "LearnerContactRelationships": [
                {
                    "ExternalID": "dea67711-a28c-47ad-803e-06015c34fd7b", 
                    "LearnerContact": {
                        "ExternalID": "382158d1-fa97-4c01-9847-43bd5bc4d2d4", 
                        "Forename": "John", 
                        "Surname": "Davies", 
                        "LearnerContactAddresses": [
                            {
                                "ExternalID": "75d8ff70-72aa-4919-8ad8-132f7c0b41c3", 
                                "StartDate": "2010-02-10T00:00:00Z", 
                                "EndDate": "0001-01-01T00:00:00Z", 
                                "Address": {
                                    "ExternalID": "dc3d2abf-e004-433c-aa5d-f20d82117976", 
                                    "PAONDescription": "Stratford Arcade", 
                                    "PAONRange": "75", 
                                    "SAON": null, 
                                    "Street": "High Street", 
                                    "Town": "Milton Keynes", 
                                    "PostCode": "MK11 1AY"
                                }
                            }
                        ]
                    }
                }, 
                {
                    "ExternalID": "099dd441-6fe5-4f21-844c-4bc236dbc103", 
                    "LearnerContact": {
                        "ExternalID": "d53d01fa-9447-4f97-98ec-f0ec84a9f8b6", 
                        "Forename": "Sylvia", 
                        "Surname": "Harris", 
                        "LearnerContactAddresses": [
                            {
                                "ExternalID": "089d6ab2-b1ec-4f1e-b8e7-8ac6ca7d8ac9", 
                                "StartDate": "2010-02-10T00:00:00Z", 
                                "EndDate": "0001-01-01T00:00:00Z", 
                                "Address": {
                                    "ExternalID": "92965d2f-779b-4631-b164-d9f30ed7587b", 
                                    "PAONDescription": "Stratford Arcade", 
                                    "PAONRange": "75", 
                                    "SAON": null, 
                                    "Street": "High Street", 
                                    "Town": "Milton Keynes", 
                                    "PostCode": "MK11 1AY"
                                }
                            }
                        ]
                    }
                }
            ]
        }
    }

    Learner.Cultural – Sub Domain

    Contains details of language, religion, nationality and other cultural details.

    Learner Languages - Query

    Select the details of each learner’s set of languages and use.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Cultural($select=ExternalID;$expand=LearnerLanguageDetails($select=ExternalID,LanguageSource;$expand=Language($select=ExternalID),LanguageUse($select=ExternalID)),Language($select=ExternalID))

    Lookup values for languages.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/Languages

    {
            "ExternalID": "9e980af6-6a59-49c7-a448-49b7902f8604", 
            "Code": "CYM", 
            "Description": "Welsh/Cymraeg"
        }, 
        {
            "ExternalID": "2f5322f0-542b-4635-b55f-9137ccdddd0a", 
            "Code": "CZE", 
            "Description": "Czech"
        }, 
        {
            "ExternalID": "28e3c5ef-9dfd-449c-9468-3492d4f23dec", 
            "Code": "DAN", 
            "Description": "Danish"
        }

    Lookup values for language use.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/LanguageUses?$select=ExternalID,Code,Description

    {
                "ExternalID": "227ed922-475a-4974-b0cc-8c1ee45b8517", 
                "Code": "F", 
                "Description": "First Language"
            }, 
            {
                "ExternalID": "9a1e7bba-cc5b-4895-b99d-dce8499e1554", 
                "Code": "M", 
                "Description": "Multiple First Language"
            }, 
            {
                "ExternalID": "5d188af5-3758-4020-a5e6-cbe72ae161ff", 
                "Code": "H", 
                "Description": "Home"
            }, ...
     

    Lookup values for language sources.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/LanguageSources

    {
            "IsDeleted": false, 
            "ExternalID": "cf41f02b-dcbb-4896-b8e5-871ee87b93fa", 
            "Code": "C", 
            "Description": "Provided by the child (i.e. pupil)", 
            "DisplayOrder": 1, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "a423371d-6f14-4c30-a6b9-047d16ce2481", 
            "Code": "P", 
            "Description": "Provided by the parent", 
            "DisplayOrder": 2, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "61681e07-5193-4481-85a7-cb2360e60603", 
            "Code": "S", 
            "Description": "Ascribed by the current school", 
            "DisplayOrder": 3, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "5ff736f3-8139-4e6f-b37e-1921e6825eba", 
            "Code": "T", 
            "Description": "Ascribed by the previous school", 
            "DisplayOrder": 4, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "91f4dbb2-05cd-4332-ae6a-bc90a2b85580", 
            "Code": "O", 
            "Description": "Other", 
            "DisplayOrder": 5, 
            "IsVisible": true
        }
    

    Learner Nationality and Country of Birth - Query

    Select details of each learner’s nationality and country of birth.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Cultural($select=ExternalID;$expand=LearnerNationalities($select=ExternalID;$expand=Nationality($select=ExternalID)),CountryOfBirth($select=ExternalID))

    Learner.Dietary – Sub Domain

    Information relating to a learner’s dietary requirements such as those relating to allergies and religious beliefs.

    Learner Eligibility for Free Milk or Meals - Query

    Select details of each learners’ eligibility for free meals or free school milk.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Dietary($select=ExternalID;$expand=FreeMealEligibilities($select=ExternalID,ReviewDate,StartDate,EndDate),LearnerFreeSchoolMilk($select=ExternalID,StartDate,EndDate))

    {
            "ExternalID": "8571e902-16bd-45a7-9790-56d48465951a", 
            "Dietary": {
                "ExternalID": "8571e902-16bd-45a7-9790-56d48465951a", 
                "FreeMealEligibilities": [
                    {
                        "ExternalID": "824a5a14-d3c5-4f7c-bf96-9a21b448463c", 
                        "ReviewDate": "0001-01-01T00:00:00Z", 
                        "StartDate": "2017-09-01T00:00:00Z", 
                        "EndDate": "0001-01-01T00:00:00Z"
                    }
                ], 
                "LearnerFreeSchoolMilk": [ ]
            }
        }, 
        {
            "ExternalID": "079af159-8d91-4af7-b502-62d89c00aa4e", 
            "Dietary": {
                "ExternalID": "079af159-8d91-4af7-b502-62d89c00aa4e", 
                "FreeMealEligibilities": [
                    {
                        "ExternalID": "6bc2d57a-c49d-4786-869d-bbee728cc9ca", 
                        "ReviewDate": "2010-07-23T00:00:00Z", 
                        "StartDate": "2008-10-01T00:00:00Z", 
                        "EndDate": "2010-07-23T00:00:00Z"
                    }
                ], 
                "LearnerFreeSchoolMilk": [ ]
            }
        }
     

    Learner Dietary Needs - Query

    The dietary needs of a learner relating to allergies or religious beliefs.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Dietary($select=ExternalID;$expand=LearnerDietaryNeeds($select=ExternalID;$expand=DietaryNeed($select=ExternalID))) {

    
    "ExternalID" : "65237838-0e59-43fc-9421-1821a89aba6e",
    
    "Dietary" : {
    
    "ExternalID" : "65237838-0e59-43fc-9421-1821a89aba6e",
    
    "LearnerDietaryNeeds" : [
    
    {
    
    "ExternalID" : "6042001a-1312-4ef8-a926-1a8a3a19ec58",
    
    "DietaryNeed" : {
    
    "ExternalID" : "3676f88f-c5eb-4bf7-b233-b7c9c8b32b35"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "b27badb3-3e6d-4d51-91fd-c642608b7b6e",
    
    "DietaryNeed" : {
    
    "ExternalID" : "46c03c3e-b75d-40a6-93b3-d5c554e0b10f"
    
    }
    
    }
    
    ]
    
    }
    
    }
    

    Lookup values for dietary needs.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/General/DietaryNeeds

    {
            "IsDeleted": false, 
            "ExternalID": "3676f88f-c5eb-4bf7-b233-b7c9c8b32b35", 
            "Code": "NUTS", 
            "Description": "No nuts of any type/quantity", 
            "DisplayOrder": 5, 
            "IsActive": true, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "56b3887c-b6ef-4c0a-a7b0-605f48f4931b", 
            "Code": "KOSH", 
            "Description": "Kosher foods only", 
            "DisplayOrder": 4, 
            "IsActive": true, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "46c03c3e-b75d-40a6-93b3-d5c554e0b10f", 
            "Code": "VEGA", 
            "Description": "Vegetarian", 
            "DisplayOrder": 9, 
            "IsActive": true, 
            "IsVisible": true
        }, ...

    Learner Meal Patterns - Query

    Select details of each learner’s meal patterns.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Dietary($select=ExternalID;$expand=LearnerMealPatterns($select=ExternalID,StartDate,EndDate,MondayMealType,TuesdayMealType,WednesdayMealType,ThursdayMealType,FridayMealType))

    {
        "ExternalID": "8d7cde74-7680-486a-bffd-014fd6fcd012", 
        "Dietary": {
            "ExternalID": "8d7cde74-7680-486a-bffd-014fd6fcd012", 
            "LearnerMealPatterns": [
                {
                    "ExternalID": "aa3f031e-6713-44cd-8d5f-e6c020cf62de", 
                    "StartDate": "2007-09-03T00:00:00Z", 
                    "EndDate": "0001-01-01T00:00:00Z"
                }, 
                {
                    "ExternalID": "092bd6b8-8aca-4f40-b272-a55fd5d5f578", 
                    "StartDate": "2004-09-01T00:00:00Z", 
                    "EndDate": "2007-09-02T00:00:00Z"
                }
            ]
        }
    }, ...
    
     

    Lookup values for meal types

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/General/MealTypes

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "587b9f34-7b0f-4b81-b501-85be6692ea64",
    
    "Code" : "PL",
    
    "Description" : "Packed Lunch",
    
    "DisplayOrder" : 5,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "b5acaae6-2648-44bf-903e-e66238086658",
    
    "Code" : "HO",
    
    "Description" : "Home",
    
    "DisplayOrder" : 6,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "967c9790-15d1-4805-928b-448b45458ab3",
    
    "Code" : "CM",
    
    "Description" : "Cold School Meal",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : false
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "621d4aa1-a336-4055-97c8-dd5318a507e7",
    
    "Code" : "HM",
    
    "Description" : "Hot School Meal",
    
    "DisplayOrder" : 2,
    
    "IsVisible" : false
    
    }, ...
    

    Learner.Exclusion – Sub Domain

    Details of exclusions for learners.

    Learner Exclusion Status - Query

    Details of all exclusion statuses for all learners and their exclusion reasons.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Exclusion($select=ExternalID;$expand=LearnerExclusions($select=ExternalID,StartDate,StartTime,EndDate,EndTime,NumberOfSchoolDays,SessionsMissed;$expand=LearnerExclusionStatuses($select=ExternalID,ChangeDate;$expand=ExclusionStatus($select=ExternalID)),ExclusionReason($select=ExternalID)))

    Lookup values for exclusion statuses

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/ExclusionStatus

    Lookup values for exclusion reasons.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/ExclusionReasons

    Learner Exclusion Meetings and Notes

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Exclusion($select=ExternalID;$expand=LearnerExclusions($select=ExternalID,StartDate,StartTime,EndDate,EndTime,NumberOfSchoolDays,SessionsMissed;$expand=ExclusionMeetings($select=ExternalID,StartDate,StartTime,EndDate,EndTime,ExclusionMeetingNotes;$expand=ExclusionMeetingType($select=ExternalID)),ExclusionNotes($select=ExternalID,CreatedBy,CreatedOn,Note,Summary)))

    Learner.Medical – Sub Domain

    Details of medical conditions for learners and contact details for doctors and practices.

    Learner Medical Conditions - Query

    Select details of each learner’s medical conditions and notes.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID,Medical&$expand=Medical($select=ExternalID,LearnerMedicalNotes;$expand=LearnerMedicalConditions($select=ExternalID,MedicalCondition),LearnerMedicalNotes($select=ExternalID,Confidential,Note))

    {
    
    "ExternalID" : "a2c55667-f98b-4fa1-bd8d-15c20e8aba9b",
    
    "Medical" : {
    
    "LearnerMedicalConditions" : [
    
    {
    
    "ExternalID" : "5df49337-8a4d-4cda-a699-84c729e31011"
    
    } ,
    
    {
    
    "ExternalID" : "7d6aaace-1812-469d-a7b0-9ebdad459515"
    
    }
    
    ] ,
    
    "LearnerMedicalNotes" : [
    
    {
    
    "ExternalID" : "566672c6-bbcb-4893-bbf7-e3ddd7c46db4",
    
    "Confidential" : false,
    
    "Note" : null
    
    } ,
    
    {
    
    "ExternalID" : "5c200c21-74d6-40cb-b4ac-f26e7b19cc2b",
    
    "Confidential" : false,
    
    "Note" : null
    
    } ,
    
    {
    
    "ExternalID" : "1a5c2a5f-6a04-48ef-89bc-6eb01e4f0a17",
    
    "Confidential" : false,
    
    "Note" : "Telephone call followed by letter to advise Grish has flu."
    
    } ,
    
    {
    
    "ExternalID" : "bedc2467-7c0f-4182-8ca7-1fe3038a9987",
    
    "Confidential" : false,
    
    "Note" : "Dentist appointment at 3.15pm today. Parent picking up at 3.00pm."
    
    }
    
    ]
    
    }
    
    }
    

    Learner Medical Contact Details - Query

    Select details of each learner’s doctor and contact details for the doctor and medical practice. (Needs $expand to be more than 4 levels deep)

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Medical($select=ExternalID,NHSNumber;$expand=LearnerMedicalPractices($expand=Doctor($select=ExternalID,Forename,Surname),MedicalPractice($select=ExternalID,Name;$expand=MedicalPracticeTelephones($select=ExternalID,IsFirstPointOfContact,LocationType,TelephoneNumber,UseForTextMessages),MedicalPracticeContacts($select=ExternalID,Title,Forename,Surname,Role;$expand=MedicalPracticeContactTelephones($select=ExternalID,TelephoneNumber,IsFirstPointOfContact,UseForTextMessages)))))

    {
        "ExternalID": "a2c55667-f98b-4fa1-bd8d-15c20e8aba9b", 
        "Medical": {
            "LearnerMedicalConditions": [
                {
                    "ExternalID": "5df49337-8a4d-4cda-a699-84c729e31011"
                }, 
                {
                    "ExternalID": "7d6aaace-1812-469d-a7b0-9ebdad459515"
                }
            ], 
            "LearnerMedicalNotes": [
                {
                    "ExternalID": "566672c6-bbcb-4893-bbf7-e3ddd7c46db4", 
                    "Confidential": false, 
                    "Note": null
                }, 
                {
                    "ExternalID": "5c200c21-74d6-40cb-b4ac-f26e7b19cc2b", 
                    "Confidential": false, 
                    "Note": null
                }, 
                {
                    "ExternalID": "1a5c2a5f-6a04-48ef-89bc-6eb01e4f0a17", 
                    "Confidential": false, 
                    "Note": "Telephone call followed by letter to advise Grish has flu."
                }, 
                {
                    "ExternalID": "bedc2467-7c0f-4182-8ca7-1fe3038a9987", 
                    "Confidential": false, 
                    "Note": "Dentist appointment at 3.15pm today.  Parent picking up at 3.00pm."
                }
            ]
        }
    },
    {
    "ExternalID" : "8eb0a37d-6430-4bbc-82fc-a974cbe967e5",
    
    "Medical" : {
    
    "LearnerMedicalConditions" : [ ],
    
    "LearnerMedicalNotes" : [
    
    {
    
    "ExternalID" : "29c13888-23f3-4ba8-a69c-67d7fc66dcf4",
    
    "Confidential" : false,
    
    "Note" : "First aid given."
    
    }
    
    ]
    
    }
    
    }, ...

     

    Medical conditions lookup.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/MedicalConditions

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "8671009a-601e-45f7-a262-96bf0a9cad1a",
    
    "Code" : "ECZ",
    
    "Description" : "Eczema",
    
    "DisplayOrder" : 5,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "e7f25114-48e9-4974-9cf9-bcd6cec169cc",
    
    "Code" : "DIA",
    
    "Description" : "Diabetes",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "eb2d4df1-a31b-4425-812c-9a6dfa9245f9",
    
    "Code" : "EPL",
    
    "Description" : "Epilepsy",
    
    "DisplayOrder" : 1,
    
    "IsVisible" : true
    
    } , ...
    

    Learner.Personal – Sub Domain

    Key details for a learner such as names, date of birth

    Learner Browse - Query

    Select personal details relating for learners such as their forename, surname and date of birth and gender.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Personal($select=PreferredForename,PreferredSurname,DateOfBirth;$expand=Gender($select=ExternalID))

    {
                "ExternalID": "cf2e64b5-0165-4360-83e3-199afb09b0d2", 
                "Personal": {
                    "PreferredForename": "Amber", 
                    "PreferredSurname": "Murray", 
                    "DateOfBirth": "2002-05-24T00:00:00Z", 
                    "Gender": {
                        "ExternalID": "0fa1d8a9-716a-4b30-8cb3-d5413bd0b34a"
                    }
                }
            }, 
            {
                "ExternalID": "d3f1f791-ca3d-4f03-9fc6-02081b8ec620", 
                "Personal": {
                    "PreferredForename": "Babul", 
                    "PreferredSurname": "Mostafa", 
                    "DateOfBirth": "2011-05-10T00:00:00Z", 
                    "Gender": {
                        "ExternalID": "60325287-c357-4a77-a58f-072abc33afe0"
                    }
                }
            }, ...

    Lookup values for genders so they can be matched to each learner’s personal details.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/General/Genders

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "60325287-c357-4a77-a58f-072abc33afe0",
    
    "Code" : "1",
    
    "Description" : "Male",
    
    "DisplayOrder" : 2,
    
    "IsVisible" : true,
    
    "ExternalCode" : "M"
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "0fa1d8a9-716a-4b30-8cb3-d5413bd0b34a",
    
    "Code" : "2",
    
    "Description" : "Female",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true,
    
    "ExternalCode" : "F"
    
    } , ...
    

    Learner.PupilPremiumEligibility – Sub Domain

    Details for learners relating to learners eligible for pupil premium funding.

    Pupil Premiums - Query

    Select all learners and their pupil premium eligibilities.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=PupilPremiumEligibility($select=ExternalID;$expand=LearnerPupilPremiumEligibilities($select=ExternalID,StartDate,EndDate))

     

    Learner.PupilPremiumGrant – Sub Domain

    Details for learners relating to pupil premium grants.

    Learner Pupil Premium Grants - Query

    Details of all learners and any pupil premium grants associated with them.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=PupilPremiumGrant($select=ExternalID;$expand=LearnerPupilPremiumGrants($select=ExternalID,Amount,FullTimeEquivalent,AdoptedFromCare,DeprivationPupil,EarlyYears,LookedAfter,ServicePupil,StartDate,EndDate))

    {
        "ExternalID": "b92c5ee5-79e3-44db-976e-7ab71bb17dc3", 
        "PupilPremiumGrant": {
            "ExternalID": "b92c5ee5-79e3-44db-976e-7ab71bb17dc3", 
            "LearnerPupilPremiumGrants": [
                {
                    "ExternalID": "9f2b7f49-65d0-4418-ab3a-38cce3a168d1", 
                    "Amount": 0, 
                    "FullTimeEquivalent": false, 
                    "AdoptedFromCare": false, 
                    "DeprivationPupil": false, 
                    "EarlyYears": false, 
                    "LookedAfter": false, 
                    "ServicePupil": false, 
                    "StartDate": "2014-04-01T00:00:00Z", 
                    "EndDate": "2015-03-31T00:00:00Z"
                }, 
                {
                    "ExternalID": "1707e2e5-8989-40e7-ba36-01c0a16352a4", 
                    "Amount": 0, 
                    "FullTimeEquivalent": false, 
                    "AdoptedFromCare": false, 
                    "DeprivationPupil": false, 
                    "EarlyYears": false, 
                    "LookedAfter": false, 
                    "ServicePupil": false, 
                    "StartDate": "2015-04-01T00:00:00Z", 
                    "EndDate": "2016-03-31T00:00:00Z"
                }
            ]
        }
    }

    Learner.Registration – Sub Domain

    Information relating to learners being enrolled with the school along with their Primary Class membership, year group membership and the National Curriculum Year level they are taught at. Also includes details of the school intake each learner is associated with and if they are boarding.

    Year Group Membership - Query

    All learners and all of the year groups they have ever been a member of.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Registration($select=ExternalID;$expand=LearnerYearGroupMemberships($select=ExternalID,StartDate,EndDate;$expand=YearGroup($select=ExternalID)))

    {
                "ExternalID": "85623a42-c8b0-4525-86d3-cfc1003791f8", 
                "Registration": {
                    "ExternalID": "85623a42-c8b0-4525-86d3-cfc1003791f8", 
                    "LearnerYearGroupMemberships": [
                        {
                            "ExternalID": "351462bd-41d9-450d-b10e-0417caeacfc8", 
                            "StartDate": "2012-09-01T00:00:00Z", 
                            "EndDate": "2013-08-31T00:00:00Z", 
                            "YearGroup": {
                                "ExternalID": "0a85a667-7cac-4302-a3d7-fa06329bae64"
                            }
                        }, 
                        {
                            "ExternalID": "862d4596-2607-4cc2-918e-2be95b0b6be3", 
                            "StartDate": "2015-09-01T00:00:00Z", 
                            "EndDate": "2016-08-31T00:00:00Z", 
                            "YearGroup": {
                                "ExternalID": "19afb758-d965-4ae2-bbad-f6d46181f52c"
                            }
                        }, 
                        {
                            "ExternalID": "8eb82746-e9d9-497e-8b66-a77491cc1b75", 
                            "StartDate": "2013-09-01T00:00:00Z", 
                            "EndDate": "2014-08-31T00:00:00Z", 
                            "YearGroup": {
                                "ExternalID": "83acc144-0681-4ab6-8188-f393c7510da8"
                            }
                        }, 
                        {
                            "ExternalID": "7d543597-e723-45b2-add4-05533686f189", 
                            "StartDate": "2016-09-01T00:00:00Z", 
                            "EndDate": "2017-08-31T00:00:00Z", 
                            "YearGroup": {
                                "ExternalID": "3a5f1a26-8c42-4a70-918c-be4ad4642e1a"
                            }
                        }, 
                        {
                            "ExternalID": "9cf7823a-f67b-40c4-aa7c-6300c221e954", 
                            "StartDate": "2014-09-01T00:00:00Z", 
                            "EndDate": "2015-08-31T00:00:00Z", 
                            "YearGroup": {
                                "ExternalID": "9012d8d3-4a2f-4436-804d-2d8449bd36ff"
                            }
                        }
                    ]
                }
            }, ...
     

    Get lookup values for year groups.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$expand=Group($expand=YearGroups($select=FullName)),Details($select=ExternalID,IsRegistered)&$filter=Details/IsRegistered eq true
    
    {
                "IsDeleted": false, 
                "ExternalID": "f2e1813a-b266-42f2-b786-43e1a5bc3da1", 
                "Group": {
                    "IsDeleted": false, 
                    "ExternalID": "f2e1813a-b266-42f2-b786-43e1a5bc3da1", 
                    "YearGroups": [
                        {
                            "FullName": "Year  1"
                        }, 
                        {
                            "FullName": "Year  2"
                        }, 
                        {
                            "FullName": "Year  6"
                        }, 
                        {
                            "FullName": "Year N1"
                        }, 
                        {
                            "FullName": "Year  5"
                        }, 
                        {
                            "FullName": "Year  R"
                        }, 
                        {
                            "FullName": "Year  N2"
                        }, 
                        {
                            "FullName": "Year  4"
                        }, 
                        {
                            "FullName": "Year  3"
                        }
                    ]
                }, 
                "Details": {
                    "ExternalID": "f2e1813a-b266-42f2-b786-43e1a5bc3da1", 
                    "IsRegistered": true
                }
            }
    

    Learner Enrolments - Query

    All learners with details of their enrolments and the multiple statuses for each enrolment.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Registration($select=ExternalID;$expand=LearnerEnrolments($select=ExternalID,DateOfAdmission,DateOfLeaving;$expand=MultipleLearnerEnrolmentStatus($select=ExternalID,StartDate,EndDate;$expand=EnrolmentStatus($select=ExternalID))))

    Select the lookup values for the enrolment statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/EnrolmentStatus

    {
                "IsDeleted": false, 
                "ExternalID": "8ffc6a67-a318-4674-a66b-0250be4b7dab", 
                "Code": "C", 
                "Description": "Single Registration", 
                "DisplayOrder": 1, 
                "IsVisible": true, 
                "IsGuest": false
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "e312a53c-a736-43e8-bf16-7c5366c3d241", 
                "Code": "G", 
                "Description": "Guest Pupil", 
                "DisplayOrder": 2, 
                "IsVisible": true, 
                "IsGuest": true
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "ceb4e080-991a-4569-81bf-45b2e2a976a0", 
                "Code": "M", 
                "Description": "Main – Dual Registration", 
                "DisplayOrder": 3, 
                "IsVisible": true, 
                "IsGuest": false
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "e4817aa2-611a-4065-80e2-c090ee313cbc", 
                "Code": "S", 
                "Description": "Subsidiary – Dual Registration", 
                "DisplayOrder": 4, 
                "IsVisible": true, 
                "IsGuest": false
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "e131e233-f403-4e0a-95a2-5eace2326a34", 
                "Code": "F", 
                "Description": "Proposed Pupil", 
                "DisplayOrder": 5, 
                "IsVisible": false, 
                "IsGuest": false
            }

     

    Learner National Curriculum Year Groups - Query

    All learners along with details of all the National Curriculum year groups and primary classes they have ever been taught in.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=Registration($select=ExternalID,UniquePupilNumber;$expand=LearnerNCYearMemberships($select=ExternalID,StartDate,EndDate;$expand=SchoolNCYear($select=ExternalID,IsDeleted)),LearnerPrimaryClassMemberships($select=ExternalID,StartDate,EndDate;$expand=PrimaryClass($select=ExternalID)))
    {
    
    "ExternalID" : "6ce195d6-3298-433f-9e28-b5c6e028b820",
    
    "Registration" : {
    
    "LearnerNCYearMemberships" : [
    
    {
    
    "ExternalID" : "fe964473-f9e1-4186-bc0d-98a1aff18baf",
    
    "StartDate" : "2015-02-11T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "SchoolNCYear" : {
    
    "ExternalID" : "1d25863e-7adf-4fc6-a8bb-8f59ec08ef94",
    
    "IsDeleted" : false
    
    }
    
    }
    
    ] ,
    
    "LearnerPrimaryClassMemberships" : [
    
    {
    
    "ExternalID" : "c217236a-ef6a-49d9-b3e7-7e3128b2f2bb",
    
    "StartDate" : "2015-02-11T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "PrimaryClass" : {
    
    "ExternalID" : "a329a3fc-0275-43fc-89c1-e806fbbc99a0"
    
    }
    
    }
    
    ]
    
    }
    
    } , ...
    

    Get lookup values for the association between a SchoolNCYear and the NCYear lookup

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$expand=Group($select=ExternalID;$expand=SchoolNCYears($select=ExternalID;$expand=NCYear($select=ExternalID)))

    {
    {
    
    "ExternalID" : "1d25863e-7adf-4fc6-a8bb-8f59ec08ef94",
    
    "NCYear" : {
    
    "ExternalID" : "83f2e268-be6f-45da-85f6-af8e45e90bbe"
    
    }
    
    } , ...

    Get lookup values for NCYear lookup values.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/School/NCYears

    {
          "IsDeleted": false, 
          "ExternalID": "83f2e268-be6f-45da-85f6-af8e45e90bbe", 
          "ShortName": "1", 
          "FullName": "Curriculum Year 1", 
          "DisplayOrder": 6, 
          "IsVisible": false
        }, ...
    
    Get lookup values for primary classes

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$select=ExternalID&$expand=Group($select=ExternalID;$expand=PrimaryClasses($select=ExternalID,FullName))

     
    
    {
                "ExternalID": "a329a3fc-0275-43fc-89c1-e806fbbc99a0", 
                "FullName": "PM"
              }, ...
    

    Learner.SchoolHistory – Sub Domain

    Details of the previous schools a learner has attended along with their attendance details.

    Learner’s Previous Schools and Attendance - Query

    Select the previous schools each learner has attended along with their attendance details.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$expand=SchoolHistory($select=ExternalID;$expand=LearnerPreviousSchools($select=ExternalID,StartDate,EndDate,ReasonForLeaving;$expand=EducationEstablishment($select=ExternalID);$expand=LearnerPreviousSchoolAttendanceSummary($select=ExternalID,AttendedSessions,PossibleSessions,AuthorisedSessions,UnauthorisedSessions,Year)))

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "e3d52a5c-b580-4622-b073-e1c461a4c9bc",
    
    "SchoolHistory" : {
    
    "ExternalID" : "e3d52a5c-b580-4622-b073-e1c461a4c9bc",
    
    "LearnerPreviousSchools" : [
    
    {
    
    "ExternalID" : "f044a915-1424-4503-9dd9-a9cc63497667",
    
    "StartDate" : "2003-09-08T00:00:00Z",
    
    "EndDate" : "2005-07-22T00:00:00Z",
    
    "LearnerPreviousSchoolAttendanceSummary" : [ ]
    
    }
    
    ]
    
    }
    
    }
    
    
    
     

    Learner.SEN – Sub Domain

    Details of each learner’s Special Educational Needs statements and reviews.

    Learner Special Educational Needs - Query

    Details of each learner’s Special Educational Needs statements and reviews.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=SEN($select=ExternalID;$expand=SENStatement($select=ExternalID,AssessmentStatus,DateAssessmentRequested,DateParentConsulted,DateStatementCeased,DateStatementFinalised,SubjectToAppeal),LearnerSENReviews($select=ExternalID,LearnerConsultationDate,SENReviewStatus,StartDate,StartTime)) Lookup

    {
    
    "ExternalID" : "2b6951d5-6729-4701-bc47-719907302000",
    
    "SEN" : {
    
    "ExternalID" : "2b6951d5-6729-4701-bc47-719907302000",
    
    "SENStatement" : [
    
    {
    
    "ExternalID" : "7729cfed-027e-4ee9-95b7-6de7be3c8aa7",
    
    "DateAssessmentRequested" : "2008-06-03T00:00:00Z",
    
    "DateParentConsulted" : "2008-06-02T00:00:00Z",
    
    "DateStatementCeased" : "0001-01-01T00:00:00Z",
    
    "DateStatementFinalised" : "2008-07-08T00:00:00Z",
    
    "SubjectToAppeal" : false
    
    }
    
    ] ,
    
    "LearnerSENReviews" : [
    
    {
    
    "ExternalID" : "2b4e4e03-c9dd-44dc-8943-466c0fe94ea6",
    
    "LearnerConsultationDate" : "2010-04-19T00:00:00Z",
    
    "StartDate" : "2010-04-21T00:00:00Z",
    
    "StartTime" : "0001-01-01T09:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "30fc2b77-1502-4ac3-98e8-cd9fef2be046",
    
    "LearnerConsultationDate" : "2010-02-01T00:00:00Z",
    
    "StartDate" : "2010-02-01T00:00:00Z",
    
    "StartTime" : "0001-01-01T10:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "f8f6bf61-46a9-404f-a22a-2cc333ea0350",
    
    "LearnerConsultationDate" : "2010-09-16T00:00:00Z",
    
    "StartDate" : "2010-09-16T00:00:00Z",
    
    "StartTime" : "0001-01-01T14:00:00Z"
    
    }
    
    ]
    
    }
    
    }
    

    values for assessment statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/SEN/SENStatutoryAssessments Lookup

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "414c3012-6e33-4a14-8cf7-16dcf378bc5e",
    
    "Code" : "NOREP",
    
    "Description" : "No Reply Yet",
    
    "DisplayOrder" : 1,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "05de2b5a-ecd6-4179-9afe-e8682bda2c0e",
    
    "Code" : "AGREE",
    
    "Description" : "LA Agreed",
    
    "DisplayOrder" : 2,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "40780dae-b026-423a-ae51-fb6436a97bc7",
    
    "Code" : "DEC",
    
    "Description" : "LA Declined",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true
    
    }
    

    values for review statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/SEN/SENReviewStatus

        
     
    {
            "IsDeleted": false, 
            "ExternalID": "c5572467-0a7d-4ad0-8c66-c0196b72219f", 
            "Code": "PLND", 
            "Description": "Planned", 
            "DisplayOrder": 2, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "e1b3e39e-0a63-4101-af5f-4e1e09a361a2", 
            "Code": "DFRD", 
            "Description": "Deferred", 
            "DisplayOrder": 3, 
            "IsVisible": true
        }, 
        {
            "IsDeleted": false, 
            "ExternalID": "24d1b8e6-f71e-4151-b3d9-154230e10137", 
            "Code": "COMP", 
            "Description": "Meeting Completed", 
            "DisplayOrder": 4, 
            "IsVisible": true
        }
    

    Special Education Need Types and Provision - Query

    Select details of the special educational need types for learners, along with the provision being made for them.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$select=ExternalID&$expand=SEN($select=ExternalID;$expand=LearnerSENNeedTypes($select=ExternalID,StartDate,EndDate,SENNeedType),LearnerSENProvisionTypes($select=ExternalID,StartDate,EndDate,SENProvisionType))

    {
        "ExternalID": "2b6951d5-6729-4701-bc47-719907302000", 
        "SEN": {
            "ExternalID": "2b6951d5-6729-4701-bc47-719907302000", 
            "LearnerSENNeedTypes": [
                {
                    "ExternalID": "feeeeb36-a6f8-4d90-896d-0f9821d1664c", 
                    "StartDate": "2004-09-01T00:00:00Z", 
                    "EndDate": "2011-07-15T00:00:00Z"
                }
            ], 
            "LearnerSENProvisionTypes": [
                {
                    "ExternalID": "7572adc4-de88-4b4d-b53d-1f9078a8a4a0", 
                    "StartDate": "2008-09-01T00:00:00Z", 
                    "EndDate": "0001-01-01T00:00:00Z"
                }, 
                {
                    "ExternalID": "eddcbba1-6283-4b0e-8ba5-34f120b93e76", 
                    "StartDate": "2006-04-17T00:00:00Z", 
                    "EndDate": "2007-12-20T00:00:00Z"
                }, 
                {
                    "ExternalID": "50c007f4-ebef-43ab-97eb-6896951da91d", 
                    "StartDate": "2005-08-26T00:00:00Z", 
                    "EndDate": "2006-04-07T00:00:00Z"
                }, 
                {
                    "ExternalID": "682aa39c-04a4-4550-9df8-5ef06d2ceb49", 
                    "StartDate": "2010-09-20T00:00:00Z", 
                    "EndDate": "0001-01-01T00:00:00Z"
                }, 
                {
                    "ExternalID": "2482830c-cf13-4514-8ec1-ba1f2c68f66d", 
                    "StartDate": "2008-01-07T00:00:00Z", 
                    "EndDate": "0001-01-01T00:00:00Z"
                }
            ]
        }
    }
    
    Lookup values for SEN need types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/SEN/SENNeedTypes

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "68eeaef2-be74-4d2f-ac8f-01fda91cc8f6",
    
    "Code" : "PD",
    
    "Description" : "Physical Disability",
    
    "DisplayOrder" : 10,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "809b4c50-0120-4120-bed8-0921cd03a999",
    
    "Code" : "ASD",
    
    "Description" : "Autistic Spectrum Disorder",
    
    "DisplayOrder" : 11,
    
    "IsVisible" : true
    
    }

    Lookup values for SEN provision types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/SEN/SENProvisionTypes

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "a9e7729d-c61e-4581-a086-1690c8ea59c6",
    
    "Code" : "CLASS",
    
    "Description" : "Time in Specialist Class",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "67c6a633-2271-4fa1-b7d2-e5b0acf7984b",
    
    "Code" : "PHYSIO",
    
    "Description" : "Physiotherapy",
    
    "DisplayOrder" : 7,
    
    "IsVisible" : true
    
    }

    Learner.Transport – Sub Domain

    Details of transport assistance and the mode of travel and route.

    Learner Transport Assistance and Details - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Learner/Learners?$expand=Transport

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "d80bb03a-4b20-4345-a3c5-a37aac4d3a55",
    
    "Transport" : {
    
    "ExternalID" : "d80bb03a-4b20-4345-a3c5-a37aac4d3a55",
    
    "ELBProvidesTransport" : false,
    
    "ModeOfTravel" : {
    
    "ExternalID" : "3d073c29-809a-4d04-82d7-2f24940c5599"
    
    } ,
    
    "TravelRoute" : {
    
    "ExternalID" : "00ee2027-89b0-4074-8102-16dfa798c7e3"
    
    }
    
    }
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "08ac3f3f-3a62-44bd-a9e9-492524f8ea21",
    
    "Transport" : {
    
    "ExternalID" : "08ac3f3f-3a62-44bd-a9e9-492524f8ea21",
    
    "ELBProvidesTransport" : false,
    
    "ModeOfTravel" : {
    
    "ExternalID" : "1a51afe4-491a-4dab-b2da-699fa91be91e"
    
    } ,
    
    "TravelRoute" : null
    
    }
    
    }, ...

    Get lookup values for modes of transport.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/ModeOfTravels

    {
                "IsDeleted": false, 
                "ExternalID": "f634e85c-cc26-4180-8a2a-f7aaac47020b", 
                "Code": "TRN", 
                "Description": "Train", 
                "DisplayOrder": 12, 
                "IsVisible": true
            }, 
            {
                "IsDeleted": false, 
                "ExternalID": "1a51afe4-491a-4dab-b2da-699fa91be91e", 
                "Code": "WLK", 
                "Description": "Walk", 
                "DisplayOrder": 13, 
                "IsVisible": true
            }, ...
    
            Get lookup values for travel routes.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Learner/TravelRoutes

    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "dc5f3049-dfc2-49e5-b3a2-a615d4d435c3",
    
    "Description" : "East Town",
    
    "IsVisible" : true,
    
    "DisplayOrder" : 0
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "7b9456a1-2e06-44b9-8885-a31ef7e49fcf",
    
    "Description" : "Stage Coach X1",
    
    "IsVisible" : true,
    
    "DisplayOrder" : 0
    
    }, ...
    
    
    
    
    


    School – Rooted Domain Namespace

    Contains information describing the school along with details of how it organises its groups, working week, school year and rooms. There can be some information about other associated schools. There is an ‘IsRegistered’ property of a school to indicate it is the main school that querying primarily relates to.

    School.Details – Sub Domain

    Basic information about the school such as its name, address, intake type, the school type and any contact information.

    The ‘IsRegistered’ school from the list of all associated schools - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$select=ExternalID&$expand=Details($select=ExternalID,IsRegistered)

    Contact details for the registered school along with any sites - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$select=ExternalID&$expand=Details($select=ExternalID,IsRegistered,PreferredSchoolName,TelephoneNumber,EmailAddress,EstablishmentNumber,UniqueReferenceNumber,MainContact;$expand=Address($select=ExternalID,Street,Town,PostCode),SchoolSites($select=ExternalID,Name,ShortName,SiteContactName,MobileNumber,EmailAddress;$expand=Address($select=ExternalID,Street,Town,PostCode)))

    {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "Details" : {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "IsRegistered" : true,
    
    "PreferredSchoolName" : "WATERS EDGE PRIMARY SCHOOL",
    
    "TelephoneNumber" : "852015",
    
    "EmailAddress" : "school@we.com",
    
    "EstablishmentNumber" : "9999",
    
    "UniqueReferenceNumber" : null,
    
    "MainContact" : "Mrs G Grosvenor",
    
    "Address" : {
    
    "ExternalID" : "3affdeae-3e41-4d82-a224-3f3ba5592272",
    
    "Street" : null,
    
    "Town" : "East Town",
    
    "PostCode" : "SI3 7ND"
    
    } ,
    
    "SchoolSites" : [
    
    {
    
    "ExternalID" : "75049051-a3ef-4644-9dba-15463cfdda3a",
    
    "Name" : "WATERS EDGE PRIMARY SCHOOL",
    
    "ShortName" : null,
    
    "SiteContactName" : "Mrs G Grosvenor",
    
    "MobileNumber" : null,
    
    "EmailAddress" : "school@we.com",
    
    "Address" : {
    
    "ExternalID" : "3affdeae-3e41-4d82-a224-3f3ba5592272",
    
    "Street" : null,
    
    "Town" : "East Town",
    
    "PostCode" : "SI3 7ND"
    
    }
    
    }
    
    ]
    
    }
    
    }

    The school type and childcare provision – Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$select=ExternalID&$expand=Details($select=ExternalID;$expand=SchoolChildcareProvisions($select=ExternalID;$expand=ChildCareProvider($select=ExternalID),ChildcareType($select=ExternalID)))

    Get lookup values for childcare types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/School/ChildcareTypes

    Get lookup values for childcare types and childcare providers.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/School/ChildCareProviders

    {
    
    "value" : [
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "af7047a3-6aa2-4875-94f4-fe22e14611ce",
    
    "Code" : "SCH",
    
    "Description" : "School",
    
    "DisplayOrder" : 1,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "5ee14dda-08d8-4024-afdb-bf0ca4606c1e",
    
    "Code" : "SIP",
    
    "Description" : "School in Partnership",
    
    "DisplayOrder" : 2,
    
    "IsVisible" : true
    
    } ,
    
    {
    
    "IsDeleted" : false,
    
    "ExternalID" : "d81ec629-155c-4324-a78f-4734cfa459f1",
    
    "Code" : "OTH",
    
    "Description" : "Other (non-school) Provider",
    
    "DisplayOrder" : 3,
    
    "IsVisible" : true
    
    }
    
    ]
    
    }
    

    The registered school’s address - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(b0f79641-d98a-4768-af00-14c6e0e13cee)?$select=ExternalID&$expand=Details($select=ExternalID;$expand=Address($select=ExternalID,Street,Town,Locality,Country,PostCode))

    {
        "ExternalID": "b0f79641-d98a-4768-af00-14c6e0e13cee", 
        "Details": {
            "ExternalID": "b0f79641-d98a-4768-af00-14c6e0e13cee", 
            "Address": {
                "ExternalID": "40b8bbf6-bb08-43f7-888d-031074f7d2ae", 
                "Street": "Pontesford Hill", 
                "Town": "East Town", 
                "Locality": "Copgrove", 
                "PostCode": "SI5 0UN"
            }
        }
    }

    School.Event – Sub Domain

    Periods of time of importance to a school’s operation are known as events and may relate to working week sessions (such as AM or PM), holidays, administration days or school terms.

    Details of school holidays and inset days for the specified school - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(fbdb47cf-b07a-4891-8615-80ceaae0eebb)?$select=ExternalID&$expand=Details($select=ExternalID,IsRegistered),Event($select=ExternalID;$expand=AcademicYears($select=ExternalID;$expand=SchoolHolidays($select=ExternalID,Name,StartDate,EndDate),InsetDays($select=ExternalID,Name,Date,AMSession,PMSession)))

    {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "Details" : {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "IsRegistered" : true
    
    } ,
    
    "Event" : {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "AcademicYears" : [
    
    {
    
    "ExternalID" : "a1002b09-fc62-4ce7-8ff6-eef4cc42f4e3",
    
    "SchoolHolidays" : [
    
    {
    
    "ExternalID" : "ec0b3fc5-11c1-471c-b965-8f79be03f94f",
    
    "Name" : "Summer half term",
    
    "StartDate" : "2015-05-25T00:00:00Z",
    
    "EndDate" : "2015-05-29T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "6d9ea9d8-4b3f-44ab-ada6-b403b2fee8c8",
    
    "Name" : "Autumn half term",
    
    "StartDate" : "2014-10-27T00:00:00Z",
    
    "EndDate" : "2014-10-31T00:00:00Z"
    
    }, ...
    
    ] ,
    
    "InsetDays" : [
    
    {
    
    "ExternalID" : "43b4a15b-07bf-4c32-8a77-d0082965321b",
    
    "Name" : "INSET 1",
    
    "Date" : "2014-09-04T00:00:00Z",
    
    "AMSession" : true,
    
    "PMSession" : true
    
    } ,
    
    {
    
    "ExternalID" : "3ad88927-1632-40bb-9ad9-6338e746c0c9",
    
    "Name" : "Staff Training Day",
    
    "Date" : "2014-09-02T00:00:00Z",
    
    "AMSession" : true,
    
    "PMSession" : true
    
    }, ...
    
    ]
    
    }, ...
    
    ]
    
    }
    
    }
    

    The registered school’s working week patterns - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(fbdb47cf-b07a-4891-8615-80ceaae0eebb)?$select=ExternalID&$expand=Event($select=ExternalID;$expand=AcademicYears($select=ExternalID;$expand=WorkingWeekPatterns($select=ExternalID,Monday,Tuesday,Wednesday,Thursday,Friday;$expand=WorkingWeekSession($select=ExternalID,Name,StartTime,EndTime))))

    School terms and public holidays - Query

    http://localhost:28513/School/Schools(fbdb47cf-b07a-4891-8615-80ceaae0eebb)?$select=ExternalID&$expand=Event($select=ExternalID;$expand=AcademicYears($select=ExternalID;$expand=SchoolTerms($select=ExternalID,Name,StartDate,EndDate),PublicHolidays($select=ExternalID,Name,Date)))

    {
    
    "@odata.context" : "http://localhost:28513/School/$metadata#Schools(ExternalID,Event(ExternalID,AcademicYears(ExternalID,SchoolTerms(ExternalID,Name,StartDate,EndDate),PublicHolidays(ExternalID,Name,Date))))/$entity" ,
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "Event" : {
    
    "ExternalID" : "fbdb47cf-b07a-4891-8615-80ceaae0eebb",
    
    "AcademicYears" : [
    
    {
    
    "ExternalID" : "a1002b09-fc62-4ce7-8ff6-eef4cc42f4e3",
    
    "SchoolTerms" : [
    
    {
    
    "ExternalID" : "9c2f31a6-d984-4e40-9d18-ebbe4c18cf8f",
    
    "Name" : "Summer Term",
    
    "StartDate" : "2015-04-13T00:00:00Z",
    
    "EndDate" : "2015-07-24T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "d0fb1c55-75da-4183-8985-fea6f371a77e",
    
    "Name" : "Autumn Term",
    
    "StartDate" : "2014-09-01T00:00:00Z",
    
    "EndDate" : "2014-12-19T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "a7b1630f-6412-4afe-8605-88502793289f",
    
    "Name" : "Spring Term",
    
    "StartDate" : "2015-01-05T00:00:00Z",
    
    "EndDate" : "2015-03-27T00:00:00Z"
    
    }
    
    ] ,
    
    "PublicHolidays" : [
    
    {
    
    "ExternalID" : "4aca3ead-4097-407a-81d7-898c2e6f354c",
    
    "Name" : "Easter Monday",
    
    "Date" : "2015-04-06T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "8bd99097-2f9c-4249-b6c3-66e34dfbcd5d",
    
    "Name" : "Good Friday",
    
    "Date" : "2015-04-03T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "3eeb61ef-dd93-40c8-8265-fbd9dbf39d85",
    
    "Name" : "Spring Bank Holiday",
    
    "Date" : "2015-05-25T00:00:00Z"
    
    } ,
    
    {
    
    "ExternalID" : "dfdce87f-d82b-49bb-b4c7-ab045a4347fa",
    
    "Name" : "May Day",
    
    "Date" : "2015-05-04T00:00:00Z"
    
    }
    
    ]
    
    }
    
    ]
    
    }
    
    }
    
    
    

    School holidays and school terms – Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools?$select=ExternalID&$expand=Event($select=ExternalID;$expand=AcademicYears($select=ExternalID;$expand=SchoolHolidays($select=ExternalID,StartDate,EndDate,Name),SchoolTerms($select=ExternalID,StartDate,EndDate, Name)))

    {
        "ExternalID": "fbdb47cf-b07a-4891-8615-80ceaae0eebb", 
        "Event": {
            "ExternalID": "fbdb47cf-b07a-4891-8615-80ceaae0eebb", 
            "AcademicYears": [
                {
                    "ExternalID": "eccbe5e9-0c8e-4a22-abba-d7be8faa974f", 
                    "SchoolHolidays": [
                        {
                            "ExternalID": "9c103a7c-5cfc-43f2-b4b7-a865bfcdf722", 
                            "StartDate": "2018-03-16T00:00:00Z", 
                            "EndDate": "2018-04-14T00:00:00+01:00", 
                            "Name": "Easter Holiday"
                        }, 
                        {
                            "ExternalID": "266ba67d-4e18-4324-a9bc-cf122bc57b44", 
                            "StartDate": "2018-07-23T00:00:00+01:00", 
                            "EndDate": "2018-09-04T00:00:00+01:00", 
                            "Name": "Summer Holiday"
                        }, 
                        {
                            "ExternalID": "bc5ec3fe-7ebc-4e5a-81d2-b282a576b63b", 
                            "StartDate": "2017-09-10T00:00:00+01:00", 
                            "EndDate": "2017-09-15T00:00:00+01:00", 
                            "Name": "Autumn HT"
                        }, 
                        {
                            "ExternalID": "e1b20bd5-4e6e-4112-b047-206dd169911a", 
                            "StartDate": "2017-12-20T00:00:00Z", 
                            "EndDate": "2017-12-25T00:00:00Z", 
                            "Name": "Autumn HT"
                        }, 
                        {
                            "ExternalID": "37c696b0-93a2-430a-9511-7266af4e8ebf", 
                            "StartDate": "2018-04-20T00:00:00+01:00", 
                            "EndDate": "2018-04-25T00:00:00+01:00", 
                            "Name": "Autumn HT"
                        }, 
                        {
                            "ExternalID": "77a2b60a-1504-4cec-a55c-b9b3768da581", 
                            "StartDate": "2017-11-16T00:00:00Z", 
                            "EndDate": "2017-12-14T00:00:00Z", 
                            "Name": "Christmas Holiday"
                        }
                    ], 
                    "SchoolTerms": [
                        {
                            "ExternalID": "05b0bd97-9aa0-42e9-9f53-bd038b65073b", 
                            "StartDate": "2017-09-05T00:00:00+01:00", 
                            "EndDate": "2017-11-15T00:00:00Z", 
                            "Name": "Autumn"
                        }, 
                        {
                            "ExternalID": "a3545a17-9514-4a24-be3c-df0807af61d7", 
                            "StartDate": "2017-12-15T00:00:00Z", 
                            "EndDate": "2018-03-15T00:00:00Z", 
                            "Name": "Spring"
                        }, 
                        {
                            "ExternalID": "b2815231-ff1f-4227-8abd-c5e4d487ae21", 
                            "StartDate": "2018-04-15T00:00:00+01:00", 
                            "EndDate": "2018-07-22T00:00:00+01:00", 
                            "Name": "Summer"
                        }
                    ]
                }
            ]
        }
    }
    

    School.Group – Sub Domain

    Groups within a school such as National Curriculum years, pastoral groups, primary classes, year groups and house membership.

    National Curriculum years for the school and the primary classes - Query
    
    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$expand=Group($select=ExternalID;$expand=SchoolNCYears($select=ExternalID),PrimaryClasses($select=ExternalID,Active,FullName,IsCurriculumClass,IsPastoralClass,ShortName))
    
    {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "Group" : {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "SchoolNCYears" : [
    
    {
    
    "ExternalID" : "4bed3f30-8f8e-4767-8ce6-0b30872fd09f"
    
    } ,
    
    {
    
    "ExternalID" : "072d341c-bbc0-4c33-a9ac-6bed78d1322b"
    
    }
    
    ] ,
    
    "PrimaryClasses" : [
    
    {
    
    "ExternalID" : "d9e10285-05c7-4ec3-862b-fffd8a4883ea",
    
    "Active" : true,
    
    "FullName" : "N1 AM",
    
    "IsCurriculumClass" : false,
    
    "IsPastoralClass" : false,
    
    "ShortName" : "N1 AM"
    
    } ,
    
    {
    
    "ExternalID" : "18c5121d-5711-45b3-b9be-acb9e75a27b4",
    
    "Active" : true,
    
    "FullName" : "6VC",
    
    "IsCurriculumClass" : false,
    
    "IsPastoralClass" : false,
    
    "ShortName" : "6VC"
    
    }
    
    ]
    
    }
    
    }
    

    Get details of all teaching groups - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$expand=Group($select=ExternalID;$expand=TeachingGroups($select=ExternalID,FullName,ShortName))

    {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "TeachingGroups" : [
    
    {
    
    "ExternalID" : "a667be0d-7591-4191-8543-616e7a078315",
    
    "FullName" : "Year 5 English Set 2",
    
    "ShortName" : "Y5EN2"
    
    } ,
    
    {
    
    "ExternalID" : "815f4d8e-a0bd-4ca3-88e3-b7782d09fad3",
    
    "FullName" : "Year 5 Mathematics Set 3",
    
    "ShortName" : "Y5MA3"
    
    }
    
    ]
    
    }
    

    The type and name of all pastoral groups - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$expand=Group($select=ExternalID;$expand=PastoralGroups($select=ExternalID,EntityName,FullName,ShortName))

    {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "PastoralGroups" : [
    
    {
    
    "ExternalID" : "83acc144-0681-4ab6-8188-f393c7510da8",
    
    "EntityName" : "YearGroup",
    
    "FullName" : "Year 1",
    
    "ShortName" : "1"
    
    } ,
    
    {
    
    "ExternalID" : "9012d8d3-4a2f-4436-804d-2d8449bd36ff",
    
    "EntityName" : "YearGroup",
    
    "FullName" : "Year 2",
    
    "ShortName" : "2"
    
    } , ...
    
    {
    
    "ExternalID" : "d9e10285-05c7-4ec3-862b-fffd8a4883ea",
    
    "EntityName" : "PrimaryClass",
    
    "FullName" : "N1 AM",
    
    "ShortName" : "N1 AM"
    
    } ,
    
    {
    
    "ExternalID" : "18c5121d-5711-45b3-b9be-acb9e75a27b4",
    
    "EntityName" : "PrimaryClass",
    
    "FullName" : "6VC",
    
    "ShortName" : "6VC"
    
    } , ...
    
    {
    
    "ExternalID" : "545c8380-dd9c-4bde-a863-f95b49bafced",
    
    "EntityName" : "House",
    
    "FullName" : "Flemming",
    
    "ShortName" : "Flemming"
    
    } ,
    
    {
    
    "ExternalID" : "838d2915-9056-4aca-858e-5a0cd7d934b9",
    
    "EntityName" : "House",
    
    "FullName" : "Newton",
    
    "ShortName" : "Newton"
    
    } , ...
    
    {
    
    "ExternalID" : "a2833fea-f611-43e8-a53c-361d27b2da83",
    
    "EntityName" : "Tier",
    
    "FullName" : "All Tiers",
    
    "ShortName" : "School"
    
    } ,
    
    {
    
    "ExternalID" : "072d341c-bbc0-4c33-a9ac-6bed78d1322b",
    
    "EntityName" : "SchoolNCYear",
    
    "FullName" : "Curriculum Year 5",
    
    "ShortName" : "5"
    
    } ,
    
    {
    
    "ExternalID" : "dfb8f37e-3018-4972-9221-7d5fb1bb33f6",
    
    "EntityName" : "SchoolNCYear",
    
    "FullName" : "Curriculum Year 9",
    
    "ShortName" : "9"
    
    }, ...
    
    ]
    
    }

    Primary classes and how they relate to year groups - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$expand=Group($select=ExternalID;$expand=PrimaryClasses($select=ExternalID,FullName,ShortName;$expand=YearGroupPrimaryClassAssociations($select=ExternalID,StartDate,EndDate;$expand=YearGroup($select=ExternalID,FullName,ShortName))))

    {
    
    "ExternalID" : "f49dafdc-2684-4e74-bc60-31f18f9b8d7a",
    
    "FullName" : "N1 PM",
    
    "ShortName" : "N1 PM",
    
    "YearGroupPrimaryClassAssociations" : [
    
    {
    
    "ExternalID" : "136b5e4e-51f5-4273-b34e-7fd8cbda98fa",
    
    "StartDate" : "2016-09-01T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "YearGroup" : {
    
    "ExternalID" : "a6beeec4-1726-4a5b-b4d1-d274cc03cc06",
    
    "FullName" : "Year N1",
    
    "ShortName" : "N1"
    
    }
    
    }
    
    ]
    
    },
    
    {
    
    "ExternalID" : "5d1c5578-ff6a-415a-9601-5c8d472143d0",
    
    "FullName" : "OAK",
    
    "ShortName" : "OAK",
    
    "YearGroupPrimaryClassAssociations" : [
    
    {
    
    "ExternalID" : "cad14897-8f59-490f-b3e5-141f90dab4b7",
    
    "StartDate" : "2001-08-27T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "YearGroup" : {
    
    "ExternalID" : "0a85a667-7cac-4302-a3d7-fa06329bae64",
    
    "FullName" : "Year R",
    
    "ShortName" : "R"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "0de33e53-04cf-4bdb-ac4e-ecfe9dddc499",
    
    "StartDate" : "2001-08-27T00:00:00Z",
    
    "EndDate" : "0001-01-01T00:00:00Z",
    
    "YearGroup" : {
    
    "ExternalID" : "83acc144-0681-4ab6-8188-f393c7510da8",
    
    "FullName" : "Year 1",
    
    "ShortName" : "1"
    
    }
    
    }
    
    ]
    
    }, ...

    Get details of the set membership for each primary class - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?$expand=Group($select=ExternalID;$expand=PrimaryClasses($select=ExternalID,FullName,ShortName;$expand=PrimaryClassSetMemberships($select=ExternalID,StartDate,EndDate)))

    School.NamedDateRange – Sub Domain

    Details of date ranges used within a school which help constitute how a school year is organised. This includes names for academic years, inset days, school terms, public holidays and school holidays.

    Named date ranges for academic years - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/School/Schools(f2e1813a-b266-42f2-b786-43e1a5bc3da1)?select=ExternalID&$expand=NamedDateRange($select=ExternalID;$expand=AcademicYears($select=ExternalID,Name,StartDate,EndDate,FirstDayOfWeek;$expand=SchoolYear($select=ExternalID,Name)))

    {
    
    "@odata.context" : "http://pm-sims-primary-api-partner-dev.azurewebsites.net/School/$metadata#Schools(NamedDateRange(ExternalID,AcademicYears,AcademicYears(ExternalID,Name,StartDate,EndDate,FirstDayOfWeek,SchoolYear,SchoolYear(ExternalID,Name))))/$entity" ,
    
    "IsDeleted" : false,
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "NamedDateRange" : {
    
    "ExternalID" : "f2e1813a-b266-42f2-b786-43e1a5bc3da1",
    
    "AcademicYears" : [
    
    {
    
    "ExternalID" : "69f32e11-2b76-4281-8e7d-d0f0290753d7",
    
    "Name" : "Academic Year 2016/2017",
    
    "StartDate" : "2016-09-01T00:00:00Z",
    
    "EndDate" : "2017-08-31T00:00:00Z",
    
    "SchoolYear" : {
    
    "ExternalID" : "a121bd82-1692-4ec8-a9cf-95dc7b19881b",
    
    "Name" : "2016/2017"
    
    }
    
    } ,
    
    {
    
    "ExternalID" : "5412b687-cda2-4c29-8526-feb64c5417aa",
    
    "Name" : "Academic Year 2015/2016",
    
    "StartDate" : "2015-09-01T00:00:00Z",
    
    "EndDate" : "2016-08-31T00:00:00Z",
    
    "SchoolYear" : {
    
    "ExternalID" : "3e074005-b49e-49f3-bda8-dea616f32387",
    
    "Name" : "2015/2016"
    
    }
    
    }
    
    ]
    
    }
    
    }
    


    Staff – Rooted Domain Namespace

    Details about staff at the school such as name and address, attendance, dietary needs, professional qualifications, contractual information, medical conditions.

    Staff.Attendance

    Details about staff attendance, absence, illness.

    Get details of staff absence along with any absence certificate and signatory - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Attendance($select=ExternalID;$expand=StaffAbsences($select=ExternalID,ExpectedReturnDate,ActualReturnDate,WorkingDaysLost,WorkingHoursLost,StartDate,AnnualLeave,IndustrialInjury;$expand=StaffAbsenceCertificates($select=ExternalID,DateReceived,DateSigned,SignedBy,StartDate;$expand=SignatoryType($select=ExternalID),CertificateAdvice($select=ExternalID))))

    Get lookup values for absence types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Attendance/AbsenceTypes

    Get lookup values for signatory types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Attendance/AbsenceCertificateSignatoryTypes

    Get lookup values for absence certificate advice.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Attendance/AbsenceCertificateAdvices

    Get details of the staff absence illness category and the absence type - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Attendance($select=ExternalID;$expand=StaffAbsences($select=ExternalID,StartDate,EndDate;$expand=IllnessCategory($select=ExternalID),AbsenceType($select=ExternalID)))

    Get lookup values for illness categories.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Attendance/IllnessCategories

    Get lookup values for absence types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Attendance/AbsenceTypes

    Staff.Contractual

    Details of staff, contracts, pay scales, salary ranges.

    Staff, contracts and pay scales - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/ Staff/Staffs?$select=ExternalID&$expand=Contractual($select=ExternalID;$expand=Employee($select=ExternalID;$expand=EmploymentContract($select=ExternalID,AcceptedDate,AnnualLeaveEntitlementDays,ContractNumber,HoursPerWeek,StartDate;$expand=PostType($select=ExternalID),EmploymentContractPayScale($select=ExternalID,StartDate,EndDate,Point;$expand=PayScale($select=ExternalID)))))

    Staff, contracts and salary range - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Contractual($select=ExternalID;$expand=Employee($select=ExternalID;$expand=EmploymentContract($select=ExternalID,AcceptedDate,AnnualLeaveEntitlementDays,ContractNumber,HoursPerWeek,StartDate;$expand=PostType($select=ExternalID),EmploymentContractSalaryRange($select=ExternalID,StartDate,EndDate,AnnualSalary;$expand=SalaryRange($select=ExternalID)))))

    Get lookup values for pay scales.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Contractual/StatutoryPayScales

    Get lookup values for post types.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Contractual/PostTypes

    Get lookup values for salary ranges.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Contractual/SalaryRanges

    Details of staff service agreements - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Contractual($select=ExternalID;$expand=ServiceAgreement($select=ExternalID,AcceptedDate,AdditionalPayment,AgreementHoursPerWeek,BasePay,DailyRate,StartDate,EndDate,FTEHoursPerWeek,TotalPay;$expand=ServiceAgreementRole($select=ExternalID,StartDate,EndDate;$expand=StaffRole($select=ExternalID)),ServiceAgreementType($select=ExternalID)))

    Lookup for staff roles

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/StaffRoles

    Lookup for service agreement types

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Contractual/ServiceAgreementTypes

    Staff.Cultural

    Cultural information for staff, such as ethnicity, religion, languages spoken.

    Staff ethnicity and religion - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Cultural($select=ExternalID;$expand=StaffReligion($select=ExternalID),StaffEthnicity($select=ExternalID))

    Get lookup values for staff ethnicity.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/StaffEthnicities

    Get lookup values for staff religion.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/StaffReligions

    Staff languages - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Cultural($select=ExternalID;$expand=StaffLanguageRelationships($select=ExternalID,IsFirstLanguage;$expand=StaffLanguage($select=ExternalID),LanguageFluency($select=ExternalID)))

    Get lookup values for staff languages

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/StaffLanguages

    Get lookup values for staff language fluency.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/LanguageFluencies

    Staff.Dietary

    The dietary needs of staff, such as allergies.

    Dietary needs for staff - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Dietary($select=ExternalID;$expand=StaffDietaryNeeds($select=ExternalID;$expand=DietaryNeed($select=ExternalID)))

    Get lookup values for staff dietary needs.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/General/DietaryNeeds

    Staff.Extended

    Extended information about staff, such as confidential notes, car details, date of birth, legal names, vehicle details.

    Staff and their vehicles - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Extended($select=ExternalID,DateOfBirth,LegalForename,LegalMiddleNames,LegalSurname;$expand=StaffVehicleDetail($select=ExternalID,Make,Model,Colour,VehicleRegistration,PermitNumber))

    Staff previous names and marital status - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Extended($select=ExternalID,DateOfBirth,LegalForename,LegalMiddleNames,LegalSurname;$expand=StaffPreviousName($select=ExternalID,LegalForename,LegalMiddleNames,LegalSurname,DateOfChange;$expand=ReasonForChange($select=ExternalID)))

    Get lookup values for the reasons for a name change

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup2/General/ReasonForNameChanges

    Staff.Medical

    Get details of medical information for staff.

    Medical information for staff - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Medical($select=ExternalID,DisabilityNumber;$expand=StaffMedicalNotes($select=ExternalID,Confidential,Note,Summary),StaffImpairments($select=ExternalID;$expand=ImpairmentCategory($select=ExternalID)))

    Staff.Professional

    Staff qualifications, qualified teacher status, their teaching subjects, and training courses taken.

    Staff qualifications - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Professional($select=ExternalID,HLTADate,HLTAStatus,IsTeachingStaff,TAStatus,TeacherReferenceNumber;$expand=QualifiedTeacherStatus($select=ExternalID),StaffQualifications($select=ExternalID,ClassOfDegree,CountryOfOrigin,DateAwarded,FirstSubjectQualified,LocalAuthorityClassification,Qualification,QualificationLevel,SecondSubjectQualified,Title,Verified))

    Get lookup for class of degree.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/ClassOfDegrees

    Lookup values for qualified teacher status.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/QualifiedTeacherStatus

    Lookups for staff teaching subjects.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/TeachingSubjects

    Lookup for qualification level.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/QualificationLevels

    Lookup for class of degree.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/ClassOfDegrees

    Courses taken and courses for which enrolments have been made - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Professional($select=ExternalID,TeacherReferenceNumber;$expand=StaffTrainingCourseEnrolments($select=ExternalID;$expand=CourseEnrolmentStatus($select=ExternalID),TrainingCourseOccurrence($select=ExternalID)))

    Get lookup values for training course occurrences and the course level.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/TrainingCourse/TrainingCourses?$select=ExternalID&$expand=Detail($select=ExternalID,CourseFees,Description,Duration,FullTime,Title;$expand=TrainingCourseOccurrences($select=ExternalID,StartDate,EndDate,Venue),CourseLevel($select=ExternalID))

    Get lookup values for training course levels.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/TrainingCourse/TrainingCourseLevels

    Get lookup values for training course enrolment statuses.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/TrainingCourse/TrainingCourseEnrolmentStatus

    Staff.Service – Sub Domain

    Service records, reasons for leaving, previous and next employers, national insurance number.

    Service records for staff - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Staff/Staffs?$select=ExternalID&$expand=Service($select=ExternalID,NationalInsuranceNumber;$expand=StaffServiceRecords($select=ExternalID,ContinuousServiceStartDate,Destination,LocalAuthorityStartDate,NextEmployer,PreviousEmployer,ServiceEndDate;$expand=StaffReasonForLeaving($select=ExternalID)))

    Get lookup values for staff reason for leaving.

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Lookup/Staff/Contractual/StaffReasonForLeavings


    Training – Domain Namespace

    Details of training courses.

    Training.Detail – Domain

    Details of training courses.

    All training course details - Query

    https://pmapis.azure-api.net/sp-api-partner-dev/V1/Training/TrainingCourses?$select=ExternalID&$expand=Detail($select=ExternalID,CourseFees,Description,Duration,Fulltime,Title;$expand=CourseLevel($select=ExternalID),TrainingCourseOccurences($select=ExternalID,StartDate,EndDate,RenewalDate,Venue))

     

    SIMS Primary RESOURCES

    Related resources for SIMS Primary