POST api/V1/StudentOffers/Validate

Validate a new application before submit the application.

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OfferId	Offer Id, as unique identifier for each student application. This field will be auto-generated by the system. Leave it blank when submit application.	string	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.
Title	Name title, specifically following AVETMISS data classification.	EnumTitle	Required
FirstName	Student first/given name	string	Required
MiddleName	Student middle name	string	None.
LastName	Student last/surname	string	Required
Gender	Gender abbreviation (M, F, X)	EnumGender	Required
DoB	Date of birth (expected dd/mm/yyyy format)	date	Required Data type: Date
Email	Primary contact email address	string	Required Data type: EmailAddress
StudentOrigin	The origin of student or student type to classify where he/she come from.	EnumOrigin	Required
ComplianceAndOtherInfo	Additional important personal information and AVETMISS data for reporting.	ModelStudentOffer_ComplianceAndOtherInfoV1	Required
Addresses	List of provided student address details	Collection of ModelStudentOffer_AddressV1	Required
AppliedCourses	List of student applied courses	Collection of ModelStudentOffer_CourseV1	Required
Disabilities	List of student disability information. It can be left blank, if no disability (In ComplianceAndOtherInfo.IsDisabled must be false). Else disability info is expected to provide (In ComplianceAndOtherInfo.IsDiabled must be true).	Collection of ModelStudentOffer_DisabilityV1	None.
EmergencyContact	Emergency contact for student. It can be null.	ModelStudentOffer_EmergencyContactV1	None.
EducationHistoryList	List of student education history information	Collection of ModelStudentOffer_EducationHistoryV1	None.
EmploymentHistoryList	List of student employment history information	Collection of ModelStudentOffer_EmploymentHistoryV1	None.
Leads_MarketingCampaign	Marketing campaign/event information for CRM leads data.	ModelStudentOffer_MarketingCampaignV1	Required

Request Formats

application/json, text/json

Sample:

