GET api/Student/Timetables?subid={subid}&batch={batch}&day={day}&rmid={rmid}&startdate={startdate}&enddate={enddate}&classdate={classdate}&wkdates={wkdates}

Get student class timetable information list

Request Information

URI Parameters

NameDescriptionTypeAdditional information
subid

Specific subject id

string

None.
batch

Specific class batch name

string

None.
day

Specific class day of week (e.g. Monday, Tuesday, Wednesday)

string

None.
rmid

Specific class room id

string

None.
startdate

Date format (e.g. dd/mm/yyyy) to check against class start date
You can specify exact date matching by startdate=1/1/2016.
Or specify a range of date to bring all class start date under the date range (startdate=1/1/2016-28/2/2016).
Or specify a from date onward against class start date (startdate=1/1/2016-).
Or specify a last date against class start date (startdate=-28/2/2016).

string

None.
enddate

Date format (e.g. dd/mm/yyyy) to check against class finish date
You can specify exact date matching by enddate=1/1/2016.
Or specify a range of date to bring all class finish date under the date range (enddate=1/1/2016-28/2/2016).
Or specify a from date onward against class finish date (enddate=1/1/2016-).
Or specify a last date against class finish date (enddate=-28/2/2016).
It should not be used in the combination of the other date parameter.

string

None.
classdate

Class date parameter.
Exact value format is expected (e.g. dd/mm/yyyy)
This parameter will bring any class presenting on this parameter class date. Suit to work with daily timetable view.
It should not be used in the combination of the other date parameter.

string

None.
wkdates

Class week date range parameter.
Exact value format is expected (e.g. dd/mm/yyyy-dd/mm/yyyy)
This parameter will bring any class falling into this between 2 dates. Suit to work with weekly timetable view.
It should not be used in the combination of the other date parameter.

string

None.

Body Parameters

None.

Response Information

Resource Description

Collection of StdTimetableModels
NameDescriptionTypeAdditional information
CampusName

Campus name where the class activity located

string

Required
SubjectId

Unique subject code of the class timetable

string

Required
SubjectName

Subject name

string

Required
Batch

Class batch, which can be used to differentiate groups of students who study for the same campus, subject and activity period.

string

Required
Day

Indicate class day of the week

string

Required
Mode

Class mode/type, such as Lecture, Tutorial and etc.

string

Required
StartTime

Class start time of the day

time interval

Required
FinishTime

Class finish time of the day

time interval

Required
TeacherName

Teacher/Trainer/Lecturer of the class

string

Required
RoomId

Class room id

string

Required
RoomName

Class room name

string

Required
StartDate

Class start date

date

Required
FinishDate

Class end date

date

Required
VenueAddress

Training location address where the class activity located

string

Required

Response Formats

application/json, text/json

Sample: 
[
  {
    "CampusName": "sample string 1",
    "SubjectId": "sample string 2",
    "SubjectName": "sample string 3",
    "Batch": "sample string 4",
    "Day": "sample string 5",
    "Mode": "sample string 6",
    "StartTime": "00:00:00.1234567",
    "FinishTime": "00:00:00.1234567",
    "TeacherName": "sample string 9",
    "RoomId": "sample string 10",
    "RoomName": "sample string 11",
    "StartDate": "2025-04-26T23:51:42.5436417+10:00",
    "FinishDate": "2025-04-26T23:51:42.5436417+10:00",
    "VenueAddress": "sample string 14"
  },
  {
    "CampusName": "sample string 1",
    "SubjectId": "sample string 2",
    "SubjectName": "sample string 3",
    "Batch": "sample string 4",
    "Day": "sample string 5",
    "Mode": "sample string 6",
    "StartTime": "00:00:00.1234567",
    "FinishTime": "00:00:00.1234567",
    "TeacherName": "sample string 9",
    "RoomId": "sample string 10",
    "RoomName": "sample string 11",
    "StartDate": "2025-04-26T23:51:42.5436417+10:00",
    "FinishDate": "2025-04-26T23:51:42.5436417+10:00",
    "VenueAddress": "sample string 14"
  }
]

application/xml, text/xml

Sample: 
<ArrayOfStdTimetableModels xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/MobileApp_WebAPI.Models.Students">
  <StdTimetableModels>
    <Batch>sample string 4</Batch>
    <CampusName>sample string 1</CampusName>
    <Day>sample string 5</Day>
    <FinishDate>2025-04-26T23:51:42.5436417+10:00</FinishDate>
    <FinishTime>PT0.1234567S</FinishTime>
    <Mode>sample string 6</Mode>
    <RoomId>sample string 10</RoomId>
    <RoomName>sample string 11</RoomName>
    <StartDate>2025-04-26T23:51:42.5436417+10:00</StartDate>
    <StartTime>PT0.1234567S</StartTime>
    <SubjectId>sample string 2</SubjectId>
    <SubjectName>sample string 3</SubjectName>
    <TeacherName>sample string 9</TeacherName>
    <VenueAddress>sample string 14</VenueAddress>
  </StdTimetableModels>
  <StdTimetableModels>
    <Batch>sample string 4</Batch>
    <CampusName>sample string 1</CampusName>
    <Day>sample string 5</Day>
    <FinishDate>2025-04-26T23:51:42.5436417+10:00</FinishDate>
    <FinishTime>PT0.1234567S</FinishTime>
    <Mode>sample string 6</Mode>
    <RoomId>sample string 10</RoomId>
    <RoomName>sample string 11</RoomName>
    <StartDate>2025-04-26T23:51:42.5436417+10:00</StartDate>
    <StartTime>PT0.1234567S</StartTime>
    <SubjectId>sample string 2</SubjectId>
    <SubjectName>sample string 3</SubjectName>
    <TeacherName>sample string 9</TeacherName>
    <VenueAddress>sample string 14</VenueAddress>
  </StdTimetableModels>
</ArrayOfStdTimetableModels>