GET api/violationcategories?page={page}&pageSize={pageSize}

Returns all violation categories

Request Information

Authentication

This method requires user authentication

URI Parameters

NameDescriptionTypeAdditional information
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

ListWrapperOfViolationCategory
NameDescriptionTypeAdditional information
Total

integer

None.

Elements

Collection of ViolationCategory

None.

Response Formats

application/json, text/json

Sample:
{
  "Total": 1,
  "Elements": [
    {
      "CategoryId": 1,
      "CategoryName": "sample string 2"
    },
    {
      "CategoryId": 1,
      "CategoryName": "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)