GET residentapi/units/{unitId}/violations?page={page}&pageSize={pageSize}&sort={sort}

Get all open violations including any violation letters for a unit id

Request Information

URI Parameters

NameDescriptionTypeAdditional information
unitId

(Required)

integer

Required

page

The page number of returned records based on the page size

integer

0

pageSize

The number of records to return per page

integer

0

sort

(Optional) Can sort by using the following strings 'createddate', 'description', 'action', 'inspectiondate'

string

Body Parameters

None.

Response Information

Resource Description

ListWrapperOfViolation
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of Violation

None.

Response Formats

application/json, text/json

Sample:
{
  "total": 1,
  "elements": [
    {
      "violationId": 1,
      "createdOn": "2025-12-24T09:15:22.0485799-05:00",
      "unitNumber": "sample string 3",
      "lastInspectionDate": "2025-12-24T09:15:22.0485799-05:00",
      "hearingDate": "2025-12-24T09:15:22.0485799-05:00",
      "status": "sample string 5",
      "description": "sample string 6",
      "action": "sample string 7",
      "letters": [
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2",
          "createdOn": "2025-12-24T09:15:22.0485799-05:00"
        },
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2",
          "createdOn": "2025-12-24T09:15:22.0485799-05:00"
        }
      ]
    },
    {
      "violationId": 1,
      "createdOn": "2025-12-24T09:15:22.0485799-05:00",
      "unitNumber": "sample string 3",
      "lastInspectionDate": "2025-12-24T09:15:22.0485799-05:00",
      "hearingDate": "2025-12-24T09:15:22.0485799-05:00",
      "status": "sample string 5",
      "description": "sample string 6",
      "action": "sample string 7",
      "letters": [
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2",
          "createdOn": "2025-12-24T09:15:22.0485799-05:00"
        },
        {
          "fileName": "sample string 1",
          "fileUrl": "sample string 2",
          "createdOn": "2025-12-24T09:15:22.0485799-05:00"
        }
      ]
    }
  ]
}