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
* 5. "See also":#dtext-see-also
* 5. "External links":#dtext-external-links

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

pool_id

[/td]

[td]integer[/td]

[td]>0[/td]

[/tr]

[tr]

[td]

name

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

post_ids

[/td]

[td]array[/td]

[td]integers[/td]

[/tr]

[tr]

[td]

added_post_ids

[/td]

[td]array[/td]

[td]integers[/td]

[/tr]

[tr]

[td]

removed_post_ids

[/td]

[td]array[/td]

[td]integers[/td]

[/tr]

[tr]

[td]

description

[/td]

[td]string[/td]

[td][/td]

[/tr]

[tr]

[td]

category

[/td]

[td]string[/td]

[td][collection, series][/td]

[/tr]

[tr]

[td]

name_changed

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

description_changed

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

is_active

[/td]

[td]boolean[/td]

[td]unused[/td]

[/tr]

[tr]

[td]

is_deleted

[/td]

[td]boolean[/td]

[td][/td]

[/tr]

[tr]

[td]

boolean

[/td]

[td]boolean[/td]

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

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]

pool

[/td]

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

h4#nomenclature. Nomenclature

* Plural form: "pool_versions"

** Used in the URL pathname

* Singular form: "pool_version"

** Unused

* Version of: API:Pools

h4#actions. Actions

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

h5#index. Index

[table]

[tbody]

[tr]

[td]HTTP Method[/td]

[td]GET[/td]

[/tr]

[tr]

[td]Base URL[/td]

[td]

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

h6#search-attributes. Search attributes

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

* Number syntax

**

id

**

pool_id

**

updater_id

**

version

**

created_at

**

updated_at

* Text syntax

**

name

**

description

**

category

* Boolean syntax

**

name_changed

**

description_changed

**

is_active

**

is_deleted

* Array syntax

**

post_ids

**

added_post_ids

**

removed_post_ids

h6#special-search-parameters. Special search parameters

*

name_matches

- Case-insensitive normalized wildcard search on the name field.

*

updater_name

- Case-insensitive updater name to updater ID search.

*

post_id

- Searches for a single post being added or removed from a pool.

*

is_new

- Boolean syntax

** Shorthand search for

version=1

or

version=>1

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]