© 2018 Capita Business Services Ltd. All rights reserved.

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

SIMS 8 - V3 - Pastoral Group Definitions

This API is the main API for getting group definitions for pastoral groups within SIMS 8.

There are a number of different types of group
  Primary Class
  Year Group
  School Tier
  House
All of the above are returned by the call.

Example Call

<Stem>/v3/PastoralGroupDefinitions

See here for Stem URLs

Example Output

{
  "@odata.context": "https://pm-svc-api-supershim-staging.azurewebsites.net/ThirdParty/PastoralGroup/odata/v1/$metadata#PastoralGroupDefinitions",
  "value": [
    {
      "@odata.type": "#SIMS.YearGroupDefinition",
      "ExternalID": "2264e125-a842-4096-9cf6-90fe4c7a3a6e",
      "PastoralGroupType": "YearGroup",
      "ShortName": "N1",
      "FullName": "Year N1",
      "DisplayOrder": 1
    },
    {
      "@odata.type": "#SIMS.YearGroupDefinition",
      "ExternalID": "63358fca-608c-4219-bb9d-2f2a4b9924fa",
      "PastoralGroupType": "YearGroup",
      "ShortName": "N2",
      "FullName": "Year  N2",
      "DisplayOrder": 2
    },
    {
      "@odata.type": "#SIMS.YearGroupDefinition",
      "ExternalID": "db3f5c90-3b6a-48f3-adb7-276142bd9636",
      "PastoralGroupType": "YearGroup",
      "ShortName": "R",
      "FullName": "Year  R",
      "DisplayOrder": 3
    },
    {
      "@odata.type": "#SIMS.YearGroupDefinition",
      "ExternalID": "f3fee5f0-a80f-40f3-86c8-a667dd7cab19",
      "PastoralGroupType": "YearGroup",
      "ShortName": "1",
      "FullName": "Year  1",
      "DisplayOrder": 4
    },
    {
      "@odata.type": "#SIMS.YearGroupDefinition",
      "ExternalID": "1df100b3-c3a0-482b-aac7-e0898a2640f1",
      "PastoralGroupType": "YearGroup",
      "ShortName": "2",
      "FullName": "Year  2",
      "DisplayOrder": 5
    },
    {
      "@odata.type": "#SIMS.PrimaryClassDefinition",
      "ExternalID": "8f9ffd5d-4fbe-46e2-a726-c82c098d8801",
      "PastoralGroupType": "PrimaryClass",
      "ShortName": "Kelvin",
      "FullName": "Kelvin Class",
      "DisplayOrder": 1
    },
    {
      "@odata.type": "#SIMS.PrimaryClassDefinition",
      "ExternalID": "db5806e8-db0c-48f5-b2e6-d81d46b319f1",
      "PastoralGroupType": "PrimaryClass",
      "ShortName": "Celsius",
      "FullName": "Celsius Class",
      "DisplayOrder": 1
    },
    {
      "@odata.type": "#SIMS.PrimaryClassDefinition",
      "ExternalID": "b3e9c7d8-7da0-4c1c-b733-ff06049d4a4f",
      "PastoralGroupType": "PrimaryClass",
      "ShortName": "Farenheight",
      "FullName": "Fahrenheit Class",
      "DisplayOrder": 1
    },
    {
      "@odata.type": "#SIMS.PrimaryClassDefinition",
      "ExternalID": "813734f6-2e66-4143-aadc-11a6f3bfd193",
      "PastoralGroupType": "PrimaryClass",
      "ShortName": "AM",
      "FullName": "AM",
      "DisplayOrder": 11
    },
    {
      "@odata.type": "#SIMS.HouseDefinition",
      "ExternalID": "47f2bc8b-b589-424f-bfbd-0c8e66c8a3a4",
      "PastoralGroupType": "House",
      "ShortName": "PR",
      "FullName": "Pirates",
      "DisplayOrder": 0
    },
    {
      "@odata.type": "#SIMS.HouseDefinition",
      "ExternalID": "b9fe190d-4558-4e0c-b7fa-bbd18f5526e4",
      "PastoralGroupType": "House",
      "ShortName": "Boyle",
      "FullName": "Boyle",
      "DisplayOrder": 1
    },
    {
      "@odata.type": "#SIMS.HouseDefinition",
      "ExternalID": "6a3eb4c6-b8c8-4acf-aede-9e32abf2d9f0",
      "PastoralGroupType": "House",
      "ShortName": "Hooke",
      "FullName": "Hooke",
      "DisplayOrder": 4
    },
    {
      "@odata.type": "#SIMS.TierDefinition",
      "ExternalID": "1550d460-98fe-4157-a1cd-dca3e5059313",
      "PastoralGroupType": "Tier",
      "ShortName": "KS1",
      "FullName": "KeyStage 1",
      "DisplayOrder": 0
    },
    {
      "@odata.type": "#SIMS.TierDefinition",
      "ExternalID": "edd53fd8-8212-44a0-9015-8ff145ace429",
      "PastoralGroupType": "Tier",
      "ShortName": "School",
      "FullName": "All Tiers",
      "DisplayOrder": 1
    }
  ]
}

How does this differ from V2?

The Call

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

NB: A further expand would be needed to include 'Title' in V2 because all lookups must be explicitly included.

Differences

Photo URL is provided and can be used to obtain the photograph in V3 it was not available in V2.

The data does not have a 'Personal' sub-block in V3 but it does in V2.

External lookup locations are inclued as a Type

IsDeleted is only returned in change tracking APIs, V2 has change tracking as a function on the call whereas V3 has a separate end point.

V2 Output

{
    "value": [
        {
            "IsDeleted": false,
            "ExternalID": "2cea37cb-dbb5-4ebb-b1f9-89770752c53b",
            "Personal": {
                "IsDeleted": false,
                "ExternalID": "2cea37cb-dbb5-4ebb-b1f9-89770752c53b",
                "QuickNote": null,
                "PreferredForename": "Dawid",
                "PreferredSurname": "Machowski",
                "BirthCertificateSeen": false,
                "LegalForename": "Dawid",
                "LegalMiddleNames": null,
                "LegalSurname": "Machowski",
                "DateOfBirth": "2010-06-12T00:00:00Z",
                "DateOfDeath": null,
                "Gender": {
                    "IsDeleted": false,
                    "ExternalID": "4c8eaf6a-6cd1-45f2-9227-54b9d9ab05bc"
                }
            }
        }, ...