Pages module

This module provides access to manage the contents of Pages. Pages are used for different use cases in News Suite.

Frequency

A Page can resemble your web site's home page, a marketing landing page, a category page, or a mobile application. In this case, it would be a page with 1 active version always. It can also be your publication or magazine, in which you can have a daily edition, weekly, or monthly.

Issue

All pages have at least 1 last published issue.

We have a concept of subpages, available only for print integration with InDesign. For more information, contact our support team.

Dynamic sections

Pages can have configurable lists or what we call, dynamic sections. They can contain a list of articles, categories, or other object types we call Linkables. Your typical use-case for Linkables would be to create your web site's menu or mobile application's menu.

URL Format

You can use GET or POST variables in your requests.

baseUrl/pages.php?action=ACTION&params...

When the visitor token is required, add

&token=TOKEN_HERE

Reference

Some responses may return defined objects inside the JSON that refer to existing classes.

See related:

• Issue
• Category

Pagination

All requests that return lists can support pagination. Add page=PAGE_NUMBER and limit=[1-1000|default:30] (limit per page) to paginate the responses.

List of actions

The parameter "action" determines the action you would like to match. See below list.

list

List all pages. This requires an authenticated API token.

Parameters:

• print: 1 (optional), whether to show pages marked for Print platforms

Response:

data: [ { Issue object } ]

issues_list

Return all matching issues within a specific page.

Parameters:

• pageId: integer, ID of the page
• published: 1 (optional), return only published pages
• date_from: yyyy-mm-dd (optional), starting date
• date_to: yyyy-mm-dd (optional), end date

Response:

data: [ { Issue object } ]

default

Return information about dynamic sections (see intro above) for the latest published issues of this page. This requires an authenticated API token.

Parameters:

• pageId: int, ID of the page
• type: string, the dynamic section's key name
• version: int, if above zero, ad targeting key-value pairs will be returned in Linkables response

Response:

In case the dynamic section is of type "Categories", the response will look like:

data: [ { Category object } ]

In case the dynamic section is of type "Linkables", the response will look like:

data: [ {   title: 'Display text of item',
            value: 'Unique identifier of the object in the system',
            adtargeting: [ { key: key, value: value } ], // conditional
            groups: [ // if exists
            { [ //group 1
                [ {title, value, adtargeting}  ]
              ] //end group 1 
             }
            ]
  } ]