GET api/violations/{id}
Get a violation by the id
Request Information
Authentication
This method requires user authentication
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id |
(Required) |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
Violation| Name | Description | Type | Additional information |
|---|---|---|---|
| ViolationId |
Violation Id. Primary key of the violations table. |
integer |
None. |
| PropertyId |
Property Id. See the GET api/properties/{propertyId} route to get the property data. |
integer |
None. |
| UnitId |
Unit Id. See the GET api/units/{unitId} route to get the unit data. |
integer |
None. |
| ActionId |
Action Id. See the GET api/violationactions/{id} route to get the violation action data. |
integer |
None. |
| SubCategoryId |
Sub Category Id. See the GET api/violationsubcategories/{subCategoryId} route to get the sub category data. To get the violation category, use the sub category ID with the GET api/violationsubcategories/{subCategoryId:int}/violationcategories route. |
integer |
None. |
| ViolationDate |
Violation Date. |
date |
None. |
| FineCents |
Fine Cents. |
string |
None. |
| FineAmount1 |
First Fine Amount. |
string |
None. |
| FineAmount2 |
Second Fine Amount. |
string |
None. |
| FineAmount3 |
Third Find Amount. |
string |
None. |
| FineAmount4 |
Fourth Fine Amount. |
string |
None. |
| FineMax |
Maximum Fine Amount. |
string |
None. |
| FineIncrementAmount |
Fine Incremental Amount. |
string |
None. |
| FineIncrement |
Fine Increment Type. |
string |
None. |
| ActionDate |
Action Date. |
date |
None. |
| Comment |
Comments |
string |
None. |
| CorrectInDays |
Correct In Days. |
integer |
None. |
| ViolationNotes |
Violation Notes |
string |
None. |
| VioLastinspectionDate |
Violation Last Inspection Date. |
date |
None. |
| FineScheduleType |
Determines the type of fines being used by the violation: - 0 for TimeBased fining - 1 for Consecutive fining |
integer |
None. |
| PayFineDate |
Fine Payment Date. |
date |
None. |
Response Formats
application/json, text/json
{
"ViolationId": 1,
"PropertyId": 1,
"UnitId": 1,
"ActionId": 1,
"SubCategoryId": 1,
"ViolationDate": "2025-12-24T05:22:35.1384773-05:00",
"FineCents": "sample string 2",
"FineAmount1": "sample string 3",
"FineAmount2": "sample string 4",
"FineAmount3": "sample string 5",
"FineAmount4": "sample string 6",
"FineMax": "sample string 7",
"FineIncrementAmount": "sample string 8",
"FineIncrement": "sample string 9",
"ActionDate": "2025-12-24T05:22:35.1384773-05:00",
"Comment": "sample string 10",
"CorrectInDays": 1,
"ViolationNotes": "sample string 11",
"VioLastinspectionDate": "2025-12-24T05:22:35.1384773-05:00",
"FineScheduleType": 12,
"PayFineDate": "2025-12-24T05:22:35.1384773-05:00"
}
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)