GET api/V1/CourseIntakes?campusid={campusid}&publish={publish}&coursetype={coursetype}&year={year}&courseid={courseid}&intakedate={intakedate}&finishdate={finishdate}&targetfor={targetfor}&refresh={refresh}

Get all course intake date information list.

[Suggestion] give course intake search filter value to narrow down data returned.

Key filter parameter should be used by default is 'year', 'publish' and 'targetfor'

E.g.

GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-28/2/2015'
GET 'api/V1/CourseIntakes?year=2015&publish=true&targetfor=Local&intakedate=1/1/2015-&finishdate=-30/12/2015'

Request Information

URI Parameters

Name	Description	Type	Additional information
campusid	Specific campus identifier	integer	None.
publish	Is course intake set published? (true/false)	boolean	None.
coursetype	Specify intake course type (VET/ELICOS)	string	None.
year	Valid year formart (e.g. 2015) to check against intake year You can only specify exact year matching by year=2015. e.g.	integer	None.
courseid	Specific course identifier	string	None.
intakedate	Date format (e.g. dd/mm/yyyy) to check against intake date You can specify exact date matching by intakedate=1/1/2015. Or specify a range of date to bring all intake date under the date range (intakedate=1/1/2015-28/2/2015). Or specify a from date onward against intake date (intakedate=1/1/2015-). Or specify a last date against intake date (intakedate=-28/2/2015).	string	None.
finishdate	Date format (e.g. dd/mm/yyyy) to check against finish date You can specify exact date matching by finishdate=31/1/2015. Or specify a range of date to bring all finish date under the date range (finishdate=31/1/2015-28/2/2015). Or specify a from date onward against finish date (finishdate=31/1/2015-). Or specify a last date against finish date (finishdate=-28/2/2015).	string	None.
targetfor	Identify intake delivery target reciever type (Both/Local/International)	string	None.
refresh	Specify to retrieve fresh real data or get from refresh data. Expected value (true/false). If true, data will retrieve from fresh (realtime) data of RTOManager system. If false, data will retrieve from cached data for quicker response.	boolean	None.

Body Parameters

None.

Response Information

Resource Description

Collection of ModelCourseIntakeV1

Name	Description	Type	Additional information
CampusId	Unique campus identifier	integer	Required
CampusName	Campus name	string	Required
CourseId	Unique course identifier	string	Required
CourseName	Course name	string	Required
CourseType	Course type	string	Required
IntakeYear	Intake Year	integer	Required
IntakeDate	Intake date (Course offer start date)	date	Required Data type: Date
LastEnrolmentDate	The final date to accept the course enrolment for the intake	date	Required Data type: Date
FinishDate	Finish date (Course offer finish date)	date	Data type: Date
IntakeFor	Intake target delivery to student origin	string	Required
IsPublished	Identify if the intake allow to enroll via website	boolean	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "CampusId": 1,
    "CampusName": "sample string 2",
    "CourseId": "sample string 3",
    "CourseName": "sample string 4",
    "CourseType": "sample string 5",
    "IntakeYear": 6,
    "IntakeDate": "2024-05-01T18:21:16.7422694+10:00",
    "LastEnrolmentDate": "2024-05-01T18:21:16.7422694+10:00",
    "FinishDate": "2024-05-01T18:21:16.7422694+10:00",
    "IntakeFor": "sample string 9",
    "IsPublished": true
  },
  {
    "CampusId": 1,
    "CampusName": "sample string 2",
    "CourseId": "sample string 3",
    "CourseName": "sample string 4",
    "CourseType": "sample string 5",
    "IntakeYear": 6,
    "IntakeDate": "2024-05-01T18:21:16.7422694+10:00",
    "LastEnrolmentDate": "2024-05-01T18:21:16.7422694+10:00",
    "FinishDate": "2024-05-01T18:21:16.7422694+10:00",
    "IntakeFor": "sample string 9",
    "IsPublished": true
  }
]

application/xml, text/xml

Sample:

<ArrayOfModelCourseIntakeV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Cricos.V1">
  <ModelCourseIntakeV1>
    <CampusId>1</CampusId>
    <CampusName>sample string 2</CampusName>
    <CourseId>sample string 3</CourseId>
    <CourseName>sample string 4</CourseName>
    <CourseType>sample string 5</CourseType>
    <FinishDate>2024-05-01T18:21:16.7422694+10:00</FinishDate>
    <IntakeDate>2024-05-01T18:21:16.7422694+10:00</IntakeDate>
    <IntakeFor>sample string 9</IntakeFor>
    <IntakeYear>6</IntakeYear>
    <IsPublished>true</IsPublished>
    <LastEnrolmentDate>2024-05-01T18:21:16.7422694+10:00</LastEnrolmentDate>
  </ModelCourseIntakeV1>
  <ModelCourseIntakeV1>
    <CampusId>1</CampusId>
    <CampusName>sample string 2</CampusName>
    <CourseId>sample string 3</CourseId>
    <CourseName>sample string 4</CourseName>
    <CourseType>sample string 5</CourseType>
    <FinishDate>2024-05-01T18:21:16.7422694+10:00</FinishDate>
    <IntakeDate>2024-05-01T18:21:16.7422694+10:00</IntakeDate>
    <IntakeFor>sample string 9</IntakeFor>
    <IntakeYear>6</IntakeYear>
    <IsPublished>true</IsPublished>
    <LastEnrolmentDate>2024-05-01T18:21:16.7422694+10:00</LastEnrolmentDate>
  </ModelCourseIntakeV1>
</ArrayOfModelCourseIntakeV1>