GET api/V1/Courses/{id}

Get course information by particular course Id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique course identifier

string

Required

Body Parameters

None.

Response Information

Resource Description

ModelCourseV1, if found. Else, 404 (not found).

ModelCourseV1
NameDescriptionTypeAdditional 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
  ]
}

application/xml, text/xml

Sample:
<ModelCourseV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Cricos.V1">
  <CampusIDs xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1: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>