The following includes the details of how to interface with the pool 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][code]id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]pool_id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]name[/code][/td]
[td]text[/td]
[td][/td]
[/tr]
[tr]
[td][code]post_ids[/code][/td]
[td]array[/td]
[td]integers[/td]
[/tr]
[tr]
[td][code]added_post_ids[/code][/td]
[td]array[/td]
[td]integers[/td]
[/tr]
[tr]
[td][code]removed_post_ids[/code][/td]
[td]array[/td]
[td]integers[/td]
[/tr]
[tr]
[td][code]description[/code][/td]
[td]text[/td]
[td][/td]
[/tr]
[tr]
[td][code]category[/code][/td]
[td]string[/td]
[td][collection, series][/td]
[/tr]
[tr]
[td][code]name_changed[/code][/td]
[td]boolean[/td]
[td][/td]
[/tr]
[tr]
[td][code]description_changed[/code][/td]
[td]boolean[/td]
[td][/td]
[/tr]
[tr]
[td][code]is_active[/code][/td]
[td]boolean[/td]
[td]unused[/td]
[/tr]
[tr]
[td][code]is_deleted[/code][/td]
[td]boolean[/td]
[td][/td]
[/tr]
[tr]
[td][code]boolean[/code][/td]
[td]boolean[/td]
[td]unused[/td]
[/tr]
[tr]
[td][code]version[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]updater_id[/code][/td]
[td]integer[/td]
[td]>0[/td]
[/tr]
[tr]
[td][code]created_at[/code][/td]
[td]timestamp[/td]
[td][/td]
[/tr]
[tr]
[td][code]updated_at[/code][/td]
[td]timestamp[/td]
[td][/td]
[/tr]
[tr]
[td][code]updater_addr_ip[/code][/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][code]pool[/code][/td]
[td]pool[/td]
[td]single[/td]
[td]required[/td]
[td][/td]
[/tr]
[tr]
[td][code]updater[/code][/td]
[td]user[/td]
[td]single[/td]
[td]required[/td]
[td][/td]
[/tr]
[/tbody]
[/table]
Nomenclature
- Plural form: "pool_versions"
- Used in the URL pathname
- Singular form: "pool_version"
- Unused
- Version of: API:Pools
Actions
These are the various actions that can be done with pool version records.
Index
[table]
[tbody]
[tr]
[td]HTTP Method[/td]
[td]GET[/td]
[/tr]
[tr]
[td]Base URL[/td]
[td][code]/pool_versions.json[/code][/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
- [code]id[/code]
- [code]pool_id[/code]
- [code]updater_id[/code]
- [code]version[/code]
- [code]created_at[/code]
- [code]updated_at[/code]
- Text syntax
- [code]name[/code]
- [code]description[/code]
- String syntax
- [code]category[/code]
- Boolean syntax
- [code]name_changed[/code]
- [code]description_changed[/code]
- [code]is_active[/code]
- [code]is_deleted[/code]
- Array syntax
- [code]post_ids[/code]
- [code]added_post_ids[/code]
- [code]removed_post_ids[/code]
Special search parameters
- [code]name_matches[/code] - Case-insensitive normalized wildcard search on the name field.
- [code]updater_name[/code] - Case-insensitive updater name to updater ID search.
- [code]post_id[/code] - Searches for a single post being added or removed from a pool.
- [code]is_new[/code] - Boolean syntax
- Shorthand search for [code]version=1[/code] or [code]version=>1[/code]
See also
External links
[table]
[tbody]
[tr]
[td]Controller[/td]
[td]<https://github.com/danbooru/danbooru/blob/master/app/controllers/pool_versions_controller.rb>[/td]
[td][/td]
[/tr]
[tr]
[td]Model[/td]
[td]<https://github.com/danbooru/danbooru/blob/master/app/models/pool_version.rb>[/td]
[/tr]
[tr]
[td]Policy[/td]
[td]<https://github.com/danbooru/danbooru/blob/master/app/policies/pool_version_policy.rb>[/td]
[/tr]
[/tbody]
[/table]