GET api/Vet/V1/Courses?active={active}&ctype={ctype}&courseid={courseid}&natcode={natcode}&partialqual={partialqual}&department={department}&faculty={faculty}

Get all courses information list

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

E.g.

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

Request Information

URI Parameters

Name	Description	Type	Additional information
active	Is course active? (true/false)	boolean	None.
ctype	Course type - Vet: AQTF/Non-AQTF - Cricos: ELICOS/VET	string	None.
courseid	Unique course identifier	string	None.
natcode	National course identifier (National code)	string	None.
partialqual	Is partial or full qualification delivery? (true/false)	boolean	None.
department	Course department	string	None.
faculty	Course faculty	string	None.

Body Parameters

None.

Response Information

Resource Description

List of ModelVetCourseV1

Collection of ModelVetCourseV1

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
CourseGeneralDuration	The combination of course duration and duration type (e.g. 26 weeks)	string	None.
CourseDuration	Number of course duration	integer	Required
CourseDurationType	Type of duration interval (e.g. day, week, month, year)	string	Required
CourseType	Type of the course	string	Required
Fees	Standard course tution fee	decimal number	Required Data type: Currency
Active	Specify if the course is active	boolean	Required
OtherInfo	Other additional course information	ModelVetCourseAdditionalInformationV1	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "CourseID": "sample string 1",
    "NationalCode": "sample string 2",
    "CourseName": "sample string 3",
    "CourseGeneralDuration": "sample string 4",
    "CourseDuration": 5,
    "CourseDurationType": "sample string 6",
    "CourseType": "sample string 7",
    "Fees": 8.0,
    "Active": true,
    "OtherInfo": {
      "PreRequisite": "sample string 1",
      "Department": "sample string 2",
      "Faculty": "sample string 3",
      "IsPartialQualificationDelivery": true,
      "IsAVETMISSReportable": true
    }
  },
  {
    "CourseID": "sample string 1",
    "NationalCode": "sample string 2",
    "CourseName": "sample string 3",
    "CourseGeneralDuration": "sample string 4",
    "CourseDuration": 5,
    "CourseDurationType": "sample string 6",
    "CourseType": "sample string 7",
    "Fees": 8.0,
    "Active": true,
    "OtherInfo": {
      "PreRequisite": "sample string 1",
      "Department": "sample string 2",
      "Faculty": "sample string 3",
      "IsPartialQualificationDelivery": true,
      "IsAVETMISSReportable": true
    }
  }
]

application/xml, text/xml

Sample:

<ArrayOfModelVetCourseV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1">
  <ModelVetCourseV1>
    <Active>true</Active>
    <CourseDuration>5</CourseDuration>
    <CourseDurationType>sample string 6</CourseDurationType>
    <CourseGeneralDuration>sample string 4</CourseGeneralDuration>
    <CourseID>sample string 1</CourseID>
    <CourseName>sample string 3</CourseName>
    <CourseType>sample string 7</CourseType>
    <Fees>8</Fees>
    <NationalCode>sample string 2</NationalCode>
    <OtherInfo>
      <Department>sample string 2</Department>
      <Faculty>sample string 3</Faculty>
      <IsAVETMISSReportable>true</IsAVETMISSReportable>
      <IsPartialQualificationDelivery>true</IsPartialQualificationDelivery>
      <PreRequisite>sample string 1</PreRequisite>
    </OtherInfo>
  </ModelVetCourseV1>
  <ModelVetCourseV1>
    <Active>true</Active>
    <CourseDuration>5</CourseDuration>
    <CourseDurationType>sample string 6</CourseDurationType>
    <CourseGeneralDuration>sample string 4</CourseGeneralDuration>
    <CourseID>sample string 1</CourseID>
    <CourseName>sample string 3</CourseName>
    <CourseType>sample string 7</CourseType>
    <Fees>8</Fees>
    <NationalCode>sample string 2</NationalCode>
    <OtherInfo>
      <Department>sample string 2</Department>
      <Faculty>sample string 3</Faculty>
      <IsAVETMISSReportable>true</IsAVETMISSReportable>
      <IsPartialQualificationDelivery>true</IsPartialQualificationDelivery>
      <PreRequisite>sample string 1</PreRequisite>
    </OtherInfo>
  </ModelVetCourseV1>
</ArrayOfModelVetCourseV1>