POST api/Vet/V1/Employers/{employerid}/Applications

Submit new applications for particular employer.

Data will go to StudentCourse_Offer table in RTOManager system by default.

But if system found matching data with existing student, data will go to StudentCourse table in RTOManager system.

Keep in mind that there's no resouce interface to get Student Offers information in the system. Only Students API is available.

Request Information

URI Parameters

Name	Description	Type	Additional information
employerid	Employer id/code	string	Required

Body Parameters

List of students with all associated information, such addresses and applied courses.

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.

Request Formats

application/json, text/json

Sample:

[
  {
    "StudentId": "sample string 1",
    "Title": "Mr",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "Gender": "M",
    "DoB": "2024-05-01T20:19:59.0159002+10: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-05-01T20:19:59.0171366+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-01T20:19:59.0171366+10: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-05-01T20:19:59.0159002+10: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-05-01T20:19:59.0171366+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-01T20:19:59.0171366+10: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-05-01T20:19:59.0171366+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-01T20:19:59.0171366+10:00</TimeStamp>
      </ModelVetStudentCourseV1>
    </AppliedCourses>
    <DoB>2024-05-01T20:19:59.0159002+10: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-05-01T20:19:59.0171366+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-01T20:19:59.0171366+10:00</TimeStamp>
      </ModelVetStudentCourseV1>
    </AppliedCourses>
    <DoB>2024-05-01T20:19:59.0159002+10: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>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

If success, status code is 201 (Created), with return message is a collection of created student ids or offer ids (',' delimiter) and header location is 'api/vet/v1/Employers/{employerid}/Participants?dateapplied={date}' [This will not work with offer id]. Else, 400 (Bad request).

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.