© 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 Welfares Information Domain

Example Call

https://seli00apm01.azure-api.net/dex/Learner/odata//V3/LearnerWelfares?$expand=ChildProtectionPlans,InCareDetails,PersonalEducationPlans

See here for Stem URLs for SIMS 8.

API Definition

// Root myDeserializedClass = JsonConvert.DeserializeObject<Root>(myJsonResponse); 
// Auto generated
    public class Value
    {
        [JsonProperty("@odata.type")]
        public string OdataType { get; set; }
        public string ExternalID { get; set; }
        public object ServiceChild { get; set; }
        public object ServiceChildSource { get; set; }
        public List<object> ChildProtectionPlans { get; set; }
        public List<object> InCareDetails { get; set; }
        public List<object> PersonalEducationPlans { get; set; }
    }

    public class Root
    {
        [JsonProperty("@odata.context")]
        public string OdataContext { get; set; }
        public List<Value> value { get; set; }

        [JsonProperty("@odata.nextLink")]
        public string OdataNextLink { get; set; }
    }

Example Output

{
            "@odata.type": "#ESS.Learner.V3.LearnerWelfare",
            "ExternalID": "45dca6ec-3f61-4680-9da3-1cce8dc6a9a2",
            "ServiceChild": null,
            "ServiceChildSource": null,
            "ChildProtectionPlans": [],
            "InCareDetails": [
                {
                    "@odata.type": "#ESS.Learner.V3.InCareDetail",
                    "ExternalID": "1e26da22-625e-4ad4-9225-9209dd49c4e5",
                    "StartDate": "2019-06-21T00:00:00Z",
                    "EndDate": null,
                    "CareAuthority": {
                        "ExternalID": "fa715387-1743-4fc7-99c1-6d243e3bd84b",
                        "Type": "Learner.Lookup.CareAuthority"
                    }
                }
            ],
            "PersonalEducationPlans": [
                {
                    "@odata.type": "#ESS.Learner.V3.PersonalEducationPlan",
                    "ExternalID": "6e846634-297b-4cc6-aff4-cc944a3ae3f5",
                    "StartDate": "2019-09-02T00:00:00Z",
                    "EndDate": null,
                    "InCareDetail": "1e26da22-625e-4ad4-9225-9209dd49c4e5"
                }
            ]
        }