POST api/Timetable/GetTimetable

Request Information

URI Parameters

None.

Body Parameters

TimetableRequest
NameDescriptionTypeAdditional information
ClassSectionInstituteYearId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "ClassSectionInstituteYearId": "sample string 1"
}

text/html

Sample:
{"ClassSectionInstituteYearId":"sample string 1"}

application/xml, text/xml

Sample:
<TimetableModel.TimetableRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
  <ClassSectionInstituteYearId>sample string 1</ClassSectionInstituteYearId>
</TimetableModel.TimetableRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'TimetableRequest'.

Response Information

Resource Description

TimetableResponse
NameDescriptionTypeAdditional information
ResultFlag

string

None.

Message

string

None.

Schedule

Collection of DayObject

None.

Response Formats

application/json, text/json

Sample:
{
  "ResultFlag": "sample string 1",
  "Message": "sample string 2",
  "Schedule": [
    {
      "DayId": 1,
      "Day": "sample string 2",
      "IsHalfDay": true,
      "Lectures": [
        {
          "Subject": {
            "ShortName": "sample string 1",
            "FullName": "sample string 2"
          },
          "TeacherName": "sample string 1",
          "DurationMinutes": 2,
          "LectureType": "sample string 3",
          "PeriodOrder": 4
        },
        {
          "Subject": {
            "ShortName": "sample string 1",
            "FullName": "sample string 2"
          },
          "TeacherName": "sample string 1",
          "DurationMinutes": 2,
          "LectureType": "sample string 3",
          "PeriodOrder": 4
        }
      ]
    },
    {
      "DayId": 1,
      "Day": "sample string 2",
      "IsHalfDay": true,
      "Lectures": [
        {
          "Subject": {
            "ShortName": "sample string 1",
            "FullName": "sample string 2"
          },
          "TeacherName": "sample string 1",
          "DurationMinutes": 2,
          "LectureType": "sample string 3",
          "PeriodOrder": 4
        },
        {
          "Subject": {
            "ShortName": "sample string 1",
            "FullName": "sample string 2"
          },
          "TeacherName": "sample string 1",
          "DurationMinutes": 2,
          "LectureType": "sample string 3",
          "PeriodOrder": 4
        }
      ]
    }
  ]
}

text/html

Sample:
{"ResultFlag":"sample string 1","Message":"sample string 2","Schedule":[{"DayId":1,"Day":"sample string 2","IsHalfDay":true,"Lectures":[{"Subject":{"ShortName":"sample string 1","FullName":"sample string 2"},"TeacherName":"sample string 1","DurationMinutes":2,"LectureType":"sample string 3","PeriodOrder":4},{"Subject":{"ShortName":"sample string 1","FullName":"sample string 2"},"TeacherName":"sample string 1","DurationMinutes":2,"LectureType":"sample string 3","PeriodOrder":4}]},{"DayId":1,"Day":"sample string 2","IsHalfDay":true,"Lectures":[{"Subject":{"ShortName":"sample string 1","FullName":"sample string 2"},"TeacherName":"sample string 1","DurationMinutes":2,"LectureType":"sample string 3","PeriodOrder":4},{"Subject":{"ShortName":"sample string 1","FullName":"sample string 2"},"TeacherName":"sample string 1","DurationMinutes":2,"LectureType":"sample string 3","PeriodOrder":4}]}]}

application/xml, text/xml

Sample:
<TimetableModel.TimetableResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SmartInstituteSoftware.Models">
  <Message>sample string 2</Message>
  <ResultFlag>sample string 1</ResultFlag>
  <Schedule>
    <TimetableModel.DayObject>
      <Day>sample string 2</Day>
      <DayId>1</DayId>
      <IsHalfDay>true</IsHalfDay>
      <Lectures>
        <TimetableModel.LectureObject>
          <DurationMinutes>2</DurationMinutes>
          <LectureType>sample string 3</LectureType>
          <PeriodOrder>4</PeriodOrder>
          <Subject>
            <FullName>sample string 2</FullName>
            <ShortName>sample string 1</ShortName>
          </Subject>
          <TeacherName>sample string 1</TeacherName>
        </TimetableModel.LectureObject>
        <TimetableModel.LectureObject>
          <DurationMinutes>2</DurationMinutes>
          <LectureType>sample string 3</LectureType>
          <PeriodOrder>4</PeriodOrder>
          <Subject>
            <FullName>sample string 2</FullName>
            <ShortName>sample string 1</ShortName>
          </Subject>
          <TeacherName>sample string 1</TeacherName>
        </TimetableModel.LectureObject>
      </Lectures>
    </TimetableModel.DayObject>
    <TimetableModel.DayObject>
      <Day>sample string 2</Day>
      <DayId>1</DayId>
      <IsHalfDay>true</IsHalfDay>
      <Lectures>
        <TimetableModel.LectureObject>
          <DurationMinutes>2</DurationMinutes>
          <LectureType>sample string 3</LectureType>
          <PeriodOrder>4</PeriodOrder>
          <Subject>
            <FullName>sample string 2</FullName>
            <ShortName>sample string 1</ShortName>
          </Subject>
          <TeacherName>sample string 1</TeacherName>
        </TimetableModel.LectureObject>
        <TimetableModel.LectureObject>
          <DurationMinutes>2</DurationMinutes>
          <LectureType>sample string 3</LectureType>
          <PeriodOrder>4</PeriodOrder>
          <Subject>
            <FullName>sample string 2</FullName>
            <ShortName>sample string 1</ShortName>
          </Subject>
          <TeacherName>sample string 1</TeacherName>
        </TimetableModel.LectureObject>
      </Lectures>
    </TimetableModel.DayObject>
  </Schedule>
</TimetableModel.TimetableResponse>