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

Read is supported in DeX OData and SIMS 8 V3 APIs. 

Example Call

https://seli00apm01.azure-api.net/dex/Learner/odata/V3/ContactBasics // (DeX OData)

See here for Stem URLs for SIMS 8.

Click here for sample code

API Definition

  public class TContactBasics
    {
        public Guid ExternalID;
        public string Surname;
        public string Forename;
        public string MiddleName;
        public Nullable<bool> IsTranslatorRequired;
        public Nullable<bool> ParentalBallot;
        public string Honours;
        public string Salutation;
        public string Addressee;
        public string PlaceOfWork;
        public string JobTitle;
        public TReferenceClass Title;
        public TReferenceClass HomeLanguage;
        public TReferenceClass Gender;
        public TReferenceClass Occupation;
    }

Example Output

{
    "@odata.context": "https://seli00apm01.azure-api.net/ssli01/Learner/v3/$metadata#ContactBasics",
    "value": [
        {
            "ExternalID": "1f336494-04e6-47bc-9026-e2f065816325",
            "Forename": "Filomena",
            "Surname": "Zanni",
            "MiddleName": null,
            "IsTranslatorRequired": false,
            "ParentalBallot": false,
            "Honours": null,
            "Salutation": "Mrs Zanni",
            "Addressee": "Mrs F Zanni",
            "PlaceOfWork": null,
            "JobTitle": null,
            "Title": {
                "ExternalID": "f5a9c166-55d4-4dce-b7d2-9ec60bd5e4e4",
                "Type": "Learner.Lookup.Title"
            },
            "HomeLanguage": {
                "ExternalID": "94407bc6-1294-4e04-9432-e0bb2e6ea0ba",
                "Type": "Learner.Lookup.Language"
            },
            "Gender": {
                "ExternalID": "e471b9a3-088b-4f96-a155-60f9fad732ae",
                "Type": "Learner.Lookup.Gender"
            },
            "Occupation": {
                "ExternalID": "91580e00-bc85-41ae-9581-2cecf389a2ea",
                "Type": "Learner.Lookup.Occupation"
            }
        },