GET v1/Issue/{issueKey}/Cover

This will return a single issue cover page the IssueKey provided.

Request Information

URI Parameters

NameDescriptionTypeAdditional 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

IssuePage
NameDescriptionTypeAdditional information
PageKey

integer

None.

IssueKey

integer

None.

Sequence

integer

None.

Spread

integer

None.

PageName

string

None.

Width

integer

None.

Height

integer

None.

SpreadSequence

integer

None.

ImageFormat

The Format String of the image. Replace the placeholders with a Height and Width pixel value.

string

None.

SecureImageFormat

The Secure local Format String of the image. Replace the placeholders with an index of the image device and size.

string

None.

TogglePage

The corresponding PageRange when toggling from Single Page to Spread

string

None.

HasText

Returns true if the page has text view enabled

boolean

None.

HasTextArticleKey

Returns the Article Key that has text available

integer

None.

HasTextArticleKeys

Returns Article Keys that has text available for this page

string

None.

CoverType

Is the Back Cover?

string

None.

PageSizes

Collection of PageSize

None.

TextArticles

Collection of Object

None.

JumpLinks

Collection of Object

None.

Articles

Collection of Object

None.

Response Formats

application/json, text/json

Sample:
{
  "PageKey": 1,
  "IssueKey": 2,
  "Sequence": 3,
  "Spread": 4,
  "PageName": "sample string 5",
  "Width": 6,
  "Height": 1,
  "SpreadSequence": 7,
  "ImageFormat": "sample string 8",
  "SecureImageFormat": "sample string 9",
  "TogglePage": "sample string 10",
  "HasText": true,
  "HasTextArticleKey": 1,
  "HasTextArticleKeys": "sample string 12",
  "CoverType": "sample string 13",
  "PageSizes": [
    {
      "PageKey": 1,
      "Device": "sample string 2",
      "MaxDeviceWidth": 3,
      "DefaultWidth": 4,
      "DefaultHeight": 5,
      "MaxWidth": 6,
      "MaxHeight": 7,
      "SizeSequence": 8,
      "Pages": "sample string 9"
    },
    {
      "PageKey": 1,
      "Device": "sample string 2",
      "MaxDeviceWidth": 3,
      "DefaultWidth": 4,
      "DefaultHeight": 5,
      "MaxWidth": 6,
      "MaxHeight": 7,
      "SizeSequence": 8,
      "Pages": "sample string 9"
    }
  ],
  "TextArticles": [
    {},
    {}
  ],
  "JumpLinks": [
    {},
    {}
  ],
  "Articles": [
    {},
    {}
  ]
}

application/xml, text/xml

Sample:
<IssuePage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Repository.Models">
  <Articles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </Articles>
  <CoverType>sample string 13</CoverType>
  <HasText>true</HasText>
  <HasTextArticleKey>1</HasTextArticleKey>
  <HasTextArticleKeys>sample string 12</HasTextArticleKeys>
  <Height>1</Height>
  <ImageFormat>sample string 8</ImageFormat>
  <IssueKey>2</IssueKey>
  <JumpLinks xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </JumpLinks>
  <PageKey>1</PageKey>
  <PageName>sample string 5</PageName>
  <PageSizes>
    <PageSize>
      <DefaultHeight>5</DefaultHeight>
      <DefaultWidth>4</DefaultWidth>
      <Device>sample string 2</Device>
      <MaxDeviceWidth>3</MaxDeviceWidth>
      <MaxHeight>7</MaxHeight>
      <MaxWidth>6</MaxWidth>
      <PageKey>1</PageKey>
      <Pages>sample string 9</Pages>
      <SizeSequence>8</SizeSequence>
    </PageSize>
    <PageSize>
      <DefaultHeight>5</DefaultHeight>
      <DefaultWidth>4</DefaultWidth>
      <Device>sample string 2</Device>
      <MaxDeviceWidth>3</MaxDeviceWidth>
      <MaxHeight>7</MaxHeight>
      <MaxWidth>6</MaxWidth>
      <PageKey>1</PageKey>
      <Pages>sample string 9</Pages>
      <SizeSequence>8</SizeSequence>
    </PageSize>
  </PageSizes>
  <SecureImageFormat>sample string 9</SecureImageFormat>
  <Sequence>3</Sequence>
  <Spread>4</Spread>
  <SpreadSequence>7</SpreadSequence>
  <TextArticles xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </TextArticles>
  <TogglePage>sample string 10</TogglePage>
  <Width>6</Width>
</IssuePage>