POST api/TravelPasses

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
FosterAllowance	boolean	None.
ChildBenefit	boolean	None.
WithoutChildBenefitReason	string	None.
FreeSchoolMealsEligibility	boolean	None.
CanUseFreeSchoolMealsClaim	boolean	None.
ConfirmEligibilityAwardLetter	Collection of byte	None.
ConfirmEligibilityAwardLetterFilename	string	None.
WorkingTaxCredit	boolean	None.
WorkingTaxCreditProof	Collection of byte	None.
WorkingTaxCreditProofFilename	string	None.
ParentOrCarerName	string	None.
RelationToChild	integer	None.
UPRN	string	None.
Postcode	string	None.
Address	string	None.
LivedAtAddressLessThanYear	boolean	None.
OtherAddress	string	None.
DateMovedIntoProperty	date	None.
EmailAddress	string	None.
Telephone	string	None.
PupilName	string	None.
DateOfBirth	date	None.
Gender	integer	None.
Photograph	Collection of byte	None.
PhotographFilename	string	None.
School	string	None.
OtherSchool	string	None.
AttendedOtherSchools	boolean	None.
OldSchool	string	None.
DateLeftSchool	date	None.
RequiresSingleSexSchool	boolean	None.
RequiresSingleSexSchoolProof	Collection of byte	None.
RequiresSingleSexSchoolProofFilename	string	None.
TravelMethod	integer	None.
TrainStation	string	None.
TrainDestinationStation	string	None.
ThisAcademicYear	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "FosterAllowance": true,
  "ChildBenefit": true,
  "WithoutChildBenefitReason": "sample string 4",
  "FreeSchoolMealsEligibility": true,
  "CanUseFreeSchoolMealsClaim": true,
  "ConfirmEligibilityAwardLetter": "QEA=",
  "ConfirmEligibilityAwardLetterFilename": "sample string 6",
  "WorkingTaxCredit": true,
  "WorkingTaxCreditProof": "QEA=",
  "WorkingTaxCreditProofFilename": "sample string 8",
  "ParentOrCarerName": "sample string 9",
  "RelationToChild": 10,
  "UPRN": "sample string 11",
  "Postcode": "sample string 12",
  "Address": "sample string 13",
  "LivedAtAddressLessThanYear": true,
  "OtherAddress": "sample string 15",
  "DateMovedIntoProperty": "2024-11-22T22:43:45.5823036+00:00",
  "EmailAddress": "sample string 16",
  "Telephone": "sample string 17",
  "PupilName": "sample string 18",
  "DateOfBirth": "2024-11-22T22:43:45.5823036+00:00",
  "Gender": 20,
  "Photograph": "QEA=",
  "PhotographFilename": "sample string 21",
  "School": "sample string 22",
  "OtherSchool": "sample string 23",
  "AttendedOtherSchools": true,
  "OldSchool": "sample string 25",
  "DateLeftSchool": "2024-11-22T22:43:45.5823036+00:00",
  "RequiresSingleSexSchool": true,
  "RequiresSingleSexSchoolProof": "QEA=",
  "RequiresSingleSexSchoolProofFilename": "sample string 27",
  "TravelMethod": 28,
  "TrainStation": "sample string 29",
  "TrainDestinationStation": "sample string 30",
  "ThisAcademicYear": true
}

text/html

Sample:

{"Id":1,"FosterAllowance":true,"ChildBenefit":true,"WithoutChildBenefitReason":"sample string 4","FreeSchoolMealsEligibility":true,"CanUseFreeSchoolMealsClaim":true,"ConfirmEligibilityAwardLetter":"QEA=","ConfirmEligibilityAwardLetterFilename":"sample string 6","WorkingTaxCredit":true,"WorkingTaxCreditProof":"QEA=","WorkingTaxCreditProofFilename":"sample string 8","ParentOrCarerName":"sample string 9","RelationToChild":10,"UPRN":"sample string 11","Postcode":"sample string 12","Address":"sample string 13","LivedAtAddressLessThanYear":true,"OtherAddress":"sample string 15","DateMovedIntoProperty":"2024-11-22T22:43:45.5823036+00:00","EmailAddress":"sample string 16","Telephone":"sample string 17","PupilName":"sample string 18","DateOfBirth":"2024-11-22T22:43:45.5823036+00:00","Gender":20,"Photograph":"QEA=","PhotographFilename":"sample string 21","School":"sample string 22","OtherSchool":"sample string 23","AttendedOtherSchools":true,"OldSchool":"sample string 25","DateLeftSchool":"2024-11-22T22:43:45.5823036+00:00","RequiresSingleSexSchool":true,"RequiresSingleSexSchoolProof":"QEA=","RequiresSingleSexSchoolProofFilename":"sample string 27","TravelMethod":28,"TrainStation":"sample string 29","TrainDestinationStation":"sample string 30","ThisAcademicYear":true}

application/xml, text/xml

Sample:

<NewTravelPassDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ldl.MessageBroker.Service.TravelPasses.DTOs">
  <Address>sample string 13</Address>
  <AttendedOtherSchools>true</AttendedOtherSchools>
  <CanUseFreeSchoolMealsClaim>true</CanUseFreeSchoolMealsClaim>
  <ChildBenefit>true</ChildBenefit>
  <ConfirmEligibilityAwardLetter>QEA=</ConfirmEligibilityAwardLetter>
  <ConfirmEligibilityAwardLetterFilename>sample string 6</ConfirmEligibilityAwardLetterFilename>
  <DateLeftSchool>2024-11-22T22:43:45.5823036+00:00</DateLeftSchool>
  <DateMovedIntoProperty>2024-11-22T22:43:45.5823036+00:00</DateMovedIntoProperty>
  <DateOfBirth>2024-11-22T22:43:45.5823036+00:00</DateOfBirth>
  <EmailAddress>sample string 16</EmailAddress>
  <FosterAllowance>true</FosterAllowance>
  <FreeSchoolMealsEligibility>true</FreeSchoolMealsEligibility>
  <Gender>20</Gender>
  <Id>1</Id>
  <LivedAtAddressLessThanYear>true</LivedAtAddressLessThanYear>
  <OldSchool>sample string 25</OldSchool>
  <OtherAddress>sample string 15</OtherAddress>
  <OtherSchool>sample string 23</OtherSchool>
  <ParentOrCarerName>sample string 9</ParentOrCarerName>
  <Photograph>QEA=</Photograph>
  <PhotographFilename>sample string 21</PhotographFilename>
  <Postcode>sample string 12</Postcode>
  <PupilName>sample string 18</PupilName>
  <RelationToChild>10</RelationToChild>
  <RequiresSingleSexSchool>true</RequiresSingleSexSchool>
  <RequiresSingleSexSchoolProof>QEA=</RequiresSingleSexSchoolProof>
  <RequiresSingleSexSchoolProofFilename>sample string 27</RequiresSingleSexSchoolProofFilename>
  <School>sample string 22</School>
  <Telephone>sample string 17</Telephone>
  <ThisAcademicYear>true</ThisAcademicYear>
  <TrainDestinationStation>sample string 30</TrainDestinationStation>
  <TrainStation>sample string 29</TrainStation>
  <TravelMethod>28</TravelMethod>
  <UPRN>sample string 11</UPRN>
  <WithoutChildBenefitReason>sample string 4</WithoutChildBenefitReason>
  <WorkingTaxCredit>true</WorkingTaxCredit>
  <WorkingTaxCreditProof>QEA=</WorkingTaxCreditProof>
  <WorkingTaxCreditProofFilename>sample string 8</WorkingTaxCreditProofFilename>
</NewTravelPassDto>

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.