GET api/Course?baseCourseId={baseCourseId}&effectiveDate={effectiveDate}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
baseCourseId

globally unique identifier

Required

effectiveDate

date

None.

Body Parameters

None.

Response Information

Resource Description

Course
NameDescriptionTypeAdditional information
ScheduledHours

integer

None.

VisualIdentity

string

None.

FormattedCode

string

None.

Title

string

None.

Credits

integer

None.

Passmark

integer

None.

Goal

string

None.

IsFrench

boolean

None.

Description

string

None.

GradingBasisId

integer

None.

Lecture

integer

None.

Laboratory

integer

None.

FieldStudy

integer

None.

IndependentStudy

integer

None.

Status

integer

None.

EffectiveDate

date

None.

ParticularRequirement

string

None.

PrerequisiteNotes

string

None.

NominalHours

integer

None.

ShortTitle

string

None.

CoopPlacement

integer

None.

CareerId

integer

None.

BaseCourseId

globally unique identifier

None.

IsFastTrack

boolean

None.

SubjectArea

SubjectArea

None.

Resources

Collection of Resource

None.

Contents

Collection of Content

None.

ContentType

ContentType

None.

Prerequisites

Collection of Prerequisite

None.

GeneralObjectives

Collection of CourseGeneralObjective

None.

Id

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "FormattedCode": "sample string 1",
  "Title": "sample string 2",
  "Credits": 3,
  "Passmark": 4,
  "Goal": "sample string 5",
  "IsFrench": true,
  "Description": "sample string 7",
  "GradingBasisId": 8,
  "Lecture": 9,
  "Laboratory": 10,
  "FieldStudy": 11,
  "IndependentStudy": 12,
  "Status": 13,
  "EffectiveDate": "2025-05-03T01:58:13.78386-03:00",
  "ParticularRequirement": "sample string 15",
  "PrerequisiteNotes": "sample string 16",
  "NominalHours": 17,
  "ShortTitle": "sample string 18",
  "CoopPlacement": 19,
  "CareerId": 20,
  "BaseCourseId": "6808154f-555c-4412-8ca3-06892e3a2387",
  "IsFastTrack": true,
  "SubjectArea": {
    "SubjectAreaId": 1,
    "AlphaCode": "sample string 2",
    "EName": "sample string 3",
    "FName": "sample string 4",
    "EDescription": "sample string 5",
    "FDescription": "sample string 6",
    "Discipline": {
      "DisciplineId": 1,
      "Code": "sample string 2",
      "EName": "sample string 3",
      "FName": "sample string 4",
      "Cluster": {
        "ClusterId": 1,
        "Code": "sample string 2",
        "EName": "sample string 3",
        "FName": "sample string 4",
        "VisualIdentity": "sample string 2 - sample string 3"
      },
      "VisualIdentity": "sample string 2 - sample string 3"
    },
    "VisualIdentity": "sample string 2 - sample string 3"
  },
  "Resources": null,
  "Contents": [
    {
      "Description": "sample string 1",
      "DisplayOrder": 2
    },
    {
      "Description": "sample string 1",
      "DisplayOrder": 2
    }
  ],
  "ContentType": 1,
  "Prerequisites": [
    {
      "FormattedCode": "sample string 1",
      "Corequisite": true,
      "Alternates": [
        {
          "FormattedCode": "sample string 1"
        },
        {
          "FormattedCode": "sample string 1"
        }
      ]
    },
    {
      "FormattedCode": "sample string 1",
      "Corequisite": true,
      "Alternates": [
        {
          "FormattedCode": "sample string 1"
        },
        {
          "FormattedCode": "sample string 1"
        }
      ]
    }
  ],
  "GeneralObjectives": [
    {
      "Title": "sample string 1",
      "IsEssentialSkill": true,
      "DisplayOrder": 3,
      "SpecificObjectives": [
        {
          "Title": "sample string 1",
          "DisplayOrder": 2,
          "IsAbility": true
        },
        {
          "Title": "sample string 1",
          "DisplayOrder": 2,
          "IsAbility": true
        }
      ]
    },
    {
      "Title": "sample string 1",
      "IsEssentialSkill": true,
      "DisplayOrder": 3,
      "SpecificObjectives": [
        {
          "Title": "sample string 1",
          "DisplayOrder": 2,
          "IsAbility": true
        },
        {
          "Title": "sample string 1",
          "DisplayOrder": 2,
          "IsAbility": true
        }
      ]
    }
  ],
  "Id": "772f2155-ecfd-4edb-912a-21d1284abeb9",
  "ScheduledHours": 49,
  "VisualIdentity": "sample string 1 sample string 2 2025-05-03"
}

application/xml, text/xml

