POST

apiportal/v1/FutureStudent

No documentation available.

Request Information

Roles

Vendor_APIClient

URI Parameters

None.

Body Parameters

Collection of FutureStudentRequest

Name	Type	Additional information
StudentCommunityDetails	CommunityDetails	None.
ApplicationDate	date	None.
EnrolDate	date	None.
Campus	string	None.
YearLevel	integer	None.
House	string	None.
Form	string	None.
Tutor	string	None.
Status	string	None.
Priority	string	None.
PreviousSchool	string	None.
EnquirySource	string	None.
EnquirySourceComment	string	None.
Operator	string	None.
Boarder	string	None.
EnquiryDate	date	None.
PriorityOverrideFlag	boolean	None.
InitialSchoolingDate	date	None.
AgentID	integer	None.
GovernmentStudentNumber	string	None.
FundingApplicationFlag	boolean	None.
ApplicationCategory	string	None.
Guardian1CommunityDetails	CommunityDetails	None.
Guardian1Relationship	string	None.
IncludeGuardian2Flag	boolean	None.
Guardian2CommunityDetails	CommunityDetails	None.
Guardian2Relationship	string	None.
Address	AddressDetails	None.

Request Formats

[
  {
    "StudentCommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-02T01:32:39.9393785+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "ApplicationDate": "2025-05-02T01:32:39.9393785+10:00",
    "EnrolDate": "2025-05-02T01:32:39.9393785+10:00",
    "Campus": "sample string 1",
    "YearLevel": 1,
    "House": "sample string 2",
    "Form": "sample string 3",
    "Tutor": "sample string 4",
    "Status": "sample string 5",
    "Priority": "sample string 6",
    "PreviousSchool": "sample string 7",
    "EnquirySource": "sample string 8",
    "EnquirySourceComment": "sample string 9",
    "Operator": "sample string 10",
    "Boarder": "sample string 11",
    "EnquiryDate": "2025-05-02T01:32:39.9393785+10:00",
    "PriorityOverrideFlag": true,
    "InitialSchoolingDate": "2025-05-02T01:32:39.9393785+10:00",
    "AgentID": 1,
    "GovernmentStudentNumber": "sample string 13",
    "FundingApplicationFlag": true,
    "ApplicationCategory": "sample string 15",
    "Guardian1CommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-02T01:32:39.9393785+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "Guardian1Relationship": "sample string 16",
    "IncludeGuardian2Flag": true,
    "Guardian2CommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-02T01:32:39.9393785+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "Guardian2Relationship": "sample string 18",
    "Address": {
      "AddressID": 1,
      "AddressLine": "sample string 1",
      "Suburb": "sample string 2",
      "State": "sample string 3",
      "PostCode": "sample string 4",
      "CountryCode": "sample string 5",
      "PhoneActual": "sample string 6"
    }
  },
  {
    "StudentCommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-02T01:32:39.9393785+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "ApplicationDate": "2025-05-02T01:32:39.9393785+10:00",
    "EnrolDate": "2025-05-02T01:32:39.9393785+10:00",
    "Campus": "sample string 1",
    "YearLevel": 1,
    "House": "sample string 2",
    "Form": "sample string 3",
    "Tutor": "sample string 4",
    "Status": "sample string 5",
    "Priority": "sample string 6",
    "PreviousSchool": "sample string 7",
    "EnquirySource": "sample string 8",
    "EnquirySourceComment": "sample string 9",
    "Operator": "sample string 10",
    "Boarder": "sample string 11",
    "EnquiryDate": "2025-05-02T01:32:39.9393785+10:00",
    "PriorityOverrideFlag": true,
    "InitialSchoolingDate": "2025-05-02T01:32:39.9393785+10:00",
    "AgentID": 1,
    "GovernmentStudentNumber": "sample string 13",
    "FundingApplicationFlag": true,
    "ApplicationCategory": "sample string 15",
    "Guardian1CommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-02T01:32:39.9393785+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "Guardian1Relationship": "sample string 16",
    "IncludeGuardian2Flag": true,
    "Guardian2CommunityDetails": {
      "ID": 1,
      "Title": "sample string 1",
      "Surname": "sample string 2",
      "Given1": "sample string 3",
      "Preferred": "sample string 4",
      "Given2": "sample string 5",
      "Gender": "sample string 6",
      "BirthDate": "2025-05-02T01:32:39.9393785+10:00",
      "SpouseID": 1,
      "ReligionCode": "sample string 7",
      "ParishCode": "sample string 8",
      "Email": "sample string 9",
      "MobilePhoneActual": "sample string 10",
      "OccupPhone": "sample string 11",
      "OccupEmail": "sample string 12",
      "OccupCode": "sample string 13",
      "OccupDesc": "sample string 14",
      "OccupCompany": "sample string 15"
    },
    "Guardian2Relationship": "sample string 18",
    "Address": {
      "AddressID": 1,
      "AddressLine": "sample string 1",
      "Suburb": "sample string 2",
      "State": "sample string 3",
      "PostCode": "sample string 4",
      "CountryCode": "sample string 5",
      "PhoneActual": "sample string 6"
    }
  }
]

<ArrayOfFutureStudentRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <FutureStudentRequest>
    <Address>
      <AddressID>1</AddressID>
      <AddressLine>sample string 1</AddressLine>
      <CountryCode>sample string 5</CountryCode>
      <PhoneActual>sample string 6</PhoneActual>
      <PostCode>sample string 4</PostCode>
      <State>sample string 3</State>
      <Suburb>sample string 2</Suburb>
    </Address>
    <AgentID>1</AgentID>
    <ApplicationCategory>sample string 15</ApplicationCategory>
    <ApplicationDate>2025-05-02T01:32:39.9393785+10:00</ApplicationDate>
    <Boarder>sample string 11</Boarder>
    <Campus>sample string 1</Campus>
    <EnquiryDate>2025-05-02T01:32:39.9393785+10:00</EnquiryDate>
    <EnquirySource>sample string 8</EnquirySource>
    <EnquirySourceComment>sample string 9</EnquirySourceComment>
    <EnrolDate>2025-05-02T01:32:39.9393785+10:00</EnrolDate>
    <Form>sample string 3</Form>
    <FundingApplicationFlag>true</FundingApplicationFlag>
    <GovernmentStudentNumber>sample string 13</GovernmentStudentNumber>
    <Guardian1CommunityDetails>
      <BirthDate>2025-05-02T01:32:39.9393785+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </Guardian1CommunityDetails>
    <Guardian1Relationship>sample string 16</Guardian1Relationship>
    <Guardian2CommunityDetails>
      <BirthDate>2025-05-02T01:32:39.9393785+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </Guardian2CommunityDetails>
    <Guardian2Relationship>sample string 18</Guardian2Relationship>
    <House>sample string 2</House>
    <IncludeGuardian2Flag>true</IncludeGuardian2Flag>
    <InitialSchoolingDate>2025-05-02T01:32:39.9393785+10:00</InitialSchoolingDate>
    <Operator>sample string 10</Operator>
    <PreviousSchool>sample string 7</PreviousSchool>
    <Priority>sample string 6</Priority>
    <PriorityOverrideFlag>true</PriorityOverrideFlag>
    <Status>sample string 5</Status>
    <StudentCommunityDetails>
      <BirthDate>2025-05-02T01:32:39.9393785+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </StudentCommunityDetails>
    <Tutor>sample string 4</Tutor>
    <YearLevel>1</YearLevel>
  </FutureStudentRequest>
  <FutureStudentRequest>
    <Address>
      <AddressID>1</AddressID>
      <AddressLine>sample string 1</AddressLine>
      <CountryCode>sample string 5</CountryCode>
      <PhoneActual>sample string 6</PhoneActual>
      <PostCode>sample string 4</PostCode>
      <State>sample string 3</State>
      <Suburb>sample string 2</Suburb>
    </Address>
    <AgentID>1</AgentID>
    <ApplicationCategory>sample string 15</ApplicationCategory>
    <ApplicationDate>2025-05-02T01:32:39.9393785+10:00</ApplicationDate>
    <Boarder>sample string 11</Boarder>
    <Campus>sample string 1</Campus>
    <EnquiryDate>2025-05-02T01:32:39.9393785+10:00</EnquiryDate>
    <EnquirySource>sample string 8</EnquirySource>
    <EnquirySourceComment>sample string 9</EnquirySourceComment>
    <EnrolDate>2025-05-02T01:32:39.9393785+10:00</EnrolDate>
    <Form>sample string 3</Form>
    <FundingApplicationFlag>true</FundingApplicationFlag>
    <GovernmentStudentNumber>sample string 13</GovernmentStudentNumber>
    <Guardian1CommunityDetails>
      <BirthDate>2025-05-02T01:32:39.9393785+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </Guardian1CommunityDetails>
    <Guardian1Relationship>sample string 16</Guardian1Relationship>
    <Guardian2CommunityDetails>
      <BirthDate>2025-05-02T01:32:39.9393785+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </Guardian2CommunityDetails>
    <Guardian2Relationship>sample string 18</Guardian2Relationship>
    <House>sample string 2</House>
    <IncludeGuardian2Flag>true</IncludeGuardian2Flag>
    <InitialSchoolingDate>2025-05-02T01:32:39.9393785+10:00</InitialSchoolingDate>
    <Operator>sample string 10</Operator>
    <PreviousSchool>sample string 7</PreviousSchool>
    <Priority>sample string 6</Priority>
    <PriorityOverrideFlag>true</PriorityOverrideFlag>
    <Status>sample string 5</Status>
    <StudentCommunityDetails>
      <BirthDate>2025-05-02T01:32:39.9393785+10:00</BirthDate>
      <Email>sample string 9</Email>
      <Gender>sample string 6</Gender>
      <Given1>sample string 3</Given1>
      <Given2>sample string 5</Given2>
      <ID>1</ID>
      <MobilePhoneActual>sample string 10</MobilePhoneActual>
      <OccupCode>sample string 13</OccupCode>
      <OccupCompany>sample string 15</OccupCompany>
      <OccupDesc>sample string 14</OccupDesc>
      <OccupEmail>sample string 12</OccupEmail>
      <OccupPhone>sample string 11</OccupPhone>
      <ParishCode>sample string 8</ParishCode>
      <Preferred>sample string 4</Preferred>
      <ReligionCode>sample string 7</ReligionCode>
      <SpouseID>1</SpouseID>
      <Surname>sample string 2</Surname>
      <Title>sample string 1</Title>
    </StudentCommunityDetails>
    <Tutor>sample string 4</Tutor>
    <YearLevel>1</YearLevel>
  </FutureStudentRequest>
