GET api/Student/UnitEnrolments?cid={cid}&cattempt={cattempt}&subid={subid}&subattempt={subattempt}&uid={uid}

Get student subject and unit activity enrolment information list. This will be used other course type, except HigherED course type only. SubjectOutcome,SubjectGrade,SubjectMarks,UnitGrade,UnitCompetency,UnitMarks:- Value can be empty if the user set a date at which the Final Grades will automatically be released to Students.

Request Information

URI Parameters

Name	Description	Type	Additional information
cid	Unique course code that student enrolled and is studying. Use this field to do filter by course.	string	None.
cattempt	Attempt of student course enrolled and studied. Expecting whole positive number (1, 2, 3,...)	integer	None.
subid	Specific subject id	string	None.
subattempt	Attempt of student subject enrolled and studied. Expecting whole positive number (1, 2, 3,...)	integer	None.
uid	Specific unit id	string	None.

Body Parameters

None.

Response Information

Resource Description

Collection of StdUnitEnrolmentModels

Name	Description	Type	Additional information
StudentId	Unique RTO student identifier	string	Required
CourseId	Unique course code that student enrolled and is studying. Use this field to do filter by course.	string	Required
NTISCourseCode	Standard national course/qualification code. Use this field to display.	string	Required
CourseName	Course/qualification name	string	None.
CourseAttempt	Attempt of student course enrolled and studied	integer	Required
SubjectId	Unique subject code that student enrolled and is studying	string	Required
SubjectName	Subject name	string	Required
SubjectAttempt	Attempt of student subject enrolled and studied	integer	Required
SubjectStartDate	Student subject activity start date	date	Required Data type: Date
SubjectFinishDate	Student subject activity finish date	date	Required Data type: Date
Batch	Class timetable batch name. Default value is 'No Batch', representing not enrolled into any class timetable.	string	Required
SubjectOutcome	Subject final outcome. Default value is 'Enrolled', representing just enrolled and no assessment outcome yet.	string	Required
SubjectGrade	Subject final marking grade. Default value is 'Enrolled'	string	Required
SubjectMarks	Subject final marks text. Value can be empty.	string	None.
UnitId	Unique unit id that student enrolled and is studying under associated subject	string	Required
NTISUnitCode	Standard national unit of competency code	string	Required
UnitName	Unit name	string	Required
UnitCompetency	Unit final outcome. Default value is 'Enrolled', representing just enrolled and no assessment outcome yet.	string	Required
UnitGrade	Unit final marking grade. Default value is 'Enrolled'	string	Required
UnitMarks	Unit final marks text. Value can be empty.	string	None.
UnitStartDate	Student unit activity start date	date	Required Data type: Date
UnitFinishDate	Student unit activity finish date	date	Required Data type: Date

Response Formats

application/json, text/json

Sample:

[
  {
    "StudentId": "sample string 1",
    "CourseId": "sample string 2",
    "NTISCourseCode": "sample string 3",
    "CourseName": "sample string 4",
    "CourseAttempt": 5,
    "SubjectId": "sample string 6",
    "SubjectName": "sample string 7",
    "SubjectAttempt": 8,
    "SubjectStartDate": "2025-04-27T00:11:19.5802549+10:00",
    "SubjectFinishDate": "2025-04-27T00:11:19.5802549+10:00",
    "Batch": "sample string 11",
    "SubjectOutcome": "sample string 12",
    "SubjectGrade": "sample string 13",
    "SubjectMarks": "sample string 14",
    "UnitId": "sample string 15",
    "NTISUnitCode": "sample string 16",
    "UnitName": "sample string 17",
    "UnitCompetency": "sample string 18",
    "UnitGrade": "sample string 19",
    "UnitMarks": "sample string 20",
    "UnitStartDate": "2025-04-27T00:11:19.5802549+10:00",
    "UnitFinishDate": "2025-04-27T00:11:19.5802549+10:00"
  },
  {
    "StudentId": "sample string 1",
    "CourseId": "sample string 2",
    "NTISCourseCode": "sample string 3",
    "CourseName": "sample string 4",
    "CourseAttempt": 5,
    "SubjectId": "sample string 6",
    "SubjectName": "sample string 7",
    "SubjectAttempt": 8,
    "SubjectStartDate": "2025-04-27T00:11:19.5802549+10:00",
    "SubjectFinishDate": "2025-04-27T00:11:19.5802549+10:00",
    "Batch": "sample string 11",
    "SubjectOutcome": "sample string 12",
    "SubjectGrade": "sample string 13",
    "SubjectMarks": "sample string 14",
    "UnitId": "sample string 15",
    "NTISUnitCode": "sample string 16",
    "UnitName": "sample string 17",
    "UnitCompetency": "sample string 18",
    "UnitGrade": "sample string 19",
    "UnitMarks": "sample string 20",
    "UnitStartDate": "2025-04-27T00:11:19.5802549+10:00",
    "UnitFinishDate": "2025-04-27T00:11:19.5802549+10:00"
  }
]

