News API

Updated: 1 year, 7 months ago

A great tool of Newsroom is the ability to consume news data in JSON format and display your news inside websites and apps.

Newsroom provides the endpoints for news items and newsletter issues including image paths, story text, classifications, dates and published/not published flags so that data can be rendered in websites and apps.

You simply need to make a GET request to a URL such as https://demo.portalhq.com.au/newsroom/public/api/issues/?format=json&ordering=desc&published=true

Below is an example of a newsletter issues JSON response:

[
    {
        "name": "STUDENT UPDATE Term 1 Week 10B 2024",
        "cutoff_date": "2024-04-04",
        "cutoff_time": "12:38:00",
        "slug": "student-update-term-1-week-10b-2024",
        "published": true,
        "pdf_print": null,
        "full_url": "https://example-url.com/news/issue/student-update-term-1-week-10b-2024/",
        "layout_name": "",
        "feature_box_1": "",
        "feature_box_2": "",
        "feature_box_3": "",
        "issue_hero_image": "https://example-url.com/media/school/issue_references/2024/04/04/uploaded-image.jpg",
        "publish_to_staff": false,
        "publish_to_students": true,
        "publish_to_parents": false
    },
    {
        "name": "UPDATE NEWSLETTER Term 1-Week 9-27 March",
        "cutoff_date": "2024-03-28",
        "cutoff_time": "12:46:00",
        "slug": "update-newsletter-term-1-week-9-27-march",
        "published": true,
        "pdf_print": null,
        "full_url": "https://example-url.com/news/issue/update-newsletter-term-1-week-9-27-march/",
        "layout_name": "",
        "feature_box_1": "",
        "feature_box_2": "",
        "feature_box_3": "",
        "issue_hero_image": "https://example-url.com/media/school/issue_references/2024/03/27/uploaded-image.jpg",
        "publish_to_staff": true,
        "publish_to_students": true,
        "publish_to_parents": true
    },
]

Submissions can also be obtained from URL using GET. You simply need to append "/newsroom/public/api/submissions/" onto your portal URL.