POST api/Properties/CreatePropertyRentAgreement

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
LocalTimeZone	string	None.
ROWID	globally unique identifier	None.
RentAgreementID	integer	None.
LocationID	integer	None.
HST_BidBatchID	integer	None.
HSTRentPropertyManagerID	integer	None.
AgreementStatusID	integer	None.
Tenant_UserProfileID	integer	None.
Rent_Agreement_Months	decimal number	None.
AgreementCode	string	None.
Agreement_Breakup_Date	date	None.
Agreement_BreakupBy	integer	None.
Breakup_Penalty	decimal number	None.
Agreement_StartDate	date	None.
Agreement_EndDate	date	None.
OffSetHours	integer	None.
OffSetMinutes	integer	None.
IsActive	boolean	None.
IsDeleted	boolean	None.
CreatedBy	integer	None.
UpdatedBy	integer	None.
RentPropertyManagerID	integer	None.
LogId	integer	None.
UserID	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "LocalTimeZone": "sample string 1",
  "ROWID": "aae62b3f-ca41-40ed-94be-d05924bcda7e",
  "RentAgreementID": 1,
  "LocationID": 2,
  "HST_BidBatchID": 3,
  "HSTRentPropertyManagerID": 4,
  "AgreementStatusID": 1,
  "Tenant_UserProfileID": 5,
  "Rent_Agreement_Months": 6.0,
  "AgreementCode": "sample string 7",
  "Agreement_Breakup_Date": "2026-04-06T21:35:17.5589771-05:00",
  "Agreement_BreakupBy": 1,
  "Breakup_Penalty": 1.0,
  "Agreement_StartDate": "2026-04-06T21:35:17.5599903-05:00",
  "Agreement_EndDate": "2026-04-06T21:35:17.5599903-05:00",
  "OffSetHours": 10,
  "OffSetMinutes": 11,
  "IsActive": true,
  "IsDeleted": true,
  "CreatedBy": 14,
  "UpdatedBy": 15,
  "RentPropertyManagerID": 16,
  "LogId": 1,
  "UserID": 1
}

application/xml, text/xml

Sample:

<RentalAgreemnentCreateModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessAccessLayer.ViewModel.PropertieViews">
  <AgreementCode>sample string 7</AgreementCode>
  <AgreementStatusID>1</AgreementStatusID>
  <Agreement_BreakupBy>1</Agreement_BreakupBy>
  <Agreement_Breakup_Date>2026-04-06T21:35:17.5589771-05:00</Agreement_Breakup_Date>
  <Agreement_EndDate>2026-04-06T21:35:17.5599903-05:00</Agreement_EndDate>
  <Agreement_StartDate>2026-04-06T21:35:17.5599903-05:00</Agreement_StartDate>
  <Breakup_Penalty>1</Breakup_Penalty>
  <CreatedBy>14</CreatedBy>
  <HSTRentPropertyManagerID>4</HSTRentPropertyManagerID>
  <HST_BidBatchID>3</HST_BidBatchID>
  <IsActive>true</IsActive>
  <IsDeleted>true</IsDeleted>
  <LocalTimeZone>sample string 1</LocalTimeZone>
  <LocationID>2</LocationID>
  <LogId>1</LogId>
  <OffSetHours>10</OffSetHours>
  <OffSetMinutes>11</OffSetMinutes>
  <ROWID>aae62b3f-ca41-40ed-94be-d05924bcda7e</ROWID>
  <RentAgreementID>1</RentAgreementID>
  <RentPropertyManagerID>16</RentPropertyManagerID>
  <Rent_Agreement_Months>6</Rent_Agreement_Months>
  <Tenant_UserProfileID>5</Tenant_UserProfileID>
  <UpdatedBy>15</UpdatedBy>
  <UserID>1</UserID>
</RentalAgreemnentCreateModel>

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>