GET /health_data/top_offenses

Retrieves Top Offenses in the system sorted by update count.

Retrieves Top Offenses in the system sorted by update count

Table 1. GET /health_data/top_offenses resource details
MIME Type

application/json

Table 2. GET /health_data/top_offenses request parameter details
Parameter Type Optionality Data Type MIME Type Description

Range

header

Optional

String

text/plain

Optional - Use this parameter to restrict the number of elements that are returned in the list to a specified range. The list is indexed starting at zero.

fields

query

Optional

String

text/plain

Optional - Use this parameter to specify which fields you would like to get back in the response. Fields that are not named are excluded. Specify subfields in brackets and multiple fields in the same object are separated by commas.

filter

query

Optional

String

text/plain

Optional - This parameter is used to restrict the elements in a list base on the contents of various fields.
Table 3. GET /health_data/top_offenses response codes
HTTP Response Code Unique Code Description

200

The Top Offenses were retrieved.

403

1009

Access Forbidden for Non Admin users.

422

1005

Unprocessable Entity. Invalid field, filter or Range parameter.

Response Description

An array of TopOffenseData objects. A TopOffenseData object contains the following fields:
  • offense_name - String - The offense name.
  • offense_id - Int - The offense id.
  • count - Long - The update count of an offense.

Response Sample


[
    {
        "count": 42,
        "offense_id": 42,
        "offense_name": "String"
    }
]