REST API Documentation
/core/warnreasons
Get list of warn reasons
Parameters
Name | Type | Description |
---|---|---|
page
|
int | Page number |
perPage
|
int | Number of results per page - defaults to 25 |
Exceptions
Code | Message | Description |
---|---|---|
1C292/S |
NO_PERMISSION |
The current authorized user does not have permission to issue warnings and as such cannot view the list of warn reasons |
Response
Name | Type | Description |
---|---|---|
page
|
int | The page number for the results being shown |
perPage
|
int | The number of results that will be on each page |
totalResults
|
int | The total number of results |
totalPages
|
int | The number of pages of results |
results
|
array of reason objects | The results for this page |
reason
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Warn reason name |
defaultNotes
|
string | Default notes for warning (moderator can override) |
points
|
int | The warning points levied with the warning |
pointsOverride
|
bool | Whether the moderator can override the default points or not |
removeOverride
|
bool | Whether the moderator can override when the points will be removed or not |
removePoints
|
string|null | Time frame as a date interval when points will automatically be removed, or null if points do not automatically remove |
pointsAutoRemove
|
bool | Whether points are automatically removed or not |