DeX OData - LearnerContactDetails

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

Example Call

https://seli00apm01.azure-api.net/dex/Learner/odata/V3/LearnerContactDetails?$expand=Telephones,Addresses,Emails (DeX OData)

See here for Stem URLs for SIMS 8.

API Definition

    #region Learner Contact Details
    public class TTelephoneRef
    {
        public Guid ExternalID;
        public string TelephoneNumber;
        public Nullable<bool> IsFirstPointOfContact;
        public Nullable<bool> UseForAutomatedMessages;
        public string Notes;
        public TLocationTypeRef LocationType;
    }
    public class TEmailRef
    {
        public Guid ExternalID;
        public string EmailAddress;
        public Nullable<bool> IsMainEmail;
        public Nullable<bool> UseForAutomatedMessages;
        public string Notes;
        public TEmailLocationTypeRef LocationType;
    }
    public class TAddress
    {
        public Guid ExternalID;
        public string Apartment;
        public string BuildingNumber;
        public string BuildingName;
        public string Street;
        public string District;
        public string Town;
        public string AdministrativeArea;
        public string Postcode;
        public string CoordinateX;
        public string CoordinateY;
        public string USRN;
        public string UPRN;
        public string AddressIdentifier;
        public Nullable<DateTime> LastValidated;
        public TCountryRef Country;
        public TResourceProviderRef ResourceProvider;
    }
    public class TLearnerContactRelationshipTypeRef : TReferenceClass  { }
    public class TLearnerContactDetail : TReferenceClass {}
    public class TLearnerContactRelationship
    {
        public Guid ExternalID;
        public Nullable<bool> HasCourtOrder;
        public Nullable<bool> HasParentalResponsibility;
        public Nullable<bool> ReceivesCorrespondance;
        public Nullable<bool> ReceivesSchoolReport;
        public Nullable<int> Priority;
        public TLearnerContactRelationshipTypeRef LearnerContactRelationshipType;
        public TLearnerContactDetail LearnerContact;
    }
    public class TLearnerContactDetails
    {
        public Guid ExternalID;
        public string ParentalSalutation;
        public string ParentalAddressee;
        public Nullable<bool> IsMailingPoint;
        public List<TLearnerContactRelationship> LearnerContactRelationships;
        public List<TAddress> Addresses;

        public List<TTelephoneRef> Telephones;
        public List<TEmailRef> Emails;
    }
    public class TLocationTypeRef : TReferenceClass { }

    public class TCountryRef : TReferenceClass { }
    public class TEmailLocationTypeRef : TReferenceClass { }
    #endregion

Example Output

{
    "@odata.context": "https://sims8live01.westeurope.cloudapp.azure.com:8443/LearnerServiceFarm1/odata/v3/$metadata#LearnerContactDetails",
    "value": [
        {
            "ExternalID": "2abf0a69-0dd1-468b-8b6e-3319675a6a84",
            "ParentalSalutation": "Ms YATES",
            "ParentalAddressee": "Ms J YATES",
            "IsMailingPoint": false,
            "Telephones": [
                {
                    "ExternalID": "a97443d8-92ee-4400-8180-07772dff2fd6",
                    "TelephoneNumber": "01632 3",
                    "IsFirstPointOfContact": true,
                    "UseForAutomatedMessages": false,
                    "Notes": null,
                    "LocationType": {
                        "ExternalID": "f7ae272b-cce9-4bad-9818-8605db13cf29",
                        "Type": "Learner.Lookup.LocationType"
                    }
                }
            ],
            "Addresses": [],
            "Emails": []
        },
        {
            "ExternalID": "c32e495c-6f21-4f02-97a3-ebf5b3c74dda",
            "ParentalSalutation": "Mrs P HARVEY",
            "ParentalAddressee": null,
            "IsMailingPoint": true,
            "Telephones": [
                {
                    "ExternalID": "73d72fcc-76e3-40c6-8149-92dab0d9b95c",
                    "TelephoneNumber": "01632 2",
                    "IsFirstPointOfContact": true,
                    "UseForAutomatedMessages": false,
                    "Notes": null,
                    "LocationType": {
                        "ExternalID": "f7ae272b-cce9-4bad-9818-8605db13cf29",
                        "Type": "Learner.Lookup.LocationType"
                    }
                }
            ],
            "Addresses": [],
            "Emails": []
        },