POST api/Vet/V1/Students/Applications
Submit a new application by direct apply.
Data will be recorded up to Student table (Participant section).
If submit with same student data again (System is checking Email address and Date of birth), system will only add new course to Student Course table (Participant section).
Also, if submit with same course information for the same student, it will still add the course but record as a new course attempt (e.g. Attempt 1 to 2).
Request Information
URI Parameters
None.
Body Parameters
Application data contains student information, address information and newly applied courses detail.
ModelVetStudentV1Name | Description | Type | Additional information |
---|---|---|---|
StudentId |
Unique student identifier. |
string |
None. |
Title |
Name title, specifically following AVETMISS data classification. |
EnumTitle |
None. |
FirstName |
Student first/given name |
string |
None. |
LastName |
Student last/surname |
string |
None. |
Gender |
Gender abbreviation (M, F, X) |
EnumGender |
None. |
DoB |
Date of birth (expected dd/mm/yyyy format) |
date |
None. |
Primary contact email address |
string |
None. |
|
UserName |
Student user name. |
string |
None. |
Addresses |
List of provided student address details |
Collection of ModelVetStudentAddressV1 |
None. |
AppliedCourses |
List of student applied courses |
Collection of ModelVetStudentCourseV1 |
None. |
Request Formats
application/json, text/json
{ "StudentId": "sample string 1", "Title": "Mr", "FirstName": "sample string 2", "LastName": "sample string 3", "Gender": "M", "DoB": "2024-11-21T21:15:24.4812072+11:00", "Email": "sample string 5", "UserName": "sample string 6", "Addresses": [ { "StudentId": "sample string 1", "AddressType": "Current", "IsPrimary": true, "BuildingName": "sample string 3", "FlatUnitDetail": "sample string 4", "StreetNumber": "sample string 5", "StreetName": "sample string 6", "Suburb": "sample string 7", "State": "sample string 8", "Postcode": "sample string 9", "Country": "sample string 10", "Phone": "sample string 11" }, { "StudentId": "sample string 1", "AddressType": "Current", "IsPrimary": true, "BuildingName": "sample string 3", "FlatUnitDetail": "sample string 4", "StreetNumber": "sample string 5", "StreetName": "sample string 6", "Suburb": "sample string 7", "State": "sample string 8", "Postcode": "sample string 9", "Country": "sample string 10", "Phone": "sample string 11" } ], "AppliedCourses": [ { "StudentId": "sample string 1", "CourseId": "sample string 2", "CourseAttempt": 3, "ApplicationId": "sample string 4", "EmployerId": 1, "TimeStamp": "2024-11-21T21:15:24.4812072+11:00", "CourseIntakeCode": "sample string 5", "Status": "sample string 6" }, { "StudentId": "sample string 1", "CourseId": "sample string 2", "CourseAttempt": 3, "ApplicationId": "sample string 4", "EmployerId": 1, "TimeStamp": "2024-11-21T21:15:24.4812072+11:00", "CourseIntakeCode": "sample string 5", "Status": "sample string 6" } ] }
application/xml, text/xml
<ModelVetStudentV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1"> <Addresses> <ModelVetStudentAddressV1> <AddressType>Current</AddressType> <BuildingName>sample string 3</BuildingName> <Country>sample string 10</Country> <FlatUnitDetail>sample string 4</FlatUnitDetail> <IsPrimary>true</IsPrimary> <Phone>sample string 11</Phone> <Postcode>sample string 9</Postcode> <State>sample string 8</State> <StreetName>sample string 6</StreetName> <StreetNumber>sample string 5</StreetNumber> <StudentId>sample string 1</StudentId> <Suburb>sample string 7</Suburb> </ModelVetStudentAddressV1> <ModelVetStudentAddressV1> <AddressType>Current</AddressType> <BuildingName>sample string 3</BuildingName> <Country>sample string 10</Country> <FlatUnitDetail>sample string 4</FlatUnitDetail> <IsPrimary>true</IsPrimary> <Phone>sample string 11</Phone> <Postcode>sample string 9</Postcode> <State>sample string 8</State> <StreetName>sample string 6</StreetName> <StreetNumber>sample string 5</StreetNumber> <StudentId>sample string 1</StudentId> <Suburb>sample string 7</Suburb> </ModelVetStudentAddressV1> </Addresses> <AppliedCourses> <ModelVetStudentCourseV1> <ApplicationId>sample string 4</ApplicationId> <CourseAttempt>3</CourseAttempt> <CourseId>sample string 2</CourseId> <CourseIntakeCode>sample string 5</CourseIntakeCode> <EmployerId>1</EmployerId> <Status>sample string 6</Status> <StudentId>sample string 1</StudentId> <TimeStamp>2024-11-21T21:15:24.4812072+11:00</TimeStamp> </ModelVetStudentCourseV1> <ModelVetStudentCourseV1> <ApplicationId>sample string 4</ApplicationId> <CourseAttempt>3</CourseAttempt> <CourseId>sample string 2</CourseId> <CourseIntakeCode>sample string 5</CourseIntakeCode> <EmployerId>1</EmployerId> <Status>sample string 6</Status> <StudentId>sample string 1</StudentId> <TimeStamp>2024-11-21T21:15:24.4812072+11:00</TimeStamp> </ModelVetStudentCourseV1> </AppliedCourses> <DoB>2024-11-21T21:15:24.4812072+11:00</DoB> <Email>sample string 5</Email> <FirstName>sample string 2</FirstName> <Gender>M</Gender> <LastName>sample string 3</LastName> <StudentId>sample string 1</StudentId> <Title>Mr</Title> <UserName>sample string 6</UserName> </ModelVetStudentV1>
application/x-www-form-urlencoded
Sample not available.
Response Information
Resource Description
If success, status 201: created with newly generated student id. Else, 400 (Bad request)
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |