REST API

REST API

Legacy Poppulo platform REST API

Get Issue

Overview

NameDescription
HTTP MethodGET
URLhttps://api.newsweaver.com/v2/{account code}/issue/{issue id}
Query ParametersN/A
Request representationN/A
Response representationIssue
Success Response Code200 Ok

Errors

  • 403 - Forbidden if API user doesn't have READ access to ISSUES
  • 403 - Forbidden if API user doesn't have access to the issue's publication
  • 404 - Not Found if issue does not exist
  • Common errors (user/account authentication errors, API usage limit errors)

Example: GET https://api.newsweaver.com/v2/sample-account/issue/123

<issue uri="https://api.newsweaver.com/v2/example-account/issue/123">
    <link href="https://api.newsweaver.com/v2/example-account/issue/123" rel="edit" title="Edit: Issue (123)"/>
    <title>June Newsletter</title>
    <template>54321</template>
    <properties>
        <property name="Useful links" type="RICHTEXT">
            <value>
                &lt;a href="[@cover_page_link /]"&gt;Cover Page &gt;&gt;&lt;/a&gt;&lt;br /&gt; &lt;a href="[@generic_page_link templatePageOriginalId=12345 /]"&gt;Print All &gt;&gt;&lt;/a&gt;&lt;br /&gt; &lt;a href="[@generic_page_link templatePageOriginalId=67890 pdf=true /]"&gt;PDF Version &gt;&gt;&lt;/a&gt;
            </value>
        </property>
    </properties>
    <issue_number>18</issue_number>
    <display_date>2013-06-12T23:00:00Z</display_date>
    <approval_status>DRAFT</approval_status>
    <link href="https://api.newsweaver.com/v2/example-account/issue/123/articles" rel="http://api-info.newsweaver.com/v2/rels/issue.articles" title="Issue (123) Articles"/>
    <link href="https://api.newsweaver.com/v2/example-account/issue/123/mailings" rel="http://api-info.newsweaver.com/v2/rels/issue.mailings" title="Issue (123) Mailings"/>
    <link href="https://api.newsweaver.com/v2/example-account/issue/123/preview" rel="http://api-info.newsweaver.com/v2/rels/issue.preview" title="Issue (123) Preview"/>
    <link href="https://api.newsweaver.com/v2/example-account/publication/456" rel="http://api-info.newsweaver.com/v2/rels/issue.publication" title="Publication (456)"/>
</issue>