GET api/v1/general/courseInstance

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
CourseLengthMappingId	integer	Required
YearId	integer	None.
Status	byte	Required
FacultyId	integer	None.
WeekDay	byte	None.
StartTime	time interval	None.
EndTime	time interval	None.
MaxNumberOfStudents	integer	None.
WaitingListCapacity	integer	None.
CurrentNumberOfRegisteredStudents	decimal number	None.
CurrentNumberOfAcceptedStudents	decimal number	None.
CurrentNumberOfMovedYearStudents	decimal number	None.
CurrentInWaitingList	integer	None.
LocationId	integer	None.
FacultyCourseInstanceMapping	Collection of FacultyCourseInstanceMappingModel	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CourseLengthMappingId": 2,
  "YearId": 3,
  "Status": 64,
  "FacultyId": 1,
  "WeekDay": 64,
  "StartTime": "00:00:00.1234567",
  "EndTime": "00:00:00.1234567",
  "MaxNumberOfStudents": 1,
  "WaitingListCapacity": 1,
  "CurrentNumberOfRegisteredStudents": 1.0,
  "CurrentNumberOfAcceptedStudents": 1.0,
  "CurrentNumberOfMovedYearStudents": 1.0,
  "CurrentInWaitingList": 5,
  "LocationId": 1,
  "FacultyCourseInstanceMapping": [
    {
      "Id": 1,
      "FacultyId": 2,
      "CourseInstanceId": 3,
      "PositionPercentage": 4,
      "ToDisplay": true
    },
    {
      "Id": 1,
      "FacultyId": 2,
      "CourseInstanceId": 3,
      "PositionPercentage": 4,
      "ToDisplay": true
    }
  ]
}

application/xml, text/xml

Sample:

<CourseInstanceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Emalogic.Conservatory.Common.Models">
  <CourseLengthMappingId>2</CourseLengthMappingId>
  <CurrentInWaitingList>5</CurrentInWaitingList>
  <CurrentNumberOfAcceptedStudents>1</CurrentNumberOfAcceptedStudents>
  <CurrentNumberOfMovedYearStudents>1</CurrentNumberOfMovedYearStudents>
  <CurrentNumberOfRegisteredStudents>1</CurrentNumberOfRegisteredStudents>
  <EndTime>PT0.1234567S</EndTime>
  <FacultyCourseInstanceMapping>
    <FacultyCourseInstanceMappingModel>
      <CourseInstanceId>3</CourseInstanceId>
      <FacultyId>2</FacultyId>
      <Id>1</Id>
      <PositionPercentage>4</PositionPercentage>
      <ToDisplay>true</ToDisplay>
    </FacultyCourseInstanceMappingModel>
    <FacultyCourseInstanceMappingModel>
      <CourseInstanceId>3</CourseInstanceId>
      <FacultyId>2</FacultyId>
      <Id>1</Id>
      <PositionPercentage>4</PositionPercentage>
      <ToDisplay>true</ToDisplay>
    </FacultyCourseInstanceMappingModel>
  </FacultyCourseInstanceMapping>
  <FacultyId>1</FacultyId>
  <Id>1</Id>
  <LocationId>1</LocationId>
  <MaxNumberOfStudents>1</MaxNumberOfStudents>
  <StartTime>PT0.1234567S</StartTime>
  <Status>64</Status>
  <WaitingListCapacity>1</WaitingListCapacity>
  <WeekDay>64</WeekDay>
  <YearId>3</YearId>
</CourseInstanceModel>

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 'CourseInstanceModel'.

Response Information

Resource Description

Collection of CourseInstanceModel

Name	Type	Additional information
Id	integer	None.
CourseLengthMappingId	integer	Required
YearId	integer	None.
Status	byte	Required
FacultyId	integer	None.
WeekDay	byte	None.
StartTime	time interval	None.
EndTime	time interval	None.
MaxNumberOfStudents	integer	None.
WaitingListCapacity	integer	None.
CurrentNumberOfRegisteredStudents	decimal number	None.
CurrentNumberOfAcceptedStudents	decimal number	None.
CurrentNumberOfMovedYearStudents	decimal number	None.
CurrentInWaitingList	integer	None.
LocationId	integer	None.
FacultyCourseInstanceMapping	Collection of FacultyCourseInstanceMappingModel	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "Id": 1,
    "CourseLengthMappingId": 2,
    "YearId": 3,
    "Status": 64,
    "FacultyId": 1,
    "WeekDay": 64,
    "StartTime": "00:00:00.1234567",
    "EndTime": "00:00:00.1234567",
    "MaxNumberOfStudents": 1,
    "WaitingListCapacity": 1,
    "CurrentNumberOfRegisteredStudents": 1.0,
    "CurrentNumberOfAcceptedStudents": 1.0,
    "CurrentNumberOfMovedYearStudents": 1.0,
    "CurrentInWaitingList": 5,
    "LocationId": 1,
    "FacultyCourseInstanceMapping": [
      {
        "Id": 1,
        "FacultyId": 2,
        "CourseInstanceId": 3,
        "PositionPercentage": 4,
        "ToDisplay": true
      },
      {
        "Id": 1,
        "FacultyId": 2,
        "CourseInstanceId": 3,
        "PositionPercentage": 4,
        "ToDisplay": true
      }
    ]
  },
  {
    "Id": 1,
    "CourseLengthMappingId": 2,
    "YearId": 3,
    "Status": 64,
    "FacultyId": 1,
    "WeekDay": 64,
    "StartTime": "00:00:00.1234567",
    "EndTime": "00:00:00.1234567",
    "MaxNumberOfStudents": 1,
    "WaitingListCapacity": 1,
    "CurrentNumberOfRegisteredStudents": 1.0,
    "CurrentNumberOfAcceptedStudents": 1.0,
    "CurrentNumberOfMovedYearStudents": 1.0,
    "CurrentInWaitingList": 5,
    "LocationId": 1,
    "FacultyCourseInstanceMapping": [
      {
        "Id": 1,
        "FacultyId": 2,
        "CourseInstanceId": 3,
        "PositionPercentage": 4,
        "ToDisplay": true
      },
      {
        "Id": 1,
        "FacultyId": 2,
        "CourseInstanceId": 3,
        "PositionPercentage": 4,
        "ToDisplay": true
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfCourseInstanceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Emalogic.Conservatory.Common.Models">
  <CourseInstanceModel>
    <CourseLengthMappingId>2</CourseLengthMappingId>
    <CurrentInWaitingList>5</CurrentInWaitingList>
    <CurrentNumberOfAcceptedStudents>1</CurrentNumberOfAcceptedStudents>
    <CurrentNumberOfMovedYearStudents>1</CurrentNumberOfMovedYearStudents>
    <CurrentNumberOfRegisteredStudents>1</CurrentNumberOfRegisteredStudents>
    <EndTime>PT0.1234567S</EndTime>
    <FacultyCourseInstanceMapping>
      <FacultyCourseInstanceMappingModel>
        <CourseInstanceId>3</CourseInstanceId>
        <FacultyId>2</FacultyId>
        <Id>1</Id>
        <PositionPercentage>4</PositionPercentage>
        <ToDisplay>true</ToDisplay>
      </FacultyCourseInstanceMappingModel>
      <FacultyCourseInstanceMappingModel>
        <CourseInstanceId>3</CourseInstanceId>
        <FacultyId>2</FacultyId>
        <Id>1</Id>
        <PositionPercentage>4</PositionPercentage>
        <ToDisplay>true</ToDisplay>
      </FacultyCourseInstanceMappingModel>
    </FacultyCourseInstanceMapping>
    <FacultyId>1</FacultyId>
    <Id>1</Id>
    <LocationId>1</LocationId>
    <MaxNumberOfStudents>1</MaxNumberOfStudents>
    <StartTime>PT0.1234567S</StartTime>
    <Status>64</Status>
    <WaitingListCapacity>1</WaitingListCapacity>
    <WeekDay>64</WeekDay>
    <YearId>3</YearId>
  </CourseInstanceModel>
  <CourseInstanceModel>
    <CourseLengthMappingId>2</CourseLengthMappingId>
    <CurrentInWaitingList>5</CurrentInWaitingList>
    <CurrentNumberOfAcceptedStudents>1</CurrentNumberOfAcceptedStudents>
    <CurrentNumberOfMovedYearStudents>1</CurrentNumberOfMovedYearStudents>
    <CurrentNumberOfRegisteredStudents>1</CurrentNumberOfRegisteredStudents>
    <EndTime>PT0.1234567S</EndTime>
    <FacultyCourseInstanceMapping>
      <FacultyCourseInstanceMappingModel>
        <CourseInstanceId>3</CourseInstanceId>
        <FacultyId>2</FacultyId>
        <Id>1</Id>
        <PositionPercentage>4</PositionPercentage>
        <ToDisplay>true</ToDisplay>
      </FacultyCourseInstanceMappingModel>
      <FacultyCourseInstanceMappingModel>
        <CourseInstanceId>3</CourseInstanceId>
        <FacultyId>2</FacultyId>
        <Id>1</Id>
        <PositionPercentage>4</PositionPercentage>
        <ToDisplay>true</ToDisplay>
      </FacultyCourseInstanceMappingModel>
    </FacultyCourseInstanceMapping>
    <FacultyId>1</FacultyId>
    <Id>1</Id>
    <LocationId>1</LocationId>
    <MaxNumberOfStudents>1</MaxNumberOfStudents>
    <StartTime>PT0.1234567S</StartTime>
    <Status>64</Status>
    <WaitingListCapacity>1</WaitingListCapacity>
    <WeekDay>64</WeekDay>
    <YearId>3</YearId>
  </CourseInstanceModel>
</ArrayOfCourseInstanceModel>