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

This API is the API for getting basic data about the cultural identity of a learner, the data available is shown below.

Warning: LearnerCulturals contains special category data according to GDPR.

Learners contain, leavers or past students, current students and future students.  The enrolment status dictates which of these apply and do consider that a learner may have been a future student, then a current student, then a leaver and then back to being a current student before leaving again.  LearnerCulturals is not easily filtered for 'current students'.

Example Call

<Stem>/V1/LearnerCulturals?$top=30

See here for Stem URLs

Example Output

{
  "@odata.context": "https://pm-svc-api-supershim-staging.azurewebsites.net/ThirdParty/Learner/V3/$metadata#LearnerCulturals",
  "value": [
    {
      "ExternalID": "3221c311-c184-4acd-9a91-f8f924b45d11",
      "DateOfEntryIntoEWBES": null,
      "PreviouslyEducatedInNEWBES": false,
      "IsTaughtThroughIrishMedium": false,
      "EnglishAsAdditional": null,
      "CountryOfBirth": null,
      "Ethnicity": {
        "ExternalID": "2e410efb-cf32-4d1e-bfd8-c8d70d9b1e79",
        "Type": "Learner.Lookup.Ethnicity"
      },
      "EthnicDataSource": {
        "ExternalID": "5750d463-b1f9-49e5-9648-a2f2bfe02cc0",
        "Type": "Learner.Lookup.EthnicDataSource"
      },
      "Religion": null,
      "AsylumSeeker": null,
      "WelshDataSource": null,
      "TaughtWelsh": null,
      "SpeaksWelshWithSiblings": null,
      "SpeaksWelshWithParents": null,
      "SpeaksWelshAtHome": null,
      "SpeaksWelsh": null,
      "NationalIdentifier": null,
      "LearnerNationalities": []
    },
    {
      "ExternalID": "de25dcfb-a094-4118-a8fd-67c38d3a2da7",
      "DateOfEntryIntoEWBES": null,
      "PreviouslyEducatedInNEWBES": false,
      "IsTaughtThroughIrishMedium": false,
      "EnglishAsAdditional": false,
      "CountryOfBirth": {
        "ExternalID": "17eeb935-af3d-4ac9-9a87-3c2413914923",
        "Type": "Learner.Lookup.Country"
      },
      "Ethnicity": {
        "ExternalID": "c1179094-7e8c-48a8-b7ce-83600895b682",
        "Type": "Learner.Lookup.Ethnicity"
      },
      "EthnicDataSource": {
        "ExternalID": "5750d463-b1f9-49e5-9648-a2f2bfe02cc0",
        "Type": "Learner.Lookup.EthnicDataSource"
      },
      "Religion": {
        "ExternalID": "472b1f28-c6c4-4036-a7e9-96cab8beb252",
        "Type": "Learner.Lookup.Religion"
      },
      "AsylumSeeker": null,
      "WelshDataSource": null,
      "TaughtWelsh": null,
      "SpeaksWelshWithSiblings": null,
      "SpeaksWelshWithParents": null,
      "SpeaksWelshAtHome": null,
      "SpeaksWelsh": null,
      "NationalIdentifier": {
        "ExternalID": "def2720e-9dfa-4a6b-bd2b-74bc4a49085d",
        "Type": "Learner.Lookup.NationalIdentifier"
      },
      "LearnerNationalities": [
        {
          "ExternalID": "44dec5dd-ad7b-4963-889a-6ab716315a66",
          "Type": "Learner.Lookup.Nation"
        }
      ]
    }, ...

How does this differ from V2?

The Call

Call Required:  https://pmapis.azure-api.net/sp-api-partner-live/V2/Learner/Learners?$expand=Cultural($expand=Ethnicity,Religion)

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

Differences

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

External lookup locations are inclued as a Type and do not explicitly need an expand.

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",
            "Cultural": {
                "IsDeleted": false,
                "ExternalID": "2cea37cb-dbb5-4ebb-b1f9-89770752c53b",
                "IsTaughtThroughIrishMedium": false,
                "EnglishAsAdditional": true,
                "PreviouslyEducatedInNEWBES": false,
                "DateOfEntryIntoEWBES": null,
                "Ethnicity": {
                    "IsDeleted": false,
                    "ExternalID": "455556a0-7024-46ee-870e-d8d249fdfe02"
                },
                "Religion": {
                    "IsDeleted": false,
                    "ExternalID": "5fe660b8-6010-4d7f-b576-2ca1395c672f"
                }
            }
        }, ...