All saddle-stitched booklets share this API just using different identities to differentiate by size.
They are all accessed via /api/booklet.
Each booklet has the following properties with complete details in BookletProperties:
The unique id for this booklet. It will never change.
The size of booklet you want. See Identities above.
booklet
A date when the booklet was created.
A date when the booklet was last updated.
The name the booklet is known by.
A Game id. The unique id of a game that this booklet belongs to.
An integer between 1 and 99.
Defaults to 1.
Allows for multiple copies of a booklet to be included in the game.
The number of pages in the booklet.
The list of BookletPages that are attached to this booklet.
The methods used to fetch and manipulate booklets.
POST /api/booklet
Required. The unique session id provided by a Session method.
Required.
Required.
Optional.
Returns:
{
"id" : "xxx",
"name" : "Rules",
...
}
PUT /api/booklet/xxx
See Create for details.
DELETE /booklet/xxx
Required. The unique session id provided by a Session method.
Returns:
{
"success" : 1
}
GET /api/booklet/xxx
Optional. The unique session id provided by a Session method.
Optional. See "Relationships" in Intro and Booklet Relationships above for details.
Returns:
{
"id" : "xxx",
"name" : "Rules",
...
}