Miyuu's Image Board

api:notes

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-create
* 07. "Update":#dtext-update
* 08. "Delete":#dtext-delete
* 09. "Revert":#dtext-revert
* 10. "See also":#dtext-see-also
* 10. "External links":#dtext-external-links

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

body

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

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

is_active

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

version

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

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]

post

[/td]

[td]post[/td]

[td]single[/td]

[td]required[/td]

[td][/td]

[/tr]

[/tbody]

[/table]

h4#nomenclature. Nomenclature

* Plural form: "notes"

** Used in the URL pathname

* Singular form: "note"

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

* Versions: API:Note versions

h4#index. Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/notes.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

**

**

**

width

**

height

**

version

**

created_at

**

updated_at

* Text syntax

**

body

* Boolean syntax

**

is_active

* Post syntax

**

post

h5#special-search-parameters. Special search parameters

*

body_matches

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

h4#show. Show

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/notes/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]read request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the note ID.[/td]

[/tr]

[/tbody]

[/table]

Note: This does a redirect to the post with that note when using the HTML interface, specifically highlighting that note when it gets there.

h4#create. Create

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]POST[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/notes.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[/tbody]

[/table]

h5#create-parameters. Create parameters

* Required:

**

post_id

- The post ID the note belongs to.

**

- X coordinate of the note starting from the left of the image.

**

- y coordinate of the note starting from the top of the image.

**

height

**

width

**

body

* Optional

**

is_active

- Whether the note is active or not (i.e. deleted).

Note: The note box must fit within the full-size dimensions of the image.

h4#update. Update

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT/PATCH[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/notes/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the note ID.[/td]

[/tr]

[/tbody]

[/table]

h5#update-parameters. Update parameters

Accepts the "same parameters":[#dtext-create-parameters] as the "create note action":[#dtext-create], except for the post ID. All parameters are optional.

h4#delete. Delete

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]DELETE[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/notes/$id.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the note ID.[/td]

[/tr]

[/tbody]

[/table]

h4#revert. Revert

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]PUT[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

/notes/$id/revert.json

[/td]

[/tr]

[tr]

[td]Type[/td]

[td]write request[/td]

[/tr]

[tr]

[td]Description[/td]

[td]

$id

is the note ID.[/td]

[/tr]

[/tbody]

[/table]

h5#revert-parameters. Revert parameters

* Required:

** version_id - The note version ID to revert to.

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]