POST api/SchoolPortal/pupilonoffrolls

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
CreateDate	date	None.
PupilOnOffRollClassifcationId	integer	None.
PupilOnOffRollClassification	PupilOnOffRollClassificationDTO	None.
SchoolAdminId	integer	None.
SchoolAdmin	SchoolAdminDTO	None.
UniquePupilNumber	string	None.
SchoolYearId	integer	None.
SchoolYear	SchoolYearDTO	None.
PupilFullName	string	None.
PupilDateOfBirth	date	None.
PupilAddress	string	None.
PupilPostcode	string	None.
IsPupilLeavingSchool	boolean	None.
DateTakenOnRoll	date	None.
IsPreviousSchoolInLiverpool	boolean	None.
IsOutsideUk	boolean	None.
PreviousSchoolInLiverpoolId	integer	None.
PreviousSchoolInLiverpool	SchoolDTO	None.
PreviousSchool	string	None.
PreviousLocalAuthId	integer	None.
PreviousLocalAuth	LocalAuthorityDTO	None.
IsPreviouslyHomeEducated	boolean	None.
DateTakenOffRoll	date	None.
ReasonForLeavingId	integer	None.
ReasonForLeaving	ReasonForLeavingDTO	None.
ReasonForLeavingOther	string	None.
DoYouKnowTheSchoolName	boolean	None.
IsTheSchoolInLiverpool	boolean	None.
NewSchoolInLiverpoolId	integer	None.
NewSchoolInLiverpool	SchoolDTO	None.
NewLocalAuthId	integer	None.
NewLocalAuth	LocalAuthorityDTO	None.
NewSchoolOutsideLiverpool	string	None.
ReferredToSocialInclusionTeam	boolean	None.
PermanentExclusionConfirmProcessRemovingChild	boolean	None.
ReferredToElectiveHomeEducationService	boolean	None.
HomeEducationConfirmProcessRemovingChild	boolean	None.
ReferredToChildrenMissingEducation	boolean	None.
OtherConfirmProcessRemovingChild	boolean	None.
ReferredToAPT	boolean	None.
APTConfirmProcessRemovingChild	boolean	None.
IsArchived	boolean	None.
ArchiveDate	date	None.
ArchivedBy	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "CreateDate": "2024-11-22T22:24:52.378825+00:00",
  "PupilOnOffRollClassifcationId": 1,
  "PupilOnOffRollClassification": {
    "Id": 1,
    "Text": "sample string 2",
    "Label": "sample string 3",
    "AdminEmails": "sample string 4",
    "IsSubmitted": true
  },
  "SchoolAdminId": 3,
  "SchoolAdmin": {
    "Id": 1,
    "UserName": "sample string 2",
    "Password": "sample string 3",
    "SchoolId": 4,
    "School": {
      "Id": 1,
      "Name": "sample string 2",
      "Active": true
    },
    "Active": true,
    "ResetPasswordToken": "sample string 6",
    "ResetPasswordExpiry": "2024-11-22T22:24:52.378825+00:00",
    "ForcePasswordReset": true,
    "CreateDate": "2024-11-22T22:24:52.378825+00:00"
  },
  "UniquePupilNumber": "sample string 4",
  "SchoolYearId": 1,
  "SchoolYear": {
    "Id": 1,
    "Text": "sample string 2"
  },
  "PupilFullName": "sample string 5",
  "PupilDateOfBirth": "2024-11-22T22:24:52.378825+00:00",
  "PupilAddress": "sample string 7",
  "PupilPostcode": "sample string 8",
  "IsPupilLeavingSchool": true,
  "DateTakenOnRoll": "2024-11-22T22:24:52.378825+00:00",
  "IsPreviousSchoolInLiverpool": true,
  "IsOutsideUk": true,
  "PreviousSchoolInLiverpoolId": 1,
  "PreviousSchoolInLiverpool": {
    "Id": 1,
    "Name": "sample string 2",
    "Active": true
  },
  "PreviousSchool": "sample string 10",
  "PreviousLocalAuthId": 1,
  "PreviousLocalAuth": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "IsPreviouslyHomeEducated": true,
  "DateTakenOffRoll": "2024-11-22T22:24:52.378825+00:00",
  "ReasonForLeavingId": 1,
  "ReasonForLeaving": {
    "Id": 1,
    "Text": "sample string 2",
    "DependentSection": "sample string 3",
    "RequiresReasonText": true
  },
  "ReasonForLeavingOther": "sample string 11",
  "DoYouKnowTheSchoolName": true,
  "IsTheSchoolInLiverpool": true,
  "NewSchoolInLiverpoolId": 1,
  "NewSchoolInLiverpool": {
    "Id": 1,
    "Name": "sample string 2",
    "Active": true
  },
  "NewLocalAuthId": 1,
  "NewLocalAuth": {
    "Id": 1,
    "Name": "sample string 2"
  },
  "NewSchoolOutsideLiverpool": "sample string 12",
  "ReferredToSocialInclusionTeam": true,
  "PermanentExclusionConfirmProcessRemovingChild": true,
  "ReferredToElectiveHomeEducationService": true,
  "HomeEducationConfirmProcessRemovingChild": true,
  "ReferredToChildrenMissingEducation": true,
  "OtherConfirmProcessRemovingChild": true,
  "ReferredToAPT": true,
  "APTConfirmProcessRemovingChild": true,
  "IsArchived": true,
  "ArchiveDate": "2024-11-22T22:24:52.378825+00:00",
  "ArchivedBy": "sample string 13"
}

