GET api/Course?baseCourseId={baseCourseId}&effectiveDate={effectiveDate}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| baseCourseId | globally unique identifier |
Required |
|
| effectiveDate | date |
None. |
Body Parameters
None.
Response Information
Resource Description
Course| Name | Description | Type | Additional information |
|---|---|---|---|
| ScheduledHours | integer |
None. |
|
| VisualIdentity | string |
None. |
|
| BaseCourseId | globally unique identifier |
None. |
|
| CareerId | integer |
None. |
|
| ContentType | ContentType |
None. |
|
| CoopPlacement | integer |
None. |
|
| Credits | integer |
None. |
|
| Description | string |
None. |
|
| EffectiveDate | date |
None. |
|
| FieldStudy | integer |
None. |
|
| FormattedCode | string |
None. |
|
| Goal | string |
None. |
|
| GradingBasisId | integer |
None. |
|
| IndependentStudy | integer |
None. |
|
| IsFastTrack | boolean |
None. |
|
| IsFrench | boolean |
None. |
|
| Laboratory | integer |
None. |
|
| Lecture | integer |
None. |
|
| NominalHours | integer |
None. |
|
| ParticularRequirement | string |
None. |
|
| Passmark | integer |
None. |
|
| PrerequisiteNotes | string |
None. |
|
| ShortTitle | string |
None. |
|
| Status | integer |
None. |
|
| Title | string |
None. |
|
| SubjectArea | SubjectArea |
None. |
|
| Contents | Collection of Content |
None. |
|
| GeneralObjectives | Collection of CourseGeneralObjective |
None. |
|
| Resources | Collection of Resource |
None. |
|
| Prerequisites | Collection of Prerequisite |
None. |
|
| GeneralObjectivesHTML | string |
None. |
|
| Id | globally unique identifier |
None. |
Response Formats
application/json, text/json
Sample:
{
"BaseCourseId": "b62d5100-2e9b-451a-85ea-61c1a0f1135e",
"CareerId": 2,
"ContentType": 1,
"CoopPlacement": 3,
"Credits": 4,
"Description": "sample string 5",
"EffectiveDate": "2026-04-21T10:53:30.4222765-03:00",
"FieldStudy": 7,
"FormattedCode": "sample string 8",
"Goal": "sample string 9",
"GradingBasisId": 10,
"IndependentStudy": 11,
"IsFastTrack": true,
"IsFrench": true,
"Laboratory": 14,
"Lecture": 15,
"NominalHours": 16,
"ParticularRequirement": "sample string 17",
"Passmark": 18,
"PrerequisiteNotes": "sample string 19",
"ShortTitle": "sample string 20",
"Status": 21,
"Title": "sample string 22",
"SubjectArea": {
"SubjectAreaId": 6,
"AlphaCode": "sample string 1",
"EName": "sample string 3",
"FName": "sample string 5",
"EDescription": "sample string 2",
"FDescription": "sample string 4",
"Discipline": {
"DisciplineId": 2,
"Code": "sample string 1",
"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 1 - sample string 3"
},
"VisualIdentity": "sample string 1 - sample string 3"
},
"Contents": [
{
"Description": "sample string 1",
"DisplayOrder": 2
},
{
"Description": "sample string 1",
"DisplayOrder": 2
}
],
"GeneralObjectives": [
{
"Title": "sample string 1",
"IsEssentialSkill": true,
"DisplayOrder": 2,
"SpecificObjectives": [
{
"Title": "sample string 1",
"DisplayOrder": 2,
"IsAbility": true
},
{
"Title": "sample string 1",
"DisplayOrder": 2,
"IsAbility": true
}
]
},
{
"Title": "sample string 1",
"IsEssentialSkill": true,
"DisplayOrder": 2,
"SpecificObjectives": [
{
"Title": "sample string 1",
"DisplayOrder": 2,
"IsAbility": true
},
{
"Title": "sample string 1",
"DisplayOrder": 2,
"IsAbility": true
}
]
}
],
"Resources": null,
"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"
}
]
}
],
"GeneralObjectivesHTML": "sample string 23",
"Id": "c6bde744-333c-4f7f-ae2d-ebdabc7b5ca9",
"ScheduledHours": 39,
"VisualIdentity": "sample string 8 sample string 22 2026-04-21"
}
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>c6bde744-333c-4f7f-ae2d-ebdabc7b5ca9</Id>
<BaseCourseId>b62d5100-2e9b-451a-85ea-61c1a0f1135e</BaseCourseId>
<CareerId>2</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>3</CoopPlacement>
<Credits>4</Credits>
<Description>sample string 5</Description>
<EffectiveDate>2026-04-21T10:53:30.4222765-03:00</EffectiveDate>
<FieldStudy>7</FieldStudy>
<FormattedCode>sample string 8</FormattedCode>
<GeneralObjectives>
<CourseGeneralObjective>
<DisplayOrder>2</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>2</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>
<GeneralObjectivesHTML>sample string 23</GeneralObjectivesHTML>
<Goal>sample string 9</Goal>
<GradingBasisId>10</GradingBasisId>
<IndependentStudy>11</IndependentStudy>
<IsFastTrack>true</IsFastTrack>
<IsFrench>true</IsFrench>
<Laboratory>14</Laboratory>
<Lecture>15</Lecture>
<NominalHours>16</NominalHours>
<ParticularRequirement>sample string 17</ParticularRequirement>
<Passmark>18</Passmark>
<PrerequisiteNotes>sample string 19</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>39</ScheduledHours>
<ShortTitle>sample string 20</ShortTitle>
<Status>21</Status>
<SubjectArea>
<AlphaCode>sample string 1</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 1</Code>
<DisciplineId>2</DisciplineId>
<EName>sample string 3</EName>
<FName>sample string 4</FName>
<VisualIdentity>sample string 1 - sample string 3</VisualIdentity>
</Discipline>
<EDescription>sample string 2</EDescription>
<EName>sample string 3</EName>
<FDescription>sample string 4</FDescription>
<FName>sample string 5</FName>
<SubjectAreaId>6</SubjectAreaId>
<VisualIdentity>sample string 1 - sample string 3</VisualIdentity>
</SubjectArea>
<Title>sample string 22</Title>
<VisualIdentity>sample string 8 sample string 22 2026-04-21</VisualIdentity>
</Course>