GET v1/Issue/{issueKey}/Articles
This will return all articles for a single issue matching the IssueKey provided.
Roles Allowed
admin, editor
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
issueKey |
The identifier for the issue you want articles from |
integer |
Required |
Body Parameters
None.
Response Information
Resource Description
A collection of issues
Collection of ArticleForIssueName | Description | Type | Additional information |
---|---|---|---|
ArticleKey |
Unique identifier for an article. |
integer |
None. |
StartingPageName |
The first page an article appears on |
string |
None. |
PageRange |
A description of all of the pages that the article appears on |
string |
None. |
MediaCount |
A count of the number of media for this article |
integer |
None. |
Title | string |
None. |
|
Subtitle |
Initially taken from the Subtitle array from Innodata. |
string |
None. |
ISSN |
International Standard Serial Number |
string |
None. |
Section | string |
None. |
|
Subsection | string |
None. |
|
Teaser |
A short Paragraph to entice a user to read the full article. |
string |
None. |
Notes | string |
None. |
|
IsPublished | boolean |
None. |
|
Genre |
Genre tells us if this article is an article, advertisement, etc. |
Genre |
None. |
WordCount |
Word count SUM from Article Body Paragraphs |
integer |
None. |
Updated |
The last time this article was updated |
date |
None. |
UpdatedBy |
The last user who updated the article |
string |
None. |
Response Formats
application/json, text/json
[ { "ArticleKey": 1, "StartingPageName": "sample string 2", "PageRange": "sample string 3", "MediaCount": 4, "Title": "sample string 5", "Subtitle": "sample string 6", "ISSN": "sample string 7", "Section": "sample string 8", "Subsection": "sample string 9", "Teaser": "sample string 10", "Notes": "sample string 11", "IsPublished": true, "Genre": { "GenreId": 1, "GenreName": "sample string 2" }, "WordCount": 1, "Updated": "2024-10-31T10:01:25.4303573+00:00", "UpdatedBy": "sample string 12" }, { "ArticleKey": 1, "StartingPageName": "sample string 2", "PageRange": "sample string 3", "MediaCount": 4, "Title": "sample string 5", "Subtitle": "sample string 6", "ISSN": "sample string 7", "Section": "sample string 8", "Subsection": "sample string 9", "Teaser": "sample string 10", "Notes": "sample string 11", "IsPublished": true, "Genre": { "GenreId": 1, "GenreName": "sample string 2" }, "WordCount": 1, "Updated": "2024-10-31T10:01:25.4303573+00:00", "UpdatedBy": "sample string 12" } ]
application/xml, text/xml
<ArrayOfArticleForIssue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto"> <ArticleForIssue> <Genre> <GenreId>1</GenreId> <GenreName>sample string 2</GenreName> </Genre> <ISSN>sample string 7</ISSN> <IsPublished>true</IsPublished> <Notes>sample string 11</Notes> <Section>sample string 8</Section> <Subsection>sample string 9</Subsection> <Subtitle>sample string 6</Subtitle> <Teaser>sample string 10</Teaser> <Title>sample string 5</Title> <Updated>2024-10-31T10:01:25.4303573+00:00</Updated> <UpdatedBy>sample string 12</UpdatedBy> <WordCount>1</WordCount> <ArticleKey>1</ArticleKey> <MediaCount>4</MediaCount> <PageRange>sample string 3</PageRange> <StartingPageName>sample string 2</StartingPageName> </ArticleForIssue> <ArticleForIssue> <Genre> <GenreId>1</GenreId> <GenreName>sample string 2</GenreName> </Genre> <ISSN>sample string 7</ISSN> <IsPublished>true</IsPublished> <Notes>sample string 11</Notes> <Section>sample string 8</Section> <Subsection>sample string 9</Subsection> <Subtitle>sample string 6</Subtitle> <Teaser>sample string 10</Teaser> <Title>sample string 5</Title> <Updated>2024-10-31T10:01:25.4303573+00:00</Updated> <UpdatedBy>sample string 12</UpdatedBy> <WordCount>1</WordCount> <ArticleKey>1</ArticleKey> <MediaCount>4</MediaCount> <PageRange>sample string 3</PageRange> <StartingPageName>sample string 2</StartingPageName> </ArticleForIssue> </ArrayOfArticleForIssue>