GET v1/Issue/{issueKey}/Pages

This will return all pages for a single issue matching the IssueKey provided.

Roles Allowed

admin, editor

Request Information

URI Parameters

NameDescriptionTypeAdditional information
issueKey

integer

Required

Body Parameters

None.

Response Information

Resource Description

Collection of IssuePage
NameDescriptionTypeAdditional information
PageKey

A unique identifier for an IssuePage

integer

None.

Sequence

The order in which the pages appear in the issue

integer

None.

Spread

Multiple IssuePages with the same 'Spread' value indicate that the pages combine to form a larger page (such as a large image spread across 2-3 pages that unfold).

integer

None.

ImageFile

A URL showing where to find an image for the IssuePage

string

None.

PageName

string

None.

Width

The width in pixels of the IssuePage

integer

None.

Height

The height in pixels of the IssuePage

integer

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "PageKey": 1,
    "Sequence": 2,
    "Spread": 3,
    "ImageFile": "sample string 4",
    "PageName": "sample string 5",
    "Width": 6,
    "Height": 1
  },
  {
    "PageKey": 1,
    "Sequence": 2,
    "Spread": 3,
    "ImageFile": "sample string 4",
    "PageName": "sample string 5",
    "Width": 6,
    "Height": 1
  }
]

application/xml, text/xml

Sample:
<ArrayOfIssuePage xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Bondi.Models.V3.ApiDto">
  <IssuePage>
    <Height>1</Height>
    <ImageFile>sample string 4</ImageFile>
    <PageKey>1</PageKey>
    <PageName>sample string 5</PageName>
    <Sequence>2</Sequence>
    <Spread>3</Spread>
    <Width>6</Width>
  </IssuePage>
  <IssuePage>
    <Height>1</Height>
    <ImageFile>sample string 4</ImageFile>
    <PageKey>1</PageKey>
    <PageName>sample string 5</PageName>
    <Sequence>2</Sequence>
    <Spread>3</Spread>
    <Width>6</Width>
  </IssuePage>
</ArrayOfIssuePage>