GET api/Vet/V1/Students/Applications?id={id}&empid={empid}&dateapplied={dateapplied}&status={status}

Get all existing applications. (Only latest 500 applications, if no search parameter filter provided.)

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

Unique student/participant identifier

string

None.

empid

Unique employer code/identifier

string

None.

dateapplied

Specific application date applied (dd/mm/yyyy)

string

None.

status

Specific application status (e.g. 'Active Student', 'Cancelled', 'Graduated', 'Completed')

string

None.

Body Parameters

None.

Response Information

Resource Description

List of ModelVetStudentCourseV1

Collection of ModelVetStudentCourseV1
NameDescriptionTypeAdditional 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.

Response 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-02T05:33:55.2517999+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-02T05:33:55.2517999+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-02T05:33:55.2517999+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-02T05:33:55.2517999+10:00</TimeStamp>
  </ModelVetStudentCourseV1>
</ArrayOfModelVetStudentCourseV1>