GET v1/Issue/{issueKey}

This will return 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	integer	Required

Body Parameters

None.

Response Information

Resource Description

HTTP 200 with Issue if found, HTTP 404 Otherwise

Issue

Name	Description	Type	Additional information
IssueKey	A unique key identifying the issue	integer	None.
IssueID		string	None.
CoverDate	A date object showing the date on the cover	date	None.
Volume		string	None.
IssueNumber		string	None.
IsLive	Controls whether or not the issue is visible to customers using the site (the issue is always visible to users on the admin site).	boolean	None.
GoLiveDate	The date this issue went live	date	None.
LastIndex	The last time this issue was indexed for searching	date	None.
GenreCounts	An Issue has multiple Articles. Each article has a Genre, such as 'Ad' or 'Article. GenreCount will give the number of articles of each genre for the issue. For example, an Issue might have 5 Ads and 8 Articles.	Collection of GenreCount	None.
Featured	Controls whether the issue is marked Featured	boolean	None.
Priority	Controls the priority in which the issue is displayed	integer	None.
IssueIdentifier	Issue GUID used for previewing issues	globally unique identifier	None.
CoverDisplayDate	A string showing exactly how the date is displayed on the cover	string	None.
IssueName		string	None.

Response Formats

application/json, text/json

Sample:

{
  "IssueKey": 1,
  "IssueID": "sample string 2",
  "CoverDate": "2024-10-31T09:44:01.860633+00:00",
  "Volume": "sample string 4",
  "IssueNumber": "sample string 5",
  "IsLive": true,
  "GoLiveDate": "2024-10-31T09:44:01.860633+00:00",
  "LastIndex": "2024-10-31T09:44:01.860633+00:00",
  "GenreCounts": [
    {
      "Genre": "sample string 1",
      "Count": 2
    },
    {
      "Genre": "sample string 1",
      "Count": 2
    }
  ],
  "Featured": true,
  "Priority": 1,
  "IssueIdentifier": "1aff8579-5037-4413-bcc1-10cf4f208bd0",
  "CoverDisplayDate": "sample string 8",
  "IssueName": "sample string 9"
}

application/xml, text/xml

Sample:

<Issue xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <CoverDisplayDate>sample string 8</CoverDisplayDate>
  <IssueName>sample string 9</IssueName>
  <CoverDate>2024-10-31T09:44:01.860633+00:00</CoverDate>
  <Featured>true</Featured>
  <GenreCounts>
    <GenreCount>
      <Count>2</Count>
      <Genre>sample string 1</Genre>
    </GenreCount>
    <GenreCount>
      <Count>2</Count>
      <Genre>sample string 1</Genre>
    </GenreCount>
  </GenreCounts>
  <GoLiveDate>2024-10-31T09:44:01.860633+00:00</GoLiveDate>
  <IsLive>true</IsLive>
  <IssueID>sample string 2</IssueID>
  <IssueIdentifier>1aff8579-5037-4413-bcc1-10cf4f208bd0</IssueIdentifier>
  <IssueKey>1</IssueKey>
  <IssueNumber>sample string 5</IssueNumber>
  <LastIndex>2024-10-31T09:44:01.860633+00:00</LastIndex>
  <Priority>1</Priority>
  <Volume>sample string 4</Volume>
</Issue>