Miyuu's Image Board

Table of Contents

* 1. "Record field format":#dtext-record
* 2. "Associated attributes":#dtext-associations
* 3. "Nomenclature":#dtext-nomenclature
* 4. "Actions":#dtext-actions
** 4.01 "Index":#dtext-index
** 4.02 "Show":#dtext-show
** 4.03 "Create":#dtext-create
** 4.04 "Update":#dtext-update
** 4.05 "Mark all as read":#dtext-mark-all-as-read
* 5. "See also":#dtext-see-also
* 6. "External links":#dtext-external-links

The following includes the details of how to interface with the dmail 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]

owner_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

to_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

from_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

title

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

body

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

is_read

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

is_deleted

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

is_spam

[/td]

[td]boolean[/td]

[td]obsolete[/td]

[/tr]

[tr]

[td]

key

[/td]

[td]string[/td]

[td][/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]

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]

owner

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]

to

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]

from

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

h4#nomenclature. Nomenclature

* Plural form: "dmails"

** Used in the URL pathname

* Singular form: "dmail"

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

* Versions: none

h4#actions. Actions

These are the various actions that can be done with dmail records.

h5#index. Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/dmails.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]The default order is ID descending.

Only Dmails to or from the user will be shown, regardless of user level.[/td]

[/tr]

[/tbody]

[/table]

h6#search-attributes. Search attributes

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

* Number syntax

**

id

**

created_at

**

updated_at

* Text syntax

**

title

**

body

* User syntax

**

to

**

from

* Boolean syntax

**

is_read

**

is_deleted

h6#special-search-parameters. Special search parameters

*

title_matches

- Case-insensitive wildcard search on the title fields.

*

message_matches

- Case-insensitive wildcard search on the body field.

*

folder_matches

** received - Shows all dmails to the user.

** unread - Shows all unread dmails to the user.

** sent - Shows all dmails from the user.

** deleted - Shows all dmails deleted by the user.

h5#show. Show

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/dmails/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the dmail ID.

Normally only the owner can see the dmail, unless the correct dmail key is also supplied.[/td]

[/tr]

[/tbody]

[/table]

h6#show-parameters. Show parameters.

*

key

Unique key for every dmail that will allow anyone to view the dmail.

h5#create. Create

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/dmails.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]

h6#create-parameters. Create parameters

* Required:

** To specifier: - must be one of the following

***

to_id

***

to_name

**

title

**

body

h5#update. Update

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/dmails/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the dmail ID.[/td]

[/tr]

[/tbody]

[/table]

h6#update-parameters. Update parameters

* Optional:

**

is_read

**

is_deleted

h5#mark-all-as-read. Mark all as read

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/dmails/mark_all_as_read

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]

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]