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

Get all student information list (only latest 500 students, if no URI parameter filter provided.)

[Optional] You can filter student result with specific search filter by query strings

E.g.

GET 'api/Vet/V1/Students'
GET 'api/Vet/V1/Students?dateapplied=17/11/2015'
GET 'api/Vet/V1/Students?dateapplied=17/11/2015&empid=2'
GET 'api/Vet/V1/Students?id=STD152001&status=completed'

Request Information

URI Parameters

Name	Description	Type	Additional 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 ModelVetStudentV1

Collection of ModelVetStudentV1

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.
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.
Email	Primary contact email address	string	None.
UserName	Student user name. To submit application, this field can be null. No action of data recording for this field.	string	None.
Addresses	List of provided student address details	Collection of ModelVetStudentAddressV1	None.
AppliedCourses	List of student applied courses	Collection of ModelVetStudentCourseV1	None.

Response Formats

application/json, text/json

Sample:

[
  {
    "StudentId": "sample string 1",
    "Title": "Mr",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Gender": "M",
    "DoB": "2024-11-21T21:08:27.13155+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:08:27.13155+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:08:27.13155+11:00",
        "CourseIntakeCode": "sample string 5",
        "Status": "sample string 6"
      }
    ]
  },
  {
    "StudentId": "sample string 1",
    "Title": "Mr",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Gender": "M",
    "DoB": "2024-11-21T21:08:27.13155+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:08:27.13155+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:08:27.13155+11:00",
        "CourseIntakeCode": "sample string 5",
        "Status": "sample string 6"
      }
    ]
  }
]

application/xml, text/xml

Sample:

<ArrayOfModelVetStudentV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1">
  <ModelVetStudentV1>
    <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:08:27.13155+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:08:27.13155+11:00</TimeStamp>
      </ModelVetStudentCourseV1>
    </AppliedCourses>
    <DoB>2024-11-21T21:08:27.13155+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>
  <ModelVetStudentV1>
    <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:08:27.13155+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:08:27.13155+11:00</TimeStamp>
      </ModelVetStudentCourseV1>
    </AppliedCourses>
    <DoB>2024-11-21T21:08:27.13155+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>
</ArrayOfModelVetStudentV1>