Miyuu's Image Board

Table of Contents

* 01. "Record field format":#dtext-record
* 02. "Associated attributes":#dtext-associations
* 03. "Nomenclature":#dtext-nomenclature
* 04. "Index":#dtext-index
* 05. "Show":#dtext-show
* 06. "Create":#dtext-update
* 07. "See also":#dtext-see-also
* 08. "External links":#dtext-external-links

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

h4#record. 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]

post_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

reason

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

status

[/td]

[td]enum[/td]

[td]See "Status table":[#dtext-status] for list of acceptable values.[/td]

[/tr]

[tr]

[td]

creator_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]

h5#status. Status

[table]

[thead]

[tr]

[th]Value[/th]

[th]Enum[/th]

[/tr]

[/thead]

[tbody]

[tr]

[td]0[/td]

[td]pending[/td]

[/tr]

[tr]

[td]1[/td]

[td]succeeded[/td]

[/tr]

[tr]

[td]2[/td]

[td]rejected[/td]

[/tr]

[/tbody]

[/table]

h4#associations. 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 topic.[/td]

[/tr]

[tr]

[td]

post

[/td]

[td]post[/td]

[td]single[/td]

[td]required[/td]

[td]Post that the appeal belongs to.[/td]

[/tr]

[/tbody]

[/table]

h4#nomenclature. Nomenclature

* Plural form: "post appeals"

** Used in the URL pathname

* Singular form: "post appeal"

** Used for write parameters (Help:API Write Requests)

* Versions: none

h4#index. Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/post_appeals.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is ID descending.[/td]

[/tr]

[/tbody]

[/table]

h5#search-attributes. Search attributes

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

* Number syntax

**

id

**

post_id

**

created_at

**

updated_at

* Text syntax

**

reason

* Enum syntax

**

status

* User syntax

**

creator

* Post syntax

**

status

h5#special-search-parameters. Special search parameters

*

reason_matches

- Case-insensitive wildcard search on the reason field.

h5. Search order

The search order can only be changed with the custom parameter.

h4#show. Show

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/post_appeals/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the post appeal ID.[/td]

[/tr]

[/tbody]

[/table]

h4#create. Create

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/post_appeals.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]

h5#create-parameters. Create parameters

* Required:

**

post_id

**

reason

h4#see-also. See also

* Help:Common URL Parameters

* Help:API

h4#external-links. 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]