Booklet Page

The child element of Booklets are booklet pages, which are accessible via /api/bookletpage.

Properties

Each booklet page has the following properties with full details found at BookletPageProperties:

id

The unique id for this booklet page. It will never change.

wing_object_type

largebookletpage

date_created

A date when the booklet page was created.

date_updated

A date when the booklet page was last updated.

name

The name the booklet page is known by.

sequence_number

An integer between 1 and 20. The order this page should be included. Another way to think of it is the page number.

booklet_id

A Booklet id. The unique id of a booklet that this booklet page belongs to.

image_id

A File id. ets the image of the booklet page. The ID is from a File. If a image_id is specified, then an extra property called image will be added which will briefly describe the image.

has_proofed_image

A boolean indicating whether the image has been verified by the user to be correct.

Related Objects

booklet

The Booklet that this booklet page is a member of.

Methods

The methods used to fetch and manipulate booklet pages.

Create

 POST /api/bookletpage

session_id

Required. The unique session id provided by a Session method.

name

Required.

booklet_id

Required.

sequence_number

Optional.

image_id

Optional.

has_proofed_image

Optional.

Returns:

 {
   "id" : "xxx",
   "name" : "Setup",
   ...
 }

Update

 PUT /api/bookletpage/xxx

See Create for details.

Delete

 DELETE /bookletpage/xxx

session_id

Required. The unique session id provided by a Session method.

Returns:

 {
   "success" : 1
 }

Fetch

 GET /api/bookletpage/xxx

session_id

Optional. The unique session id provided by a Session method.

_include_related_objects

Optional. See "Related Objects" in Intro and Related Objects above for details.

Returns:

 {
   "id" : "xxx",
   "name" : "Setup",
   ...
 }