List Issues

Name Description
HTTP Method GET
URL https://api.newsweaver.com/v2/{account code}/publication/{publication code}/issues
Query Parameters Yes
Request representation N/A
Response representation Issue List
Success Response Code 200 Ok
Name Allowed Values Description Default
approval_status approved
draft
all
Filter the list to only include issues with the specified status all
fields [comma separated list of field names] Used to restrict the size of the XML returned by omitting unnecessary fields title
approval_status
display_date
order_asc title
display_title
display_date
issue_number
Sort the list in ascending order by the given field N/A
order_desc title
display_title
display_date
issue_number
Sort the list in descending order by the given field N/A

Errors

  • 403 - Forbidden if API user doesn't have READ access to ISSUES
  • 403 - Forbidden if API user doesn't have access to the publication
  • Common errors (user/account authentication errors, API usage limit errors)

Other notes:

  • Using order_asc and order_desc together is undefined.
  • You cannot sort by multiple fields.

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

<issues total="2" uri="https://api.newsweaver.com/v2/example-account/publication/123/issues">
    <itemsPerPage>1000</itemsPerPage>
    <startIndex>0</startIndex>
    <totalResults>2</totalResults>
    <issue uri="https://api.newsweaver.com/v2/example-account/issue/456">
        <title>May Newsletter</title>
        <approval_status>APPROVED</approval_status>
        <display_date>2013-05-01T23:00:00Z</display_date>
    </issue>
    <issue uri="https://api.newsweaver.com/v2/example-account/issue/789">
        <title>June Newsletter</title>
        <approval_status>DRAFT</approval_status>
        <display_date>2013-06-01T23:00:00Z</display_date>
    </issue>
</issues>

results matching ""

    No results matching ""