api:post flags
Table of Contents
- 01. Record field format
- 02. Associated attributes
- 03. Nomenclature
- 04. Index
- 05. Show
- 06. Create
- 07. See also
- 08. External links
The following includes the details of how to interface with the post flag records through the API.
Record field format
| Name | Type | Details |
|---|---|---|
id | integer | >0 |
post_id | integer | >0 |
reason | string | |
status | enum | See Status table for list of acceptable values. |
is_resolved | boolean | |
creator_id | integer | >0, limited to Moderator+ or the flag creator |
created_at | timestamp | |
updated_at | timestamp |
Status
| Value | Enum |
|---|---|
| 0 | pending |
| 1 | succeeded |
| 2 | rejected |
Associated attributes
| Name | Type | Number | Availability | Details |
|---|---|---|---|---|
post | post | single | required | Post that the flag belongs to. |
Nomenclature
- Plural form: "post flags"
- Used in the URL pathname
- Singular form: "post flag"
- Used for write parameters (Help:API Write Requests)
- Versions: none
Index
| HTTP Method | GET |
| Base URL | /post_flags.json |
| Type | read request |
| Description | The default order is ID descending. |
Search attributes
All of the following are standard attributes with all of their available formats and qualifiers.
- Number syntax
idpost_idcreated_atupdated_at- Text syntax
reason- Boolean syntax
is_resolved- Enum syntax
status- Post syntax
status
Special search parameters
reason_matches- Case-insensitive wildcard search on the reason field.creator_id- Searches for flags by creator ID. Single ID only.creator_name- Searches for flags by creator name. Single name only.category_matches- Can be: normal, unapproved, rejected, deleted.
Search order
The search order can only be changed with the custom parameter.
Show
| HTTP Method | GET |
| Base URL | /post_flags/$id.json |
| Type | read request |
| Description | $id is the post flag ID. |
Create
| HTTP Method | POST |
| Base URL | /post_flags.json |
| Type | write request |
Create parameters
- Required:
post_idreason