</ArrayOfFutureStudentRequest>

Sample not available.

Response Information

Resource Description

Collection of CreateFutureStudentSeqRespModel

Name	Description	Type	Additional information
RowNum		integer	None.
Result		CreateFutureStudentSeqModel	None.

[
  {
    "RowNum": 1,
    "Result": {
      "StudentID": 1,
      "Guardian1ID": 1,
      "Guardian2ID": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  },
  {
    "RowNum": 1,
    "Result": {
      "StudentID": 1,
      "Guardian1ID": 1,
      "Guardian2ID": 1,
      "Error": "sample string 1",
      "ValidationDetails": [
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        },
        {
          "FieldName": "sample string 1",
          "Reason": "sample string 2"
        }
      ]
    }
  }
]

<ArrayOfCreateFutureStudentSeqRespModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Synergetic.Model.APIClient">
  <CreateFutureStudentSeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <Guardian1ID>1</Guardian1ID>
      <Guardian2ID>1</Guardian2ID>
      <StudentID>1</StudentID>
    </Result>
    <RowNum>1</RowNum>
  </CreateFutureStudentSeqRespModel>
  <CreateFutureStudentSeqRespModel>
    <Result>
      <Error>sample string 1</Error>
      <ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
        <ValidationDetails>
          <FieldName>sample string 1</FieldName>
          <Reason>sample string 2</Reason>
        </ValidationDetails>
      </ValidationDetails>
      <Guardian1ID>1</Guardian1ID>
      <Guardian2ID>1</Guardian2ID>
      <StudentID>1</StudentID>
    </Result>
    <RowNum>1</RowNum>
  </CreateFutureStudentSeqRespModel>
</ArrayOfCreateFutureStudentSeqRespModel>