Miyuu's Image Board

The following includes the details of how to interface with the forum post records through the API.

Record field format

[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

topic_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

body

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

is_deleted

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

creator_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

updater_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

created_at

[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[tr]

[td]

updated_at

[/td]

[td]timestamp[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Associated attributes

[table]

[thead]

[tr]

[th]Name[/th]

[th]Type[/th]

[th]Number[/th]

[th]Availability[/th]

[th]Details[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]

creator

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td]User that created the forum post.[/td]

[/tr]

[tr]

[td]

updater

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td]User that last updated the forum post.[/td]

[/tr]

[tr]

[td]

topic

[/td]

[td]forum topic[/td]

[td]single[/td]

[td]required[/td]

[td]Forum topic the forum post is on.[/td]

[/tr]

[tr]

[td]

dtext_links

[/td]

[td]dtext link[/td]

[td]multiple[/td]

[td]optional[/td]

[td]Dtext links on the forum post.[/td]

[/tr]

[tr]

[td]

votes

[/td]

[td]forum post vote[/td]

[td]multiple[/td]

[td]optional[/td]

[td]Any votes the forum post may have.[/td]

[/tr]

[tr]

[td]

tag alias

[/td]

[td]tag alias[/td]

[td]multiple[/td]

[td]optional[/td]

[td]Tag aliases linked to the forum post.[/td]

[/tr]

[tr]

[td]

tag implication

[/td]

[td]tag implication[/td]

[td]multiple[/td]

[td]optional[/td]

[td]Tag implications linked to the forum post.[/td]

[/tr]

[tr]

[td]

bulk update request

[/td]

[td]bulk update request[/td]

[td]multiple[/td]

[td]optional[/td]

[td]Bulk update requests linked to the forum post.[/td]

[/tr]

[/tbody]

[/table]

Nomenclature

• Plural form: "forum_posts"
• Used in the URL pathname
• Singular form: "forum_post"
• Used for write parameters (Help:API Write Requests)
• Versions: none

Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/forum_posts.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is updated at descending.[/td]

[/tr]

[/tbody]

[/table]

Search attributes

All of the following are standard attributes with all of their available formats and qualifiers.

• Number syntax

• id

• topic_id

• created_at

• updated_at

• Text syntax

• body

• User syntax

• creator

• updater

• Boolean syntax

• is_deleted

• Chaining syntax

• topic

• dtext_links

• votes

• tag alias

• tag implication

• bulk update request

Special search parameters

• body_matches

  - Case-insensitive wildcard searching on the body text field.

• topic_title_matches

  - Case-insensitive wildcard searching on the topic title the forum post is on.

• topic_category_id

  - Can be: 0, 1, 2 (General, Tags, Bugs & Features respectively).

• linked_to

  - Shows forum posts that link to a particular wiki.
• The parameter must use the same format as the wiki title
• I.e. all lowercase and underscores instead of spaces

Search order

The search order is not configurable with a search parameter. However, the order can still be changed to ID descending by using sequential pagination.

Show

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/forum_posts/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the forum post ID.[/td]

[/tr]

[/tbody]

[/table]

Create

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/forum_posts.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]

Create parameters

• Required:

• body

• topic_id

Update

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/forum_posts/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the forum post ID.[/td]

[/tr]

[/tbody]

[/table]

Update parameters

• Optional:

• body

Delete

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]DELETE[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/forum_posts/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the forum post ID.

Restricted to Moderator+.[/td]

[/tr]

[/tbody]

[/table]

Undelete

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/forum_posts/$id/undelete.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the forum post ID.

Restricted to Moderator+.[/td]

[/tr]

[/tbody]

[/table]

See also

• Help:Common URL Parameters
• Help:API

External links

[table]

[tbody]

[tr]

[td]Controller[/td]

[td][/td]

[td][/td]

[/tr]

[tr]

[td]Model[/td]

[td][/td]

[/tr]

[tr]

[td]Policy[/td]

[td][/td]

[/tr]

[/tbody]

[/table]