POST api/Vet/V1/Students/{id}/Applications

Submit the application (list of courses applied) for existing student.

Request Information

URI Parameters

Name	Description	Type	Additional information
id	Unique student identifier	string	Required

Body Parameters

List of newly applied courses

Collection of ModelVetStudentCourseV1

Name	Description	Type	Additional information
StudentId	Unique student identifier. To submit application, this field can be null. Once submitted, system will return a new generated student ID.	string	None.
CourseId	Unique course identifier that was applied.	string	None.
CourseAttempt	Auto-number of the attempt applying the same course. To submit application, this field can be any number. The system will auto-detect the next attempt for particular student to this applying course before record.	integer	None.
ApplicationId	Auto-number generated by the system when submit the application. This id will be grouping the list of applied courses as the application.	string	None.
EmployerId	Employer code/identifier This field can be ignored when submit the application, even though employer lodges the application. The system will auto-check if the application is submitted by employer or direct student.	integer	None.
TimeStamp	Timestamp when the application submitted/recorded to the system This field can be ignored when submit the application. The system will auto-generate the current date time to record.	date	None.
CourseIntakeCode	Unique course intake code associated with the applied course	string	None.
Status	Student course status This field can be ignored when submit the application. The system will auto-generate 'Active Student' status when submitted.	string	None.

Request Formats

application/json, text/json

Sample:

[
  {
    "StudentId": "sample string 1",
    "CourseId": "sample string 2",
    "CourseAttempt": 3,
    "ApplicationId": "sample string 4",
    "EmployerId": 1,
    "TimeStamp": "2024-05-02T10:53:09.7897955+10: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-05-02T10:53:09.7897955+10:00",
    "CourseIntakeCode": "sample string 5",
    "Status": "sample string 6"
  }
]

application/xml, text/xml

Sample:

<ArrayOfModelVetStudentCourseV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1">
  <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-05-02T10:53:09.7897955+10: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-05-02T10:53:09.7897955+10:00</TimeStamp>
  </ModelVetStudentCourseV1>
</ArrayOfModelVetStudentCourseV1>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

<p>If success, redirect to 'api/vet/v1/students/{id}/applications?id={id}&dateapplied={date}'.</p> <p>If failed, return 400 (Bad request).</p>

HttpResponseMessage

Name	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.