GET api/SemesterList

Returns a summary list of all semesters in your database. This list is searchable using the OData protocol.

Request Information

URI Parameters

None.

Body Parameters

None.

Response Information

Resource Description

Collection of SemesterList
NameDescriptionTypeAdditional information
SemesterId

integer

None.

UnitId

integer

None.

Description

string

None.

StartDate

date

None.

EndDate

date

None.

RegistrationFee

decimal number

None.

CancellationFee

decimal number

None.

OnlineRegistrationCapPercent

integer

None.

OnlineRegistrationOpenTime

date

None.

CreateDate

date

None.

IsOpen

boolean

None.

IsCurrentlyOnline

boolean

None.

CancellationFeeIsTaxable

boolean

None.

CancellationFeeTaxRate

decimal number

None.

RegistrationFeeIsTaxable

boolean

None.

RegistrationFeeTaxRate

decimal number

None.

SemesterType

SemesterType

None.

Links

Collection of Link

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "SemesterId": 1,
    "UnitId": 2,
    "Description": "sample string 3",
    "StartDate": "2026-04-04T00:29:44.9215114-07:00",
    "EndDate": "2026-04-04T00:29:44.9215114-07:00",
    "RegistrationFee": 1.0,
    "CancellationFee": 1.0,
    "OnlineRegistrationCapPercent": 1,
    "OnlineRegistrationOpenTime": "2026-04-04T00:29:44.9215114-07:00",
    "CreateDate": "2026-04-04T00:29:44.9215114-07:00",
    "IsOpen": true,
    "IsCurrentlyOnline": true,
    "CancellationFeeIsTaxable": true,
    "CancellationFeeTaxRate": 1.0,
    "RegistrationFeeIsTaxable": true,
    "RegistrationFeeTaxRate": 1.0,
    "SemesterType": {
      "SemesterTypeId": 1,
      "Description": "sample string 2",
      "IsActive": true,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  },
  {
    "SemesterId": 1,
    "UnitId": 2,
    "Description": "sample string 3",
    "StartDate": "2026-04-04T00:29:44.9215114-07:00",
    "EndDate": "2026-04-04T00:29:44.9215114-07:00",
    "RegistrationFee": 1.0,
    "CancellationFee": 1.0,
    "OnlineRegistrationCapPercent": 1,
    "OnlineRegistrationOpenTime": "2026-04-04T00:29:44.9215114-07:00",
    "CreateDate": "2026-04-04T00:29:44.9215114-07:00",
    "IsOpen": true,
    "IsCurrentlyOnline": true,
    "CancellationFeeIsTaxable": true,
    "CancellationFeeTaxRate": 1.0,
    "RegistrationFeeIsTaxable": true,
    "RegistrationFeeTaxRate": 1.0,
    "SemesterType": {
      "SemesterTypeId": 1,
      "Description": "sample string 2",
      "IsActive": true,
      "Links": [
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        },
        {
          "Rel": "sample string 1",
          "Href": "sample string 2",
          "Title": "sample string 3",
          "Type": "sample string 4"
        }
      ]
    },
    "Links": [
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      },
      {
        "Rel": "sample string 1",
        "Href": "sample string 2",
        "Title": "sample string 3",
        "Type": "sample string 4"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfSemesterList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ProClassApi.Web.Api.Models">
  <SemesterList>
    <CancellationFee>1</CancellationFee>
    <CancellationFeeIsTaxable>true</CancellationFeeIsTaxable>
    <CancellationFeeTaxRate>1</CancellationFeeTaxRate>
    <CreateDate>2026-04-04T00:29:44.9215114-07:00</CreateDate>
    <Description>sample string 3</Description>
    <EndDate>2026-04-04T00:29:44.9215114-07:00</EndDate>
    <IsCurrentlyOnline>true</IsCurrentlyOnline>
    <IsOpen>true</IsOpen>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <OnlineRegistrationCapPercent>1</OnlineRegistrationCapPercent>
    <OnlineRegistrationOpenTime>2026-04-04T00:29:44.9215114-07:00</OnlineRegistrationOpenTime>
    <RegistrationFee>1</RegistrationFee>
    <RegistrationFeeIsTaxable>true</RegistrationFeeIsTaxable>
    <RegistrationFeeTaxRate>1</RegistrationFeeTaxRate>
    <SemesterId>1</SemesterId>
    <SemesterType>
      <Description>sample string 2</Description>
      <IsActive>true</IsActive>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <SemesterTypeId>1</SemesterTypeId>
    </SemesterType>
    <StartDate>2026-04-04T00:29:44.9215114-07:00</StartDate>
    <UnitId>2</UnitId>
  </SemesterList>
  <SemesterList>
    <CancellationFee>1</CancellationFee>
    <CancellationFeeIsTaxable>true</CancellationFeeIsTaxable>
    <CancellationFeeTaxRate>1</CancellationFeeTaxRate>
    <CreateDate>2026-04-04T00:29:44.9215114-07:00</CreateDate>
    <Description>sample string 3</Description>
    <EndDate>2026-04-04T00:29:44.9215114-07:00</EndDate>
    <IsCurrentlyOnline>true</IsCurrentlyOnline>
    <IsOpen>true</IsOpen>
    <Links>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
      <Link>
        <Href>sample string 2</Href>
        <Rel>sample string 1</Rel>
        <Title>sample string 3</Title>
        <Type>sample string 4</Type>
      </Link>
    </Links>
    <OnlineRegistrationCapPercent>1</OnlineRegistrationCapPercent>
    <OnlineRegistrationOpenTime>2026-04-04T00:29:44.9215114-07:00</OnlineRegistrationOpenTime>
    <RegistrationFee>1</RegistrationFee>
    <RegistrationFeeIsTaxable>true</RegistrationFeeIsTaxable>
    <RegistrationFeeTaxRate>1</RegistrationFeeTaxRate>
    <SemesterId>1</SemesterId>
    <SemesterType>
      <Description>sample string 2</Description>
      <IsActive>true</IsActive>
      <Links>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
        <Link>
          <Href>sample string 2</Href>
          <Rel>sample string 1</Rel>
          <Title>sample string 3</Title>
          <Type>sample string 4</Type>
        </Link>
      </Links>
      <SemesterTypeId>1</SemesterTypeId>
    </SemesterType>
    <StartDate>2026-04-04T00:29:44.9215114-07:00</StartDate>
    <UnitId>2</UnitId>
  </SemesterList>
</ArrayOfSemesterList>