Page

Pages allow you to create content pages and links in your Conventions navigation. You must have the pages ConventionPrivilege to access this. Pages are accessed via /api/page.

Properties

See "Object Properties" in Introduction for basic shared properties.

Complete details in PageProperties.

Related Objects

See "Related Objects" in Introduction for how to use them.

convention

The Convention this page belongs to.

Services

The services used to fetch and manipulate pages.

Search Pages

This will search across all conventions. To search on a single convention see "Relationships" in Convention.

 GET /api/page

Optional Params

query

Searches a partial name.

Returns:

 {
    "paging" : {...},
    "items" : [
        {
          "id" : "xxx",
          "name" : "The Captain is Dead",
          ...
        },
        ...
    ]
 }

Create Page

 POST /api/page

Required Params

convention_id

name

Returns the same as a normal read.

Read Page

 GET /api/page/xxx

Returns:

 {
   "id" : "xxx",
   "name" : "The Captain is Dead",
   ...
 }

Update Page

 PUT /api/page/xxx

Returns the same as a normal read.

Delete Page

 DELETE /api/page/xxx

Returns:

 {
   "success" : 1
 }