GET api/violations/{violationId}/violationletters?page={page}&pageSize={pageSize}

Retrieves violation letter data for a given violation. To retrieve the actual PDF file, the api/files?filePath={filePath} route must be called where the filePath parameter is the PathToFile value that is being returned by this resource.

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
violationId

(Required)

integer

Required

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

ListWrapperOfViolationLetters
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of ViolationLetters

None.

Response Formats

application/json, text/json

Sample:
{
  "Total": 1,
  "Elements": [
    {
      "ViolationLetterId": 1,
      "PropertyId": 1,
      "ViolationId": 1,
      "ActionId": 1,
      "FineImposed": 1.0,
      "HearingDate": "2025-12-24T05:28:52.3846411-05:00",
      "PathToFile": "sample string 2"
    },
    {
      "ViolationLetterId": 1,
      "PropertyId": 1,
      "ViolationId": 1,
      "ActionId": 1,
      "FineImposed": 1.0,
      "HearingDate": "2025-12-24T05:28:52.3846411-05:00",
      "PathToFile": "sample string 2"
    }
  ]
}

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)