GET api/Curriculum?academicYear={academicYear}&organizationId={organizationId}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
academicYear

integer

Required

organizationId

globally unique identifier

Required

Body Parameters

None.

Response Information

Resource Description

Collection of ProgramListItem
NameDescriptionTypeAdditional information
Title

string

None.

CurriculumId

globally unique identifier

None.

Code

string

None.

AcademicYearSpan

integer

None.

SectorId

globally unique identifier

None.

BaseCurriculumId

globally unique identifier

None.

AbstractOverview

string

None.

DurationDescription

string

None.

IsFrench

boolean

None.

IsRedSeal

boolean

None.

ProgramDeliveryModes

Collection of CurriculumProgramListDelivery

None.

AcademicYear

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "Title": "sample string 1",
    "CurriculumId": "d4c0d061-2b80-47e1-88d8-ae5807638ddd",
    "Code": "sample string 3",
    "AcademicYearSpan": 4,
    "SectorId": "03389d00-bccf-4bba-9820-f5e39271343c",
    "BaseCurriculumId": "24c5b3ad-1f79-4dbe-87f0-1a5e2e1b6704",
    "AbstractOverview": "sample string 7",
    "DurationDescription": "sample string 8",
    "IsFrench": true,
    "IsRedSeal": true,
    "ProgramDeliveryModes": [
      {
        "DeliveryModeId": 1,
        "BeginDate": "2025-05-03T01:39:10.230918-03:00",
        "EndDate": "2025-05-03T01:39:10.230918-03:00",
        "DeliveryDetail": "sample string 4",
        "DeliveryMode": {
          "Id": 1,
          "Name": "sample string 2",
          "EName": "sample string 3",
          "FName": "sample string 4"
        }
      },
      {
        "DeliveryModeId": 1,
        "BeginDate": "2025-05-03T01:39:10.230918-03:00",
        "EndDate": "2025-05-03T01:39:10.230918-03:00",
        "DeliveryDetail": "sample string 4",
        "DeliveryMode": {
          "Id": 1,
          "Name": "sample string 2",
          "EName": "sample string 3",
          "FName": "sample string 4"
        }
      }
    ],
    "AcademicYear": 11
  },
  {
    "Title": "sample string 1",
    "CurriculumId": "d4c0d061-2b80-47e1-88d8-ae5807638ddd",
    "Code": "sample string 3",
    "AcademicYearSpan": 4,
    "SectorId": "03389d00-bccf-4bba-9820-f5e39271343c",
    "BaseCurriculumId": "24c5b3ad-1f79-4dbe-87f0-1a5e2e1b6704",
    "AbstractOverview": "sample string 7",
    "DurationDescription": "sample string 8",
    "IsFrench": true,
    "IsRedSeal": true,
    "ProgramDeliveryModes": [
      {
        "DeliveryModeId": 1,
        "BeginDate": "2025-05-03T01:39:10.230918-03:00",
        "EndDate": "2025-05-03T01:39:10.230918-03:00",
        "DeliveryDetail": "sample string 4",
        "DeliveryMode": {
          "Id": 1,
          "Name": "sample string 2",
          "EName": "sample string 3",
          "FName": "sample string 4"
        }
      },
      {
        "DeliveryModeId": 1,
        "BeginDate": "2025-05-03T01:39:10.230918-03:00",
        "EndDate": "2025-05-03T01:39:10.230918-03:00",
        "DeliveryDetail": "sample string 4",
        "DeliveryMode": {
          "Id": 1,
          "Name": "sample string 2",
          "EName": "sample string 3",
          "FName": "sample string 4"
        }
      }
    ],
    "AcademicYear": 11
  }
]

application/xml, text/xml

Sample:
<ArrayOfProgramListItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IDMS.REST.Models">
  <ProgramListItem>
    <AbstractOverview>sample string 7</AbstractOverview>
    <AcademicYear>11</AcademicYear>
    <AcademicYearSpan>4</AcademicYearSpan>
    <BaseCurriculumId>24c5b3ad-1f79-4dbe-87f0-1a5e2e1b6704</BaseCurriculumId>
    <Code>sample string 3</Code>
    <CurriculumId>d4c0d061-2b80-47e1-88d8-ae5807638ddd</CurriculumId>
    <DurationDescription>sample string 8</DurationDescription>
    <IsFrench>true</IsFrench>
    <IsRedSeal>true</IsRedSeal>
    <ProgramDeliveryModes>
      <CurriculumProgramListDelivery>
        <BeginDate>2025-05-03T01:39:10.230918-03:00</BeginDate>
        <DeliveryDetail>sample string 4</DeliveryDetail>
        <DeliveryMode>
          <EName>sample string 3</EName>
          <FName>sample string 4</FName>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeliveryMode>
        <DeliveryModeId>1</DeliveryModeId>
        <EndDate>2025-05-03T01:39:10.230918-03:00</EndDate>
      </CurriculumProgramListDelivery>
      <CurriculumProgramListDelivery>
        <BeginDate>2025-05-03T01:39:10.230918-03:00</BeginDate>
        <DeliveryDetail>sample string 4</DeliveryDetail>
        <DeliveryMode>
          <EName>sample string 3</EName>
          <FName>sample string 4</FName>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeliveryMode>
        <DeliveryModeId>1</DeliveryModeId>
        <EndDate>2025-05-03T01:39:10.230918-03:00</EndDate>
      </CurriculumProgramListDelivery>
    </ProgramDeliveryModes>
    <SectorId>03389d00-bccf-4bba-9820-f5e39271343c</SectorId>
    <Title>sample string 1</Title>
  </ProgramListItem>
  <ProgramListItem>
    <AbstractOverview>sample string 7</AbstractOverview>
    <AcademicYear>11</AcademicYear>
    <AcademicYearSpan>4</AcademicYearSpan>
    <BaseCurriculumId>24c5b3ad-1f79-4dbe-87f0-1a5e2e1b6704</BaseCurriculumId>
    <Code>sample string 3</Code>
    <CurriculumId>d4c0d061-2b80-47e1-88d8-ae5807638ddd</CurriculumId>
    <DurationDescription>sample string 8</DurationDescription>
    <IsFrench>true</IsFrench>
    <IsRedSeal>true</IsRedSeal>
    <ProgramDeliveryModes>
      <CurriculumProgramListDelivery>
        <BeginDate>2025-05-03T01:39:10.230918-03:00</BeginDate>
        <DeliveryDetail>sample string 4</DeliveryDetail>
        <DeliveryMode>
          <EName>sample string 3</EName>
          <FName>sample string 4</FName>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeliveryMode>
        <DeliveryModeId>1</DeliveryModeId>
        <EndDate>2025-05-03T01:39:10.230918-03:00</EndDate>
      </CurriculumProgramListDelivery>
      <CurriculumProgramListDelivery>
        <BeginDate>2025-05-03T01:39:10.230918-03:00</BeginDate>
        <DeliveryDetail>sample string 4</DeliveryDetail>
        <DeliveryMode>
          <EName>sample string 3</EName>
          <FName>sample string 4</FName>
          <Id>1</Id>
          <Name>sample string 2</Name>
        </DeliveryMode>
        <DeliveryModeId>1</DeliveryModeId>
        <EndDate>2025-05-03T01:39:10.230918-03:00</EndDate>
      </CurriculumProgramListDelivery>
    </ProgramDeliveryModes>
    <SectorId>03389d00-bccf-4bba-9820-f5e39271343c</SectorId>
    <Title>sample string 1</Title>
  </ProgramListItem>
</ArrayOfProgramListItem>