Table of Contents

• 1. Record field format
• 2. Associated attributes
• 3. Nomenclature
• 4. Actions
• 4.01 Index
• 5. See also

The following includes the details of how to interface with the pool version records through the API.

Record field format

Name	Type	Details
id	integer	>0
pool_id	integer	>0
name	string
post_ids	array	integers
added_post_ids	array	integers
removed_post_ids	array	integers
description	string
category	string	[collection, series]
name_changed	boolean
description_changed	boolean
is_active	boolean	unused
is_deleted	boolean
boolean	boolean	unused
version	integer	>0
updater_id	integer	>0
created_at	timestamp
updated_at	timestamp
updater_addr_ip	inet	Limited to Moderator+

Associated attributes

Name	Type	Number	Availability	Details
pool	pool	single	required
updater	user	single	required

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

HTTP Method	GET or POST [1]
Base URL	/pool_versions.json
Type	read request
Description	The default order is ID descending.

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

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

See also

[1] Help:API read requests

• Help:Common URL Parameters
• Help:API

View wiki