GET api/Vet/V1/CourseOfferIntakes/{id}

Get course intake information by particular course intake code

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Unique course offer intake code/identifier	string	Required

Body Parameters

None.

Response Information

Resource Description

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

ModelCourseOfferIntake

Name	Description	Type	Additional information
CourseIntakeCode	Unique course intake code	string	None.
CourseID	Unique course identifier	string	None.
IntakeDate	Intake date	date	None.
FinishDate	Finish date	date	None.
DeliveryType	Delivery type (Corporate, Distance, Public)	string	None.
EmployerCode	Employer code/id - associated with Delivery type 'Corporate'. It may be null.	integer	None.
VenueCode	Venue/Training location unique code	string	None.
NumMaxCapSeat	Number of maximum seats set for course intake	integer	None.
NumRemainingSeat	Number of current remaining seats (NumMaxCapSeat - Number of Student enrolled on this course intake)	integer	None.
IsPublish	Indicate whether course intake is set to publish? (true/false) You should use this field as true to show in your application publicly.	boolean	None.
IsOnlinePayment	Identify if course intake is enabled for Online Payment? (true/false) You should use this field as true to enable online payment method via your application.	boolean	None.
CourseOfferDescription	Course intake offer description	string	None.
Employer	Employer further information. It can be null, if employer code/id is null.	ModelVetEmployerV1	None.
Venue	Venue full information detail	ModelVetVenueV1	None.

Response Formats

application/json, text/json

Sample:

{
  "CourseIntakeCode": "sample string 1",
  "CourseID": "sample string 2",
  "IntakeDate": "2024-11-21T21:07:43.9295175+11:00",
  "FinishDate": "2024-11-21T21:07:43.9295175+11:00",
  "DeliveryType": "sample string 5",
  "EmployerCode": 1,
  "VenueCode": "sample string 6",
  "NumMaxCapSeat": 7,
  "NumRemainingSeat": 8,
  "IsPublish": true,
  "IsOnlinePayment": true,
  "CourseOfferDescription": "sample string 11",
  "Employer": {
    "EmployerCode": "sample string 1",
    "EmployerName": "sample string 2",
    "UserName": "sample string 3",
    "Email": "sample string 4",
    "ABN": "sample string 5",
    "ContactPerson": "sample string 6",
    "TradingName": "sample string 7"
  },
  "Venue": {
    "VenueCode": "sample string 1",
    "VenueName": "sample string 2",
    "VenueDescription": "sample string 3",
    "BuildingName": "sample string 4",
    "FlatUnitDetail": "sample string 5",
    "StreetNumber": "sample string 6",
    "StreetName": "sample string 7",
    "Suburb": "sample string 8",
    "State": "sample string 9",
    "Postcode": "sample string 10",
    "Country": "sample string 11",
    "ContactNo": "sample string 12"
  }
}

application/xml, text/xml

Sample:

<ModelCourseOfferIntake xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1">
  <CourseID>sample string 2</CourseID>
  <CourseIntakeCode>sample string 1</CourseIntakeCode>
  <CourseOfferDescription>sample string 11</CourseOfferDescription>
  <DeliveryType>sample string 5</DeliveryType>
  <Employer>
    <ABN>sample string 5</ABN>
    <ContactPerson>sample string 6</ContactPerson>
    <Email>sample string 4</Email>
    <EmployerCode>sample string 1</EmployerCode>
    <EmployerName>sample string 2</EmployerName>
    <TradingName>sample string 7</TradingName>
    <UserName>sample string 3</UserName>
  </Employer>
  <EmployerCode>1</EmployerCode>
  <FinishDate>2024-11-21T21:07:43.9295175+11:00</FinishDate>
  <IntakeDate>2024-11-21T21:07:43.9295175+11:00</IntakeDate>
  <IsOnlinePayment>true</IsOnlinePayment>
  <IsPublish>true</IsPublish>
  <NumMaxCapSeat>7</NumMaxCapSeat>
  <NumRemainingSeat>8</NumRemainingSeat>
  <Venue>
    <BuildingName>sample string 4</BuildingName>
    <ContactNo>sample string 12</ContactNo>
    <Country>sample string 11</Country>
    <FlatUnitDetail>sample string 5</FlatUnitDetail>
    <Postcode>sample string 10</Postcode>
    <State>sample string 9</State>
    <StreetName>sample string 7</StreetName>
    <StreetNumber>sample string 6</StreetNumber>
    <Suburb>sample string 8</Suburb>
    <VenueCode>sample string 1</VenueCode>
    <VenueDescription>sample string 3</VenueDescription>
    <VenueName>sample string 2</VenueName>
  </Venue>
  <VenueCode>sample string 6</VenueCode>
</ModelCourseOfferIntake>