application/xml, text/xml

Sample:

<ArrayOfStdUnitEnrolmentModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileApp_WebAPI.Models.Students">
  <StdUnitEnrolmentModels>
    <Batch>sample string 11</Batch>
    <CourseAttempt>5</CourseAttempt>
    <CourseId>sample string 2</CourseId>
    <CourseName>sample string 4</CourseName>
    <NTISCourseCode>sample string 3</NTISCourseCode>
    <NTISUnitCode>sample string 16</NTISUnitCode>
    <StudentId>sample string 1</StudentId>
    <SubjectAttempt>8</SubjectAttempt>
    <SubjectFinishDate>2025-04-27T00:11:19.5802549+10:00</SubjectFinishDate>
    <SubjectGrade>sample string 13</SubjectGrade>
    <SubjectId>sample string 6</SubjectId>
    <SubjectMarks>sample string 14</SubjectMarks>
    <SubjectName>sample string 7</SubjectName>
    <SubjectOutcome>sample string 12</SubjectOutcome>
    <SubjectStartDate>2025-04-27T00:11:19.5802549+10:00</SubjectStartDate>
    <UnitCompetency>sample string 18</UnitCompetency>
    <UnitFinishDate>2025-04-27T00:11:19.5802549+10:00</UnitFinishDate>
    <UnitGrade>sample string 19</UnitGrade>
    <UnitId>sample string 15</UnitId>
    <UnitMarks>sample string 20</UnitMarks>
    <UnitName>sample string 17</UnitName>
    <UnitStartDate>2025-04-27T00:11:19.5802549+10:00</UnitStartDate>
  </StdUnitEnrolmentModels>
  <StdUnitEnrolmentModels>
    <Batch>sample string 11</Batch>
    <CourseAttempt>5</CourseAttempt>
    <CourseId>sample string 2</CourseId>
    <CourseName>sample string 4</CourseName>
    <NTISCourseCode>sample string 3</NTISCourseCode>
    <NTISUnitCode>sample string 16</NTISUnitCode>
    <StudentId>sample string 1</StudentId>
    <SubjectAttempt>8</SubjectAttempt>
    <SubjectFinishDate>2025-04-27T00:11:19.5802549+10:00</SubjectFinishDate>
    <SubjectGrade>sample string 13</SubjectGrade>
    <SubjectId>sample string 6</SubjectId>
    <SubjectMarks>sample string 14</SubjectMarks>
    <SubjectName>sample string 7</SubjectName>
    <SubjectOutcome>sample string 12</SubjectOutcome>
    <SubjectStartDate>2025-04-27T00:11:19.5802549+10:00</SubjectStartDate>
    <UnitCompetency>sample string 18</UnitCompetency>
    <UnitFinishDate>2025-04-27T00:11:19.5802549+10:00</UnitFinishDate>
    <UnitGrade>sample string 19</UnitGrade>
    <UnitId>sample string 15</UnitId>
    <UnitMarks>sample string 20</UnitMarks>
    <UnitName>sample string 17</UnitName>
    <UnitStartDate>2025-04-27T00:11:19.5802549+10:00</UnitStartDate>
  </StdUnitEnrolmentModels>
</ArrayOfStdUnitEnrolmentModels>