POST api/Vet/V1/Employers/Applications

Submit new applications with new employer registration.

Employer model is required to perform new employer registration. If the same ABN matching found, new registration will bypass.

Student models list is required to perform application submitted associated with this employer.

Based on provided email address and date of birth, system will check any existing student data.
If existed in Student (Participant section), it will simply add new courses to student. No personal information and address detail update.
If existed in Offer/Application (Manage Enrolment section), it will simply add new courses to offer/application. No personal information and address detail update.

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

None.

Body Parameters

Encapsulated data model for both Employer and a collection of Student/Applicant models. Employer Model for employer registration. All fields are required. ABN is a unqiue key to check data duplication. List of Student Model for applications submission. By default, all fields are required. But it depends on if the student data existed or not, and system perform data record accordingly.

ModelVetEmployerStudentV1

Name	Description	Type	Additional information
EmployerInfo	Employer information in Employer model.	ModelVetEmployerV1	None.
Applications	Student/Applicant information in Student model.	Collection of ModelVetStudentV1	None.

Request Formats

application/json, text/json

Sample:

{
  "EmployerInfo": {
    "EmployerCode": "sample string 1",
    "EmployerName": "sample string 2",
    "UserName": "sample string 3",
    "Email": "sample string 4",
    "ABN": "sample string 5",
    "ContactPerson": "sample string 6",
    "TradingName": "sample string 7"
  },
  "Applications": [
    {
      "StudentId": "sample string 1",
      "Title": "Mr",
      "FirstName": "sample string 2",
      "LastName": "sample string 3",
      "Gender": "M",
      "DoB": "2024-05-02T15:46:47.5826876+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-02T15:46:47.5826876+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-02T15:46:47.5826876+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-02T15:46:47.5826876+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-02T15:46:47.5826876+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-02T15:46:47.5826876+10:00",
          "CourseIntakeCode": "sample string 5",
          "Status": "sample string 6"
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:

<ModelVetEmployerStudentV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_WebAPI.Models.Vet.V1">
  <Applications>
    <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-02T15:46:47.5826876+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-02T15:46:47.5826876+10:00</TimeStamp>
        </ModelVetStudentCourseV1>
      </AppliedCourses>
      <DoB>2024-05-02T15:46:47.5826876+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-02T15:46:47.5826876+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-02T15:46:47.5826876+10:00</TimeStamp>
        </ModelVetStudentCourseV1>
      </AppliedCourses>
      <DoB>2024-05-02T15:46:47.5826876+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>
  </Applications>
  <EmployerInfo>
    <ABN>sample string 5</ABN>
    <ContactPerson>sample string 6</ContactPerson>
    <Email>sample string 4</Email>
    <EmployerCode>sample string 1</EmployerCode>
    <EmployerName>sample string 2</EmployerName>
    <TradingName>sample string 7</TradingName>
    <UserName>sample string 3</UserName>
  </EmployerInfo>
</ModelVetEmployerStudentV1>

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.