photobook_catalogs_get
Reads catalogs in the Photobook app (pApp B00005). Another app code is refused before any request. Catalogs carry the memberships and prices that make posts subscriber-only or paid: read the catalog list, its linked memberships, linked posts, price and details.
Inputs
| Field | Required here | Contract |
|---|---|---|
view |
Yes | When alternative 1: one of: catalogs, catalog_search, catalog_memberships, catalog_contents, catalog_pricing, catalog_details, catalog_bulk_state (by kind) |
view.page |
No | When alternative 1 and view.kind is catalog_search: integer; minimum 1; maximum 1000000; default 1 |
view.limit |
No | When alternative 1 and view.kind is catalog_search: 15 or 30 or 50 or 100; default 15 |
view.search |
No | When alternative 1 and view.kind is catalog_search: string; max length 500 |
view.isActive |
No | When alternative 1 and view.kind is catalog_search: boolean |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_memberships: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$; The catalog ccid (for example CCID…) from the catalogs view, not its numeric id. |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_contents: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$; The catalog ccid (for example CCID…) from the catalogs view, not its numeric id. |
view.postIds |
No | When alternative 1 and view.kind is catalog_contents: array; items: integer; greater than 0; max items 200; Article/Timeline only. Discover IDs with article_posts_get or timeline_posts_get and use the same selection for apply. |
view.seriesIds |
No | When alternative 1 and view.kind is catalog_contents: array; items: integer; greater than 0; max items 200; B00005 only. Discover IDs with photobook_series_get and use the same selection for apply. |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_pricing: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$; The catalog ccid (for example CCID…) from the catalogs view, not its numeric id. |
view.catalogId |
Yes | When alternative 1 and view.kind is catalog_details: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$; The catalog ccid (for example CCID…) from the catalogs view, not its numeric id. |
view.catalogIds |
Yes | When alternative 1 and view.kind is catalog_bulk_state: array; items: string; min length 1; max length 128; pattern ^[A-Za-z0-9_-]+$; The catalog ccid (for example CCID…) from the catalogs view, not its numeric id.; min items 1; max items 100 |
view |
Yes | When alternative 2: object |
view.kind |
Yes | When alternative 2: catalog_creation |