text/html

Sample:

{"Id":1,"CreateDate":"2024-11-22T22:24:52.378825+00:00","PupilOnOffRollClassifcationId":1,"PupilOnOffRollClassification":{"Id":1,"Text":"sample string 2","Label":"sample string 3","AdminEmails":"sample string 4","IsSubmitted":true},"SchoolAdminId":3,"SchoolAdmin":{"Id":1,"UserName":"sample string 2","Password":"sample string 3","SchoolId":4,"School":{"Id":1,"Name":"sample string 2","Active":true},"Active":true,"ResetPasswordToken":"sample string 6","ResetPasswordExpiry":"2024-11-22T22:24:52.378825+00:00","ForcePasswordReset":true,"CreateDate":"2024-11-22T22:24:52.378825+00:00"},"UniquePupilNumber":"sample string 4","SchoolYearId":1,"SchoolYear":{"Id":1,"Text":"sample string 2"},"PupilFullName":"sample string 5","PupilDateOfBirth":"2024-11-22T22:24:52.378825+00:00","PupilAddress":"sample string 7","PupilPostcode":"sample string 8","IsPupilLeavingSchool":true,"DateTakenOnRoll":"2024-11-22T22:24:52.378825+00:00","IsPreviousSchoolInLiverpool":true,"IsOutsideUk":true,"PreviousSchoolInLiverpoolId":1,"PreviousSchoolInLiverpool":{"Id":1,"Name":"sample string 2","Active":true},"PreviousSchool":"sample string 10","PreviousLocalAuthId":1,"PreviousLocalAuth":{"Id":1,"Name":"sample string 2"},"IsPreviouslyHomeEducated":true,"DateTakenOffRoll":"2024-11-22T22:24:52.378825+00:00","ReasonForLeavingId":1,"ReasonForLeaving":{"Id":1,"Text":"sample string 2","DependentSection":"sample string 3","RequiresReasonText":true},"ReasonForLeavingOther":"sample string 11","DoYouKnowTheSchoolName":true,"IsTheSchoolInLiverpool":true,"NewSchoolInLiverpoolId":1,"NewSchoolInLiverpool":{"Id":1,"Name":"sample string 2","Active":true},"NewLocalAuthId":1,"NewLocalAuth":{"Id":1,"Name":"sample string 2"},"NewSchoolOutsideLiverpool":"sample string 12","ReferredToSocialInclusionTeam":true,"PermanentExclusionConfirmProcessRemovingChild":true,"ReferredToElectiveHomeEducationService":true,"HomeEducationConfirmProcessRemovingChild":true,"ReferredToChildrenMissingEducation":true,"OtherConfirmProcessRemovingChild":true,"ReferredToAPT":true,"APTConfirmProcessRemovingChild":true,"IsArchived":true,"ArchiveDate":"2024-11-22T22:24:52.378825+00:00","ArchivedBy":"sample string 13"}

application/xml, text/xml

Sample:

<PupilOnOffRollDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ldl.MessageBroker.DTOs.SchoolPortal">
  <APTConfirmProcessRemovingChild>true</APTConfirmProcessRemovingChild>
  <ArchiveDate>2024-11-22T22:24:52.378825+00:00</ArchiveDate>
  <ArchivedBy>sample string 13</ArchivedBy>
  <CreateDate>2024-11-22T22:24:52.378825+00:00</CreateDate>
  <DateTakenOffRoll>2024-11-22T22:24:52.378825+00:00</DateTakenOffRoll>
  <DateTakenOnRoll>2024-11-22T22:24:52.378825+00:00</DateTakenOnRoll>
  <DoYouKnowTheSchoolName>true</DoYouKnowTheSchoolName>
  <HomeEducationConfirmProcessRemovingChild>true</HomeEducationConfirmProcessRemovingChild>
  <Id>1</Id>
  <IsArchived>true</IsArchived>
  <IsOutsideUk>true</IsOutsideUk>
  <IsPreviousSchoolInLiverpool>true</IsPreviousSchoolInLiverpool>
  <IsPreviouslyHomeEducated>true</IsPreviouslyHomeEducated>
  <IsPupilLeavingSchool>true</IsPupilLeavingSchool>
  <IsTheSchoolInLiverpool>true</IsTheSchoolInLiverpool>
  <NewLocalAuth>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </NewLocalAuth>
  <NewLocalAuthId>1</NewLocalAuthId>
  <NewSchoolInLiverpool>
    <Active>true</Active>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </NewSchoolInLiverpool>
  <NewSchoolInLiverpoolId>1</NewSchoolInLiverpoolId>
  <NewSchoolOutsideLiverpool>sample string 12</NewSchoolOutsideLiverpool>
  <OtherConfirmProcessRemovingChild>true</OtherConfirmProcessRemovingChild>
  <PermanentExclusionConfirmProcessRemovingChild>true</PermanentExclusionConfirmProcessRemovingChild>
  <PreviousLocalAuth>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </PreviousLocalAuth>
  <PreviousLocalAuthId>1</PreviousLocalAuthId>
  <PreviousSchool>sample string 10</PreviousSchool>
  <PreviousSchoolInLiverpool>
    <Active>true</Active>
    <Id>1</Id>
    <Name>sample string 2</Name>
  </PreviousSchoolInLiverpool>
  <PreviousSchoolInLiverpoolId>1</PreviousSchoolInLiverpoolId>
  <PupilAddress>sample string 7</PupilAddress>
  <PupilDateOfBirth>2024-11-22T22:24:52.378825+00:00</PupilDateOfBirth>
  <PupilFullName>sample string 5</PupilFullName>
  <PupilOnOffRollClassifcationId>1</PupilOnOffRollClassifcationId>
  <PupilOnOffRollClassification>
    <AdminEmails>sample string 4</AdminEmails>
    <Id>1</Id>
    <IsSubmitted>true</IsSubmitted>
    <Label>sample string 3</Label>
    <Text>sample string 2</Text>
  </PupilOnOffRollClassification>
  <PupilPostcode>sample string 8</PupilPostcode>
  <ReasonForLeaving>
    <DependentSection>sample string 3</DependentSection>
    <Id>1</Id>
    <RequiresReasonText>true</RequiresReasonText>
    <Text>sample string 2</Text>
  </ReasonForLeaving>
  <ReasonForLeavingId>1</ReasonForLeavingId>
  <ReasonForLeavingOther>sample string 11</ReasonForLeavingOther>
  <ReferredToAPT>true</ReferredToAPT>
  <ReferredToChildrenMissingEducation>true</ReferredToChildrenMissingEducation>
  <ReferredToElectiveHomeEducationService>true</ReferredToElectiveHomeEducationService>
  <ReferredToSocialInclusionTeam>true</ReferredToSocialInclusionTeam>
  <SchoolAdmin>
    <Active>true</Active>
    <CreateDate>2024-11-22T22:24:52.378825+00:00</CreateDate>
    <ForcePasswordReset>true</ForcePasswordReset>
    <Id>1</Id>
    <Password>sample string 3</Password>
    <ResetPasswordExpiry>2024-11-22T22:24:52.378825+00:00</ResetPasswordExpiry>
    <ResetPasswordToken>sample string 6</ResetPasswordToken>
    <School>
      <Active>true</Active>
      <Id>1</Id>
      <Name>sample string 2</Name>
    </School>
    <SchoolId>4</SchoolId>
    <UserName>sample string 2</UserName>
  </SchoolAdmin>
  <SchoolAdminId>3</SchoolAdminId>
  <SchoolYear>
    <Id>1</Id>
    <Text>sample string 2</Text>
  </SchoolYear>
  <SchoolYearId>1</SchoolYearId>
  <UniquePupilNumber>sample string 4</UniquePupilNumber>
</PupilOnOffRollDTO>

application/x-www-form-urlencoded

Sample:

Sample not available.

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, text/html, application/xml, text/xml

Sample:

Sample not available.

application/bson

Sample:

Binary JSON content. See http://bsonspec.org for details.