GET api/V1/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&campusid={campusid}&refresh={refresh}

Get all courses information list

[Optional] You can filter courses result with specific search filter by query strings

E.g.

GET 'api/V1/Courses'
GET 'api/V1/Courses?active=true'
GET 'api/V1/Courses?active=true&ctype=VET'

Request Information

URI Parameters

Name	Description	Type	Additional information
active	Is course active? (true/false)	boolean	None.
ctype	Course type (VET/ELICOS)	string	None.
courseid	Unique course identifier	string	None.
natcode	National course identifier (National code)	string	None.
campusid	Campus identifier	integer	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

List of ModelCourseV1

Collection of ModelCourseV1

Name	Description	Type	Additional information
CourseID	Unique course identifier for internal use	string	Required
NationalCode	Unique course identifier based on training.gov.au	string	Required
CourseName	Course/Qualification name	string	Required
CourseType	Type of the course	string	Required
CourseDuration	Number of course duration	integer	Required
CourseDurationType	Type of duration interval (e.g. day, week, month, year)	string	Required
CourseGeneralDuration	The combination of course duration and duration type (e.g. 26 weeks)	string	None.
Fees	Standard course tution fee	decimal number	Required Data type: Currency
IsActive	Specify if the course is active	boolean	Required
CampusIDs	A collection of campus identifiers assigned to the course	Collection of integer	Required

Response Formats

application/json, text/json

Sample:

[
  {
    "CourseID": "sample string 1",
    "NationalCode": "sample string 2",
    "CourseName": "sample string 3",
    "CourseType": "sample string 4",
    "CourseDuration": 5,
    "CourseDurationType": "sample string 6",
    "CourseGeneralDuration": "sample string 7",
    "Fees": 8.0,
    "IsActive": true,
    "CampusIDs": [
      1,
      2
    ]
  },
  {
    "CourseID": "sample string 1",
    "NationalCode": "sample string 2",
    "CourseName": "sample string 3",
    "CourseType": "sample string 4",
    "CourseDuration": 5,
    "CourseDurationType": "sample string 6",
    "CourseGeneralDuration": "sample string 7",
    "Fees": 8.0,
    "IsActive": true,
    "CampusIDs": [
      1,
      2
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfModelCourseV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Cricos.V1">
  <ModelCourseV1>
    <CampusIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </CampusIDs>
    <CourseDuration>5</CourseDuration>
    <CourseDurationType>sample string 6</CourseDurationType>
    <CourseGeneralDuration>sample string 7</CourseGeneralDuration>
    <CourseID>sample string 1</CourseID>
    <CourseName>sample string 3</CourseName>
    <CourseType>sample string 4</CourseType>
    <Fees>8</Fees>
    <IsActive>true</IsActive>
    <NationalCode>sample string 2</NationalCode>
  </ModelCourseV1>
  <ModelCourseV1>
    <CampusIDs xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>1</d3p1:int>
      <d3p1:int>2</d3p1:int>
    </CampusIDs>
    <CourseDuration>5</CourseDuration>
    <CourseDurationType>sample string 6</CourseDurationType>
    <CourseGeneralDuration>sample string 7</CourseGeneralDuration>
    <CourseID>sample string 1</CourseID>
    <CourseName>sample string 3</CourseName>
    <CourseType>sample string 4</CourseType>
    <Fees>8</Fees>
    <IsActive>true</IsActive>
    <NationalCode>sample string 2</NationalCode>
  </ModelCourseV1>
</ArrayOfModelCourseV1>