{
  "OfferId": "sample string 1",
  "TimeStamp": "2024-05-01T13:29:35.1826727+10:00",
  "Title": "Mr",
  "FirstName": "sample string 2",
  "MiddleName": "sample string 3",
  "LastName": "sample string 4",
  "Gender": "M",
  "DoB": "2024-05-01T13:29:35.1832984+10:00",
  "Email": "sample string 6",
  "StudentOrigin": "OverseasStudent",
  "ComplianceAndOtherInfo": {
    "OfferId": "sample string 1",
    "CountryBirth": "sample string 2",
    "Nationality": "sample string 3",
    "PassportNumber": "sample string 4",
    "PassportExpiryDate": "2024-05-01T13:29:35.1839292+10:00",
    "VisaType": "sample string 5",
    "VisaNumber": "sample string 6",
    "VisaExpiryDate": "2024-05-01T13:29:35.1839292+10:00",
    "FirstLanguage": "sample string 7",
    "HowWellEngSpeak": "sample string 8",
    "StudyReason": "sample string 9",
    "CurrentEmployStatus": "sample string 10",
    "IndustryEmployment": "sample string 11",
    "OccupationCode": "sample string 12",
    "USI": "sample string 13",
    "IsAboriginal": true,
    "IsTorresStraitIslander": true,
    "IsEngLanguageInClass": true,
    "EngTestType": "sample string 17",
    "EngTestDate": "2024-05-01T13:29:35.1839292+10:00",
    "EngTestListeningScore": "sample string 18",
    "EngTestReadingScore": "sample string 19",
    "EngTestWritingScore": "sample string 20",
    "EngTestSpeakingScore": "sample string 21",
    "EngTestOverallScore": "sample string 22",
    "HighSchoolLevel": "sample string 23",
    "HighSchoolYearCompleted": 1,
    "IsStillAtHighSchool": true,
    "SchoolType": "sample string 25",
    "IsDisabled": true,
    "IsRequestHelpForDisabled": true
  },
  "Addresses": [
    {
      "OfferId": "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",
      "Fax": "sample string 12",
      "Mobile": "sample string 13"
    },
    {
      "OfferId": "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",
      "Fax": "sample string 12",
      "Mobile": "sample string 13"
    }
  ],
  "AppliedCourses": [
    {
      "OfferId": "sample string 1",
      "CourseId": "sample string 2",
      "CampusId": 3,
      "IntakeDate": "2024-05-01T13:29:35.18581+10:00",
      "StartDate": "2024-05-01T13:29:35.18581+10:00",
      "FinishDate": "2024-05-01T13:29:35.18581+10:00",
      "ELICOS_NumOfWeeks": 7,
      "TuitionFee": 8.0,
      "EnrolmentFee": 9.0,
      "MaterialFee": 10.0,
      "UpfrontFee": 11.0,
      "SpecialCondition": "sample string 12",
      "ApplicationRequest": "sample string 13",
      "Status": "sample string 14"
    },
    {
      "OfferId": "sample string 1",
      "CourseId": "sample string 2",
      "CampusId": 3,
      "IntakeDate": "2024-05-01T13:29:35.18581+10:00",
      "StartDate": "2024-05-01T13:29:35.18581+10:00",
      "FinishDate": "2024-05-01T13:29:35.18581+10:00",
      "ELICOS_NumOfWeeks": 7,
      "TuitionFee": 8.0,
      "EnrolmentFee": 9.0,
      "MaterialFee": 10.0,
      "UpfrontFee": 11.0,
      "SpecialCondition": "sample string 12",
      "ApplicationRequest": "sample string 13",
      "Status": "sample string 14"
    }
  ],
  "Disabilities": [
    {
      "OfferId": "sample string 1",
      "DisabilityCode": "sample string 2",
      "DisabilityName": "sample string 3",
      "OtherValue": "sample string 4"
    },
    {
      "OfferId": "sample string 1",
      "DisabilityCode": "sample string 2",
      "DisabilityName": "sample string 3",
      "OtherValue": "sample string 4"
    }
  ],
  "EmergencyContact": {
    "OfferId": "sample string 1",
    "ContactType": "sample string 2",
    "Relationship": "sample string 3",
    "ContactName": "sample string 4",
    "Address": "sample string 5",
    "Phone": "sample string 6",
    "Email": "sample string 7"
  },
  "EducationHistoryList": [
    {
      "OfferId": "sample string 1",
      "QualificationName": "sample string 2",
      "InstituteName": "sample string 3",
      "InstituteLocation": "sample string 4",
      "YearCompleted": 1,
      "EducationLevelCode": "sample string 5",
      "AchievementRecognitionCode": "sample string 6"
    },
    {
      "OfferId": "sample string 1",
      "QualificationName": "sample string 2",
      "InstituteName": "sample string 3",
      "InstituteLocation": "sample string 4",
      "YearCompleted": 1,
      "EducationLevelCode": "sample string 5",
      "AchievementRecognitionCode": "sample string 6"
    }
  ],
  "EmploymentHistoryList": [
    {
      "OfferId": "sample string 1",
      "EmployerName": "sample string 2",
      "JobTitle": "sample string 3",
      "JobDescription": "sample string 4",
      "FromDate": "2024-05-01T13:29:35.1870657+10:00",
      "ToDate": "2024-05-01T13:29:35.1870657+10:00"
    },
    {
      "OfferId": "sample string 1",
      "EmployerName": "sample string 2",
      "JobTitle": "sample string 3",
      "JobDescription": "sample string 4",
      "FromDate": "2024-05-01T13:29:35.1870657+10:00",
      "ToDate": "2024-05-01T13:29:35.1870657+10:00"
    }
  ],
  "Leads_MarketingCampaign": {
    "OfferId": "sample string 1",
    "KnowFrom": "sample string 2",
    "LeadSource": "sample string 3",
    "CampaignName": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<ModelStudentOfferV1 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Models.Cricos.V1">
  <Addresses>
    <ModelStudentOffer_AddressV1>
      <AddressType>Current</AddressType>
      <BuildingName>sample string 3</BuildingName>
      <Country>sample string 10</Country>
      <Fax>sample string 12</Fax>
      <FlatUnitDetail>sample string 4</FlatUnitDetail>
      <IsPrimary>true</IsPrimary>
      <Mobile>sample string 13</Mobile>
      <OfferId>sample string 1</OfferId>
      <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>
      <Suburb>sample string 7</Suburb>
    </ModelStudentOffer_AddressV1>
    <ModelStudentOffer_AddressV1>
      <AddressType>Current</AddressType>
      <BuildingName>sample string 3</BuildingName>
      <Country>sample string 10</Country>
      <Fax>sample string 12</Fax>
      <FlatUnitDetail>sample string 4</FlatUnitDetail>
      <IsPrimary>true</IsPrimary>
      <Mobile>sample string 13</Mobile>
      <OfferId>sample string 1</OfferId>
      <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>
      <Suburb>sample string 7</Suburb>
    </ModelStudentOffer_AddressV1>
  </Addresses>
  <AppliedCourses>
    <ModelStudentOffer_CourseV1>
      <ApplicationRequest>sample string 13</ApplicationRequest>
      <CampusId>3</CampusId>
      <CourseId>sample string 2</CourseId>
      <ELICOS_NumOfWeeks>7</ELICOS_NumOfWeeks>
      <EnrolmentFee>9</EnrolmentFee>
      <FinishDate>2024-05-01T13:29:35.18581+10:00</FinishDate>
      <IntakeDate>2024-05-01T13:29:35.18581+10:00</IntakeDate>
      <MaterialFee>10</MaterialFee>
      <OfferId>sample string 1</OfferId>
      <SpecialCondition>sample string 12</SpecialCondition>
      <StartDate>2024-05-01T13:29:35.18581+10:00</StartDate>
      <Status>sample string 14</Status>
      <TuitionFee>8</TuitionFee>
      <UpfrontFee>11</UpfrontFee>
    </ModelStudentOffer_CourseV1>
    <ModelStudentOffer_CourseV1>
      <ApplicationRequest>sample string 13</ApplicationRequest>
      <CampusId>3</CampusId>
      <CourseId>sample string 2</CourseId>
      <ELICOS_NumOfWeeks>7</ELICOS_NumOfWeeks>
      <EnrolmentFee>9</EnrolmentFee>
      <FinishDate>2024-05-01T13:29:35.18581+10:00</FinishDate>
      <IntakeDate>2024-05-01T13:29:35.18581+10:00</IntakeDate>
      <MaterialFee>10</MaterialFee>
      <OfferId>sample string 1</OfferId>
      <SpecialCondition>sample string 12</SpecialCondition>
      <StartDate>2024-05-01T13:29:35.18581+10:00</StartDate>
      <Status>sample string 14</Status>
      <TuitionFee>8</TuitionFee>
      <UpfrontFee>11</UpfrontFee>
    </ModelStudentOffer_CourseV1>
  </AppliedCourses>
  <ComplianceAndOtherInfo>
    <CountryBirth>sample string 2</CountryBirth>
    <CurrentEmployStatus>sample string 10</CurrentEmployStatus>
    <EngTestDate>2024-05-01T13:29:35.1839292+10:00</EngTestDate>
    <EngTestListeningScore>sample string 18</EngTestListeningScore>
    <EngTestOverallScore>sample string 22</EngTestOverallScore>
    <EngTestReadingScore>sample string 19</EngTestReadingScore>
    <EngTestSpeakingScore>sample string 21</EngTestSpeakingScore>
    <EngTestType>sample string 17</EngTestType>
    <EngTestWritingScore>sample string 20</EngTestWritingScore>
    <FirstLanguage>sample string 7</FirstLanguage>
    <HighSchoolLevel>sample string 23</HighSchoolLevel>
    <HighSchoolYearCompleted>1</HighSchoolYearCompleted>
    <HowWellEngSpeak>sample string 8</HowWellEngSpeak>
    <IndustryEmployment>sample string 11</IndustryEmployment>
    <IsAboriginal>true</IsAboriginal>
    <IsDisabled>true</IsDisabled>
    <IsEngLanguageInClass>true</IsEngLanguageInClass>
    <IsRequestHelpForDisabled>true</IsRequestHelpForDisabled>
    <IsStillAtHighSchool>true</IsStillAtHighSchool>
    <IsTorresStraitIslander>true</IsTorresStraitIslander>
    <Nationality>sample string 3</Nationality>
    <OccupationCode>sample string 12</OccupationCode>
    <OfferId>sample string 1</OfferId>
    <PassportExpiryDate>2024-05-01T13:29:35.1839292+10:00</PassportExpiryDate>
    <PassportNumber>sample string 4</PassportNumber>
    <SchoolType>sample string 25</SchoolType>
    <StudyReason>sample string 9</StudyReason>
    <USI>sample string 13</USI>
    <VisaExpiryDate>2024-05-01T13:29:35.1839292+10:00</VisaExpiryDate>
    <VisaNumber>sample string 6</VisaNumber>
    <VisaType>sample string 5</VisaType>
  </ComplianceAndOtherInfo>
  <Disabilities>
    <ModelStudentOffer_DisabilityV1>
      <DisabilityCode>sample string 2</DisabilityCode>
      <DisabilityName>sample string 3</DisabilityName>
      <OfferId>sample string 1</OfferId>
      <OtherValue>sample string 4</OtherValue>
    </ModelStudentOffer_DisabilityV1>
    <ModelStudentOffer_DisabilityV1>
      <DisabilityCode>sample string 2</DisabilityCode>
      <DisabilityName>sample string 3</DisabilityName>
      <OfferId>sample string 1</OfferId>
      <OtherValue>sample string 4</OtherValue>
    </ModelStudentOffer_DisabilityV1>
  </Disabilities>
  <DoB>2024-05-01T13:29:35.1832984+10:00</DoB>
  <EducationHistoryList>
    <ModelStudentOffer_EducationHistoryV1>
      <AchievementRecognitionCode>sample string 6</AchievementRecognitionCode>
      <EducationLevelCode>sample string 5</EducationLevelCode>
      <InstituteLocation>sample string 4</InstituteLocation>
      <InstituteName>sample string 3</InstituteName>
      <OfferId>sample string 1</OfferId>
      <QualificationName>sample string 2</QualificationName>
      <YearCompleted>1</YearCompleted>
    </ModelStudentOffer_EducationHistoryV1>
    <ModelStudentOffer_EducationHistoryV1>
      <AchievementRecognitionCode>sample string 6</AchievementRecognitionCode>
      <EducationLevelCode>sample string 5</EducationLevelCode>
      <InstituteLocation>sample string 4</InstituteLocation>
      <InstituteName>sample string 3</InstituteName>
      <OfferId>sample string 1</OfferId>
      <QualificationName>sample string 2</QualificationName>
      <YearCompleted>1</YearCompleted>
    </ModelStudentOffer_EducationHistoryV1>
  </EducationHistoryList>
  <Email>sample string 6</Email>
  <EmergencyContact>
    <Address>sample string 5</Address>
    <ContactName>sample string 4</ContactName>
    <ContactType>sample string 2</ContactType>
    <Email>sample string 7</Email>
    <OfferId>sample string 1</OfferId>
    <Phone>sample string 6</Phone>
    <Relationship>sample string 3</Relationship>
  </EmergencyContact>
  <EmploymentHistoryList>
    <ModelStudentOffer_EmploymentHistoryV1>
      <EmployerName>sample string 2</EmployerName>
      <FromDate>2024-05-01T13:29:35.1870657+10:00</FromDate>
      <JobDescription>sample string 4</JobDescription>
      <JobTitle>sample string 3</JobTitle>
      <OfferId>sample string 1</OfferId>
      <ToDate>2024-05-01T13:29:35.1870657+10:00</ToDate>
    </ModelStudentOffer_EmploymentHistoryV1>
    <ModelStudentOffer_EmploymentHistoryV1>
      <EmployerName>sample string 2</EmployerName>
      <FromDate>2024-05-01T13:29:35.1870657+10:00</FromDate>
      <JobDescription>sample string 4</JobDescription>
      <JobTitle>sample string 3</JobTitle>
      <OfferId>sample string 1</OfferId>
      <ToDate>2024-05-01T13:29:35.1870657+10:00</ToDate>
    </ModelStudentOffer_EmploymentHistoryV1>
  </EmploymentHistoryList>
  <FirstName>sample string 2</FirstName>
  <Gender>M</Gender>
  <LastName>sample string 4</LastName>
  <Leads_MarketingCampaign>
    <CampaignName>sample string 4</CampaignName>
    <KnowFrom>sample string 2</KnowFrom>
    <LeadSource>sample string 3</LeadSource>
    <OfferId>sample string 1</OfferId>
  </Leads_MarketingCampaign>
  <MiddleName>sample string 3</MiddleName>
  <OfferId>sample string 1</OfferId>
  <StudentOrigin>OverseasStudent</StudentOrigin>
  <TimeStamp>2024-05-01T13:29:35.1826727+10:00</TimeStamp>
  <Title>Mr</Title>
</ModelStudentOfferV1>

Response Information

Resource Description

Valid/Invalid with error message

MethodResponse

Name	Type	Additional information
IsSuccess	boolean	None.
Message	string	None.
itemList	Dictionary of string [key] and string [value]	None.

Response Formats

application/json, text/json

Sample:

{
  "IsSuccess": true,
  "Message": "sample string 2",
  "itemList": {
    "sample string 1": "sample string 2",
    "sample string 3": "sample string 4"
  }
}

application/xml, text/xml

Sample:

<MethodResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/DotEdu_CricosWebAPI.Code.Utility">
  <IsSuccess>true</IsSuccess>
  <Message>sample string 2</Message>
  <itemList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>sample string 2</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value>sample string 4</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </itemList>
</MethodResponse>