SIMS 8 - V3 - LearnerRegistrations

Example URL

Live URL: https://seli00apm01.azure-api.net/ssli01/Learner/V3/LearnerRegistrations

Prep URL: https://sepr00apm01.azure-api.net/sspr01/Learner/V3/LearnerRegistrations

Sample Output

{
  "@odata.context": "https://sepr00apm01.azure-api.net/sspr01/Learner/V3/$metadata#LearnerRegistrations",
  "value": [
    {
      "ExternalID": "ecec5066-8af4-4e77-a203-525b2e8e90d0",
      "AdmissionNumber": "001372",
      "UniquePupilNumber": "J823299913037",
      "UniqueLearnerNumber": null,
      "LocalUPN": null,
      "IsEducatedAtAnotherSiteButNotInASchool": false
    },
    {
      "ExternalID": "e2fc34f4-a8a0-4d40-b0b0-41d7881d73b2",
      "AdmissionNumber": "000998",
      "UniquePupilNumber": "Z820200106077",
      "UniqueLearnerNumber": null,
      "LocalUPN": null,
      "IsEducatedAtAnotherSiteButNotInASchool": false
    },

Sample Classes

using System;
using System.Collections.Generic;
using System.Text;

namespace TISIMS8DataStructureExamples
{
    public class TLearnerRegistrations
    {
        public Guid ExternalID;
        public string AdmissionNumber;
        public string UniquePupilNumber;
        public string UniqueLearnerNumber;
        public string LocalUPN;
        public Nullable<bool> IsEducatedAtAnotherSiteButNotInASchool;
        public List<TLearnerEnrolment> Enrolments;
        public List<TLearnerBoarderStatus> BoarderStatuses;
        public List<TLearnerPartTimeRecord> PartTimeRecords;
        public List<TLearnerUPNHistory> UPNHistory;

    }
    public class TLearnerEnrolment
    {
        public Guid ExternalID;
        public Nullable<DateTime> DateOfAdmission;
        public Nullable<DateTime> DateOfLeaviing;
        public Nullable<DateTime> DestinationStartDate;
        public string Destination;
        public TReasonForLeavingRef ReasonForLeaving;
        public TGroundsForRemovalRef GroundsForRemoval;
        public TDestinationEstablishment DestinationEstablishment;
        public List<TLearnerEnrolmentStatus> EnrolmentStatuses;
    }
    public class TLearnerEnrolmentStatus
    {
        public Guid ExternalID;
        public Nullable<DateTime> StartDate;
        public Nullable<DateTime> EndDate;
        public TEnrolmentStatusRefObj EnrolmentStatus;
    }
    public class TDestinationEstablishment
    {
        public Guid ExternalID;
    }
    public class TEnrolmentStatusRefObj
    {
        public Guid ExternalID;
        public string Type;

    }
    public class TReasonForLeavingRef
    {
        public Guid ExternalID;
        public string Type;
    }
    public class TGroundsForRemovalRef
    {
        public Guid ExternalID;
        public string Type;
    }
    public class TBoarderStatusRef
    {
        public Guid ExternalID;
        public string Type;
    }
    public class TLearnerBoarderStatus
    {
        public Guid ExternalID;
        public TBoarderStatusRef BoarderStatus;
        public Nullable<DateTime> StartDate;
        public Nullable<DateTime> EndDate;
    }
    public class TLearnerPartTimeRecord
    {
        public Guid ExternalID;
        public Nullable<DateTime> StartDate;
        public Nullable<DateTime> EndDate;
    }
    public class TLearnerUPNHistory
    {
        public Guid ExternalID;
        public Nullable<DateTime> EndDate;
        public string UniquePupilNumber;
    }
}