Sample:
<Course xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDMS.REST.Models">
  <Id>772f2155-ecfd-4edb-912a-21d1284abeb9</Id>
  <BaseCourseId>6808154f-555c-4412-8ca3-06892e3a2387</BaseCourseId>
  <CareerId>20</CareerId>
  <ContentType>Objective</ContentType>
  <Contents>
    <Content>
      <Description>sample string 1</Description>
      <DisplayOrder>2</DisplayOrder>
    </Content>
    <Content>
      <Description>sample string 1</Description>
      <DisplayOrder>2</DisplayOrder>
    </Content>
  </Contents>
  <CoopPlacement>19</CoopPlacement>
  <Credits>3</Credits>
  <Description>sample string 7</Description>
  <EffectiveDate>2025-05-03T01:58:13.78386-03:00</EffectiveDate>
  <FieldStudy>11</FieldStudy>
  <FormattedCode>sample string 1</FormattedCode>
  <GeneralObjectives>
    <CourseGeneralObjective>
      <DisplayOrder>3</DisplayOrder>
      <IsEssentialSkill>true</IsEssentialSkill>
      <SpecificObjectives>
        <CourseSpecificObjective>
          <DisplayOrder>2</DisplayOrder>
          <IsAbility>true</IsAbility>
          <Title>sample string 1</Title>
        </CourseSpecificObjective>
        <CourseSpecificObjective>
          <DisplayOrder>2</DisplayOrder>
          <IsAbility>true</IsAbility>
          <Title>sample string 1</Title>
        </CourseSpecificObjective>
      </SpecificObjectives>
      <Title>sample string 1</Title>
    </CourseGeneralObjective>
    <CourseGeneralObjective>
      <DisplayOrder>3</DisplayOrder>
      <IsEssentialSkill>true</IsEssentialSkill>
      <SpecificObjectives>
        <CourseSpecificObjective>
          <DisplayOrder>2</DisplayOrder>
          <IsAbility>true</IsAbility>
          <Title>sample string 1</Title>
        </CourseSpecificObjective>
        <CourseSpecificObjective>
          <DisplayOrder>2</DisplayOrder>
          <IsAbility>true</IsAbility>
          <Title>sample string 1</Title>
        </CourseSpecificObjective>
      </SpecificObjectives>
      <Title>sample string 1</Title>
    </CourseGeneralObjective>
  </GeneralObjectives>
  <Goal>sample string 5</Goal>
  <GradingBasisId>8</GradingBasisId>
  <IndependentStudy>12</IndependentStudy>
  <IsFastTrack>true</IsFastTrack>
  <IsFrench>true</IsFrench>
  <Laboratory>10</Laboratory>
  <Lecture>9</Lecture>
  <NominalHours>17</NominalHours>
  <ParticularRequirement>sample string 15</ParticularRequirement>
  <Passmark>4</Passmark>
  <PrerequisiteNotes>sample string 16</PrerequisiteNotes>
  <Prerequisites>
    <Prerequisite>
      <Alternates>
        <Alternate>
          <FormattedCode>sample string 1</FormattedCode>
        </Alternate>
        <Alternate>
          <FormattedCode>sample string 1</FormattedCode>
        </Alternate>
      </Alternates>
      <Corequisite>true</Corequisite>
      <FormattedCode>sample string 1</FormattedCode>
    </Prerequisite>
    <Prerequisite>
      <Alternates>
        <Alternate>
          <FormattedCode>sample string 1</FormattedCode>
        </Alternate>
        <Alternate>
          <FormattedCode>sample string 1</FormattedCode>
        </Alternate>
      </Alternates>
      <Corequisite>true</Corequisite>
      <FormattedCode>sample string 1</FormattedCode>
    </Prerequisite>
  </Prerequisites>
  <Resources i:nil="true" />
  <ScheduledHours>49</ScheduledHours>
  <ShortTitle>sample string 18</ShortTitle>
  <Status>13</Status>
  <SubjectArea>
    <AlphaCode>sample string 2</AlphaCode>
    <Discipline>
      <Cluster>
        <ClusterId>1</ClusterId>
        <Code>sample string 2</Code>
        <EName>sample string 3</EName>
        <FName>sample string 4</FName>
        <VisualIdentity>sample string 2 - sample string 3</VisualIdentity>
      </Cluster>
      <Code>sample string 2</Code>
      <DisciplineId>1</DisciplineId>
      <EName>sample string 3</EName>
      <FName>sample string 4</FName>
      <VisualIdentity>sample string 2 - sample string 3</VisualIdentity>
    </Discipline>
    <EDescription>sample string 5</EDescription>
    <EName>sample string 3</EName>
    <FDescription>sample string 6</FDescription>
    <FName>sample string 4</FName>
    <SubjectAreaId>1</SubjectAreaId>
    <VisualIdentity>sample string 2 - sample string 3</VisualIdentity>
  </SubjectArea>
  <Title>sample string 2</Title>
  <VisualIdentity>sample string 1 sample string 2 2025-05-03</VisualIdentity>
</Course>