POST api/TravelPasses/Renewal

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Id	integer	None.
RenewalType	integer	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.
HasNameChanged	boolean	None.
NewName	string	None.
NameChangedProof	Collection of byte	None.
NameChangedProofFilename	string	None.
HasMovedAddress	boolean	None.
UPRN	string	None.
Postcode	string	None.
NewAddress	string	None.
School	string	None.
OtherSchool	string	None.
Name	string	None.
DateOfBirth	date	None.
Photograph	Collection of byte	None.
PhotographFilename	string	None.
Telephone	string	None.
EmailAddress	string	None.
StudentID	string	None.
PaymentRequired	boolean	None.
PaymentReference	string	None.
ParentOrCarerName	string	None.

Request Formats

application/json, text/json

Sample:

{
  "Id": 1,
  "RenewalType": 2,
  "FreeSchoolMealsEligibility": true,
  "CanUseFreeSchoolMealsClaim": true,
  "ConfirmEligibilityAwardLetter": "QEA=",
  "ConfirmEligibilityAwardLetterFilename": "sample string 3",
  "WorkingTaxCredit": true,
  "WorkingTaxCreditProof": "QEA=",
  "WorkingTaxCreditProofFilename": "sample string 4",
  "HasNameChanged": true,
  "NewName": "sample string 6",
  "NameChangedProof": "QEA=",
  "NameChangedProofFilename": "sample string 7",
  "HasMovedAddress": true,
  "UPRN": "sample string 9",
  "Postcode": "sample string 10",
  "NewAddress": "sample string 11",
  "School": "sample string 12",
  "OtherSchool": "sample string 13",
  "Name": "sample string 14",
  "DateOfBirth": "2024-11-22T22:35:24.3954877+00:00",
  "Photograph": "QEA=",
  "PhotographFilename": "sample string 16",
  "Telephone": "sample string 17",
  "EmailAddress": "sample string 18",
  "StudentID": "sample string 19",
  "PaymentRequired": true,
  "PaymentReference": "sample string 21",
  "ParentOrCarerName": "sample string 22"
}

text/html

Sample:

{"Id":1,"RenewalType":2,"FreeSchoolMealsEligibility":true,"CanUseFreeSchoolMealsClaim":true,"ConfirmEligibilityAwardLetter":"QEA=","ConfirmEligibilityAwardLetterFilename":"sample string 3","WorkingTaxCredit":true,"WorkingTaxCreditProof":"QEA=","WorkingTaxCreditProofFilename":"sample string 4","HasNameChanged":true,"NewName":"sample string 6","NameChangedProof":"QEA=","NameChangedProofFilename":"sample string 7","HasMovedAddress":true,"UPRN":"sample string 9","Postcode":"sample string 10","NewAddress":"sample string 11","School":"sample string 12","OtherSchool":"sample string 13","Name":"sample string 14","DateOfBirth":"2024-11-22T22:35:24.3954877+00:00","Photograph":"QEA=","PhotographFilename":"sample string 16","Telephone":"sample string 17","EmailAddress":"sample string 18","StudentID":"sample string 19","PaymentRequired":true,"PaymentReference":"sample string 21","ParentOrCarerName":"sample string 22"}

application/xml, text/xml

Sample:

<TravelPassRenewalDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Ldl.MessageBroker.Service.TravelPasses.DTOs">
  <CanUseFreeSchoolMealsClaim>true</CanUseFreeSchoolMealsClaim>
  <ConfirmEligibilityAwardLetter>QEA=</ConfirmEligibilityAwardLetter>
  <ConfirmEligibilityAwardLetterFilename>sample string 3</ConfirmEligibilityAwardLetterFilename>
  <DateOfBirth>2024-11-22T22:35:24.3954877+00:00</DateOfBirth>
  <EmailAddress>sample string 18</EmailAddress>
  <FreeSchoolMealsEligibility>true</FreeSchoolMealsEligibility>
  <HasMovedAddress>true</HasMovedAddress>
  <HasNameChanged>true</HasNameChanged>
  <Id>1</Id>
  <Name>sample string 14</Name>
  <NameChangedProof>QEA=</NameChangedProof>
  <NameChangedProofFilename>sample string 7</NameChangedProofFilename>
  <NewAddress>sample string 11</NewAddress>
  <NewName>sample string 6</NewName>
  <OtherSchool>sample string 13</OtherSchool>
  <ParentOrCarerName>sample string 22</ParentOrCarerName>
  <PaymentReference>sample string 21</PaymentReference>
  <PaymentRequired>true</PaymentRequired>
  <Photograph>QEA=</Photograph>
  <PhotographFilename>sample string 16</PhotographFilename>
  <Postcode>sample string 10</Postcode>
  <RenewalType>2</RenewalType>
  <School>sample string 12</School>
  <StudentID>sample string 19</StudentID>
  <Telephone>sample string 17</Telephone>
  <UPRN>sample string 9</UPRN>
  <WorkingTaxCredit>true</WorkingTaxCredit>
  <WorkingTaxCreditProof>QEA=</WorkingTaxCreditProof>
  <WorkingTaxCreditProofFilename>sample string 4</WorkingTaxCreditProofFilename>
</TravelPassRenewalDto>

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.