POST api/Properties/CreateRentalAgreementBreakRequest

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
DBNo	integer	None.
AppNo	integer	None.
BreakRequestID	integer	None.
RentAgreementID	integer	None.
RequestType	string	None.
IsForcedOut	boolean	None.
Request_Status	string	None.
RequestReason	string	None.
BreakDateRequested	date	None.
RequestHandledBy_HSTRentPropertyManager	integer	None.
CreatedBy	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "DBNo": 1,
  "AppNo": 1,
  "BreakRequestID": 1,
  "RentAgreementID": 1,
  "RequestType": "sample string 2",
  "IsForcedOut": true,
  "Request_Status": "sample string 4",
  "RequestReason": "sample string 5",
  "BreakDateRequested": "2026-04-06T21:36:25.6407777-05:00",
  "RequestHandledBy_HSTRentPropertyManager": 1,
  "CreatedBy": 7
}

application/xml, text/xml

Sample:

<RentalAgreement_BreakCreateRequestModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessAccessLayer.Model.PropertyModule.RentModule">
  <AppNo>1</AppNo>
  <BreakDateRequested>2026-04-06T21:36:25.6407777-05:00</BreakDateRequested>
  <BreakRequestID>1</BreakRequestID>
  <CreatedBy>7</CreatedBy>
  <DBNo>1</DBNo>
  <IsForcedOut>true</IsForcedOut>
  <RentAgreementID>1</RentAgreementID>
  <RequestHandledBy_HSTRentPropertyManager>1</RequestHandledBy_HSTRentPropertyManager>
  <RequestReason>sample string 5</RequestReason>
  <RequestType>sample string 2</RequestType>
  <Request_Status>sample string 4</Request_Status>
</RentalAgreement_BreakCreateRequestModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result

Name	Type	Additional information
Status	ResultStatus	None.
Message	string	None.
Data	Object	None.

Response Formats

application/json, text/json

Sample:

{
  "Status": 100,
  "Message": "sample string 1",
  "Data": {}
}

application/xml, text/xml

Sample:

<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessAccessLayer.Generics">
  <Data />
  <Message>sample string 1</Message>
  <Status>Success</Status>
</Result>