REST API Documentation
/core/members/{id}/warnings
Store a new warning for the member
The warning will be issued as the current authorized user if using an OAuth access token, otherwise the 'moderator' parameter must be specified to indicate which moderator the warning should be issued from
Parameters
Name | Type | Description |
---|---|---|
Required
moderator
|
int|null | Member ID of the moderator to issue the warning from |
reason
|
int|null | Warn reason to use for this warning |
points
|
int|null | Points to issue for the warning. Will use the points from the reason if not specified and a reason is, or if the reason does not allow points to be overridden. |
deductPoints
|
int|null | Achievement points to deduct. Will use the points deduction from the reason if not specified and a reason is, or if the reason does not allow deductions to be overriden. |
memberNote
|
string|null | Note to display to the member as HTML (e.g. "<p>This is a comment.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type. |
moderatorNote
|
string|null | Note to display to moderators as HTML (e.g. "<p>This is a comment.</p>"). Will be sanatized for requests using an OAuth Access Token for a particular member; will be saved unaltered for requests made using an API Key or the Client Credentials Grant Type. |
acknowledged
|
bool | Whether the warning should be considered acknowledged by the member or not |
modQueue
|
datetime|int|null | Date to place in moderator queue until or -1 to place in moderator queue indefinitely. NULL to not place member in moderator queue. |
restrictPosts
|
datetime|int|null | Date to restrict posts until or -1 to restrict posts indefinitely. NULL to not restrict posts. |
suspend
|
datetime|int|null | Date to suspend member until or -1 to suspend indefinitely. NULL to not suspend. |
expire
|
datetime|int|null | Date to expire warn points after or -1 to not expire warn points. Will use the warn points expiration from the warn reason if not specified and a reason is, or if the reason does not allow warn point removal to be overridden. NULL to not expire. |
Exceptions
Code | Message | Description |
---|---|---|
2C292/G |
NO_PERMISSION |
The authorized user does not have permission to warn the member |
2C292/O |
INVALID_ID |
The member could not be found |
1C292/Y |
MODERATOR_REQUIRED |
When not using an OAuth access token a moderator member ID must be supplied |
1C292/Z |
INVALID_DATE |
An invalid datetime was supplied for the expire parameter |
1C292/12 |
INVALID_DATE |
An invalid datetime was supplied for the suspend parameter |
1C292/11 |
INVALID_DATE |
An invalid datetime was supplied for the restrictPosts parameter |
1C292/10 |
INVALID_DATE |
An invalid datetime was supplied for the modQueue parameter |
Response
Name | Type | Description |
---|---|---|
id
|
int | ID number |
member
|
member object | Member who was warned |
moderator
|
member object | Moderator who performed the warning |
points
|
int | The points issued for the warning |
reason
|
reason object | Warn reason if one was specified |
expiration
|
datetime|int | Date the warning expires, or -1 if the warning does not expire |
date
|
datetime | Date the warning was issued |
acknowledged
|
bool | Whether or not the warning has been acknowledged |
memberNotes
|
string | Warn notes left for the member |
moderatorNotes
|
string | Warn notes visible to moderators |
modQueuePermanent
|
bool | Member is permanently moderator queued |
modQueue
|
string|NULL | DateTimeInterval (from date) when the member will be removed from the moderator queue or null |
restrictPostsPermanent
|
bool | Member is permanently on post restriction |
restrictPosts
|
string|NULL | DateTimeInterval (from date) when the member will be removed from post restriction or null |
suspendPermanent
|
bool | Member is permanently on suspension |
suspend
|
string|NULL | DateTimeInterval (from date) when the member will be unsuspended or null |
member
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Username |
title
|
string | Member title |
timezone
|
string | Member timezone |
formattedName
|
string | Username with group formatting |
primaryGroup
|
group object | Primary group |
secondaryGroups
|
array of group objects | Secondary groups |
email
|
string | Email address |
joined
|
datetime | Registration date |
registrationIpAddress
|
string | IP address when registered |
warningPoints
|
int | Number of active warning points |
reputationPoints
|
int | Number of reputation points |
photoUrl
|
string | URL to photo (which will be the site's default if they haven't set one) |
photoUrlIsDefault
|
bool | Indicates if the value of photoUrl is the site's default |
coverPhotoUrl
|
string | URL to profile cover photo (will be blank if there isn't one) |
profileUrl
|
string|null | URL to profile |
validating
|
bool | Whether or not the validating flag is set on the member account |
posts
|
int | Number of content item submissions member has made |
lastActivity
|
datetime|null | Last activity date on the site. |
lastVisit
|
datetime|null | Last distinct visit date on the site. |
lastPost
|
datetime|null | Latest content submission date. |
profileViews
|
int | Number of times member's profile has been viewed |
birthday
|
string | Member birthday in MM/DD/YYYY format (or MM/DD format if no year has been supplied). |
customFields
|
array of fieldgroup objects | Custom profile fields. For requests using an OAuth Access Token for a particular member, only fields the authorized user can view will be included |
rank
|
array of rank objects | Rank |
achievements_points
|
int | Points |
allowAdminEmails
|
bool | Whether or not this member wants to receive admin emails |
completed
|
bool | Whether or not the registration is completed |
group
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Name |
formattedName
|
string | Name with formatting |
rank
object
Name | Type | Description |
---|---|---|
id
|
int | ID number |
name
|
string | Name |
url
|
string | Path to the rank icon |
points
|
int | Points |
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 |