Miyuu's Image Board

Table of Contents

• 1. Record field format
• 2. Associated attributes
• 3. Nomenclature
• 4. Actions
• 5. See also
• 6. External links

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

note_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

post_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

x

[/td]

[td]integer[/td]

[td]>=0[/td]

[/tr]

[tr]

[td]

y

[/td]

[td]integer[/td]

[td]>=0[/td]

[/tr]

[tr]

[td]

width

[/td]

[td]integer[/td]

[td]>=0[/td]

[/tr]

[tr]

[td]

height

[/td]

[td]integer[/td]

[td]>=0[/td]

[/tr]

[tr]

[td]

body

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

is_active

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

version

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

[tr]

[td]

updater_addr_ip

[/td]

[td]inet[/td]

[td]Limited to Moderator+[/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]

note

[/td]

[td]note[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]

post

[/td]

[td]post[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[tr]

[td]

updater

[/td]

[td]user[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

Nomenclature

¶

• Plural form: "note_versions"

•• Used in the URL pathname

• Singular form: "note_version"

•• Unused

• Version of: API:Notes

Actions

¶

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

Index

¶

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/note_versions.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]

Search attributes

¶

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

• Number syntax

••

id

••

note_id

••

post_id

••

x

••

y

••

width

••

height

••

version

••

created_at

••

updated_at

• Text syntax

••

body

• Boolean syntax

••

is_active

• User syntax

••

updater

Special search parameters

¶

• post_tags_match

  - The post query of the search term matches the post of the note.

• body_matches

  - Case-insensitive wildcard search on the body field.

Show

¶

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/note_versions/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the note version ID.[/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]