MediaWiki API help

This is an auto-generated MediaWiki API documentation page.

Documentation and examples: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page

action=bs-bookshelf-bookstore

(main | bs-bookshelf-bookstore)
  • This module requires read rights.
  • Source: BlueSpiceBookshelf
  • License: GPL-3.0-only

Lists all chapters for a given book. Allows sorting, filtering and pagination. Implements ExtJS Store parameters.

Specific parameters:
Other general parameters are available.
sort

JSON string with sorting info; deserializes to array of objects that hold field name and direction for each sorting option

Default: []
group

JSON string with grouping info; deserializes to array of objects that hold field name and direction for each grouping option

Default: []
filter

JSON string with filter info; deserializes to array of objects that hold field name, filter type, and filter value for each filtering option

Default: []
page

Allows server side calculation of start/limit

Type: integer
Default: 0
limit

Number of results to return

Type: integer
Default: 250
start

The offset to start the result list from

Type: integer
Default: 0
callback

A method name in the client code that should be called in the response (JSONP)

query

Similar to filter, but the provided value serves as a filter only for the value field of an ExtJS component

_dc

Disable cache flag

Type: integer
format

The format of the output (only JSON or formatted JSON)

One of the following values: json, jsonfm
Default: json
context

JSON string encoded object with context data for the store

node

Speficies a node for which a subchapter list should be provided.

book

Specifies the book for which a chapter list should be provided.