GET api/properties/{propertyId}/propertynotes?title={title}&sort={sort}&page={page}&pageSize={pageSize}
Get property notes for a property
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| propertyId |
(Required) |
integer |
Required |
| title |
(Optional)Limits the results by Property Notes Title |
string | |
| sort |
(Optional)The order in which to sort the returned property notes. Defaults to expirationdate descending. The possible values are: expirationdate, datecreated and displaydate |
string | |
| page |
(Optional)The page number of returned records based on the page size |
integer |
0 |
| pageSize |
(Optional)The number of records to return per page |
integer |
0 |
Body Parameters
None.
Response Information
Resource Description
ListWrapperOfPropertyNote| Name | Description | Type | Additional information |
|---|---|---|---|
| Total | integer |
None. |
|
| Elements | Collection of PropertyNote |
None. |
Response Formats
application/json, text/json
Sample:
{
"Total": 1,
"Elements": [
{
"PropertyNoteId": 1,
"PropertyId": 2,
"NoteTitle": "sample string 3",
"DateCreated": "2025-12-24T05:29:12.797942-05:00",
"DisplayDate": "2025-12-24T05:29:12.797942-05:00",
"ExpirationDate": "2025-12-24T05:29:12.797942-05:00",
"Notes": "sample string 4"
},
{
"PropertyNoteId": 1,
"PropertyId": 2,
"NoteTitle": "sample string 3",
"DateCreated": "2025-12-24T05:29:12.797942-05:00",
"DisplayDate": "2025-12-24T05:29:12.797942-05:00",
"ExpirationDate": "2025-12-24T05:29:12.797942-05:00",
"Notes": "sample string 4"
}
]
}
Internal Error Codes
-
106: ResourceNotFound
(The requested resource was not found., NotFound) -
100: MissingRequiredHeader
(Invalid request format. A required HTTP header was not specified., BadRequest) -
118: InvalidHeaderValue
(The value provided for one of the HTTP headers was not in the correct format., BadRequest) -
199: UnknownError
(Internal server error., InternalServerError) -
105: ResourceNotLinkedToUser
(User is trying to access a resource that belongs to a property not linked to the user., Forbidden)