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

DeX OData - Learner Lookups

Example call

<Stem>\Learner/V3/LearnerLookups

Sample Code

Please click here for sample code.

Structure

 public class TResourceProviderRef
    {
        public Guid ExternalID;
        public string Type;
    }
    public class TLearnerLookups
    {
        public Guid ExternalID;
        public TResourceProviderRef ResourceProvider;
        public string Description;
        public string Code;
        public Nullable<int> DisplayOrder;
        public Nullable<bool> IsVisible;
        public string LookupType;
        public string ExternalCode;
    }

Sample Output

NB: This is a small subset - it covers many other learner lookups, click on the link Full export example  for more detail.

 {
      "@odata.type": "#SIMS.Gender",
      "ExternalID": "3cf42a09-2ce9-48c5-b984-85b1cd00dd62",
      "LookupType": "Gender",
      "Code": "1",
      "Description": "Male",
      "DisplayOrder": 2,
      "IsVisible": true,
      "ExternalCode": "M",
      "ResourceProvider": {
        "ExternalID": "bacdf7af-43e2-49ed-a85d-a55c46c293ff",
        "Type": "EducationalEstablishment.Lookup.StatutoryBody"
      }
    },
    {
      "@odata.type": "#SIMS.Gender",
      "ExternalID": "be308f7e-3387-4515-b13a-72684c253962",
      "LookupType": "Gender",
      "Code": "2",
      "Description": "Female",
      "DisplayOrder": 3,
      "IsVisible": true,
      "ExternalCode": "F",
      "ResourceProvider": {
        "ExternalID": "bacdf7af-43e2-49ed-a85d-a55c46c293ff",
        "Type": "EducationalEstablishment.Lookup.StatutoryBody"
      }
    },