DeX OData - Learner Identifiers

This API is the API for getting data for a learner browse or list, the data available is shown below.

A filter is available on current enrolment status.

Example Call

<Stem>/V3/LearnerIdentifiers
<Stem>/V3/LearnerIdentifiers?$filter=OnRollState eq 'Current'
<Stem>/V3/LearnerIdentifiers?$filter=CurrentYearGroup/ExternalID eq 8b59b027-9103-455a-a13f-9e86bfaf5eb0
<Stem>/V3/LearnerIdentifiers?$filter=CurrentHouse/ExternalID ne null

See here for Stem URLs

See here for sample code.

Example Output

{
  "@odata.context": "https://pm-svc-api-supershim-staging.azurewebsites.net/ThirdParty/Learner/OData/V1/$metadata#LearnerIdentifiers",
  "value": [
    {
      "ExternalID": "ab4820ba-beea-4e4d-ac9e-008b885ab8ed",
      "Forename": "Cisco",
      "Surname": "Ramon",
      "GenderCategory": "Male",
      "AgeMonths": 7,
      "DoNotCommunicate": false,
      "OnRollState": "Current",
      "DateOfApplication": null,
      "Photograph": null,
      "CurrentYearGroup": {
        "Description": "Year  5",
        "ExternalID": "2a94f021-b49f-4433-bd2f-00710740851b",
        "Type": "PastoralGroup.Definition.YearGroup"
      }, 
     "CurrentPrimaryClass": {
        "Description": "5DT",
        "ExternalID": "e273262e-a586-4d58-a421-b08fd0abc5f6",
        "Type": "PastoralGroup.Definition.PrimaryClass"
      },
      "CurrentHouse": null
    },

How does this differ from V2?

N/A: This was not available in V2.