Introduction

Available URLs

GET /PCCIS/V1/Document/q/Attributes?DocumentID=[e,u]{ViewingSessionId}&DesiredPageCountConfidence={DesiredPageCountConfidence}

Gets a page count for the source document of a viewing session.

Request

Query String Parameters

Successful Response

JSON metadata about the document page count.

• pageCount (Integer) - Currently determined number of pages in the document.
• pageCountConfidence (Integer) - An integer from 0 to 100 indicating the confidence that pageCount is accurate. When less than 100, pageCount is still being determined and the current value should be considered an estimate. You can repeat the request to see if a more accurate pageCount is available. When 100, the pageCount has been finalized and the value should be considered the actual number of pages in the document.

Example

GET prizmdoc_server_base_url/PCCIS/V1/Document/q/Attributes?DocumentID=uXYZ...

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
    "pageCount": 3,
    "pageCountConfidence": 100
}

GET /PCCIS/V1/Page/q/{PageNumber}/Attributes?DocumentID=[e,u]{viewingSessionId}&ContentType={ContentType}

Gets metadata for a page of the source document of a viewing session.

Request

URL Parameters

Query String Parameters

Successful Response

JSON metadata about the page.

• version (String) - Deprecated. Value will always be "7.1".
• contentType (String) - Comma-separated types of content available, hard-coded to a specific set of values depending on the requested ContentType:
  • Will be "jpeg,png,svg" when requested ContentType is svg (or svga, or svgb)
  • Will be "jpeg,png" when requested ContentType is png
• imageBitDepth (Integer) - Bit depth of raster content. Only relevant when requested ContentType is png. When requested ContentType is svg (or svga or svgb), the value will be hard-coded to 16.
• imageHeight (Integer) - Height of the page:
  • in pixels when requested ContentType is png
  • in unspecified units when requested ContentType is svg (or svga or svgb)
• imageWidth (Integer) - Width of the page:
  • in pixels when requested ContentType is png
  • in unspecified units when requested ContentType is svg (or svga or svgb)
• imageXResolution (Integer) - Relative horizontal resolution of raster content when requested ContentType is png (like pixels per inch except that the unit is unspecified and will not necessarily be inches). When requested ContentType is svg (or svga or svgb), the value will be hard-coded to 90.
• imageYResolution (Integer) - Relative vertical resolution of raster content when requested ContentType is png (like pixels per inch except that the unit is unspecified and will not necessarily be inches). When requested ContentType is svg (or svga or svgb), the value will be hard-coded to 90.

Examples

Get attributes for the SVG form page 0. The two most-valuable properties are "imageHeight" and "imageWidth" which indicate the width and height of the SVG page in unspecified units. The rest are hard-coded values:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "version": "7.1",
  "contentType": "jpeg,png,svg",
  "imageBitDepth": 16,
  "imageHeight": 842,
  "imageWidth": 595,
  "imageXResolution": 90,
  "imageYResolution": 90
}

Get attributes for the raster form of page 0:

GET prizmdoc_server_base_url/PCCIS/V1/Page/q/0/Attributes?DocumentID=uXYZ...?ContentType=png

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "version": "7.1",
  "contentType": "jpeg,png",
  "imageBitDepth": 8,
  "imageHeight": 1755,
  "imageWidth": 1240,
  "imageXResolution": 150,
  "imageYResolution": 150
}

GET /PCCIS/V1/Page/q/{PageNumber}?DocumentID=[e,u]{ViewingSessionId}&Scale={Scale}&ContentType={ContentType}

Gets SVG or an image for a page of the source document of a viewing session.

Request

Request Headers

URL Parameters

Query String Parameters

Successful Response with Page Content

Response Headers

Response Body

SVG, PNG, or JPEG for the requested page.

Examples

Get page 0 as SVG

Request:

GET prizmdoc_server_base_url/PCCIS/V1/Page/q/0?DocumentID=uXYZ...&ContentType=svgb

Response:

HTTP/1.1 200 OK
Content-Type: image/svg+xml
Content-Encoding: gzip
Accusoft-Data-Encrypted: false

<svg height="842" style="font-family:qsnvcgduoqekywbefqyyjjhodpw;font-size:12px;" version="1.2" viewBox="0 0 595 842" width="595"
  xmlns="http://www.w3.org/2000/svg"
  xmlns:xlink="http://www.w3.org/1999/xlink">
  ...
</svg>

Get page 0 as a PNG

GET prizmdoc_server_base_url/PCCIS/V1/Page/q/0?DocumentID=uXYZ...&ContentType=png

Response:

HTTP/1.1 200 OK
Content-Type: image/png
Accusoft-Data-Encrypted: false

<<PNG bytes>>

Response When SVG Content is Not Available

SVG content is typically preferred but not always available. For example, if the source document is raster (such as a TIFF), then only raster page content (PNG and JPEG) will be available. It is common for a client viewer to always try and request SVG content first. Then, once it becomes clear SVG is not available, the client viewer can fallback to only requesting PNG or JPEG page content.

For this reason, if SVG is requested but is not available, we respond with a successful HTTP 200 but with a JSON body indicating that SVG is not available. Additionally, we include raster page attributes metadata in the JSON so that the viewer does not need to issue an additional request for page attributes.

Example

Request:

GET prizmdoc_server_base_url/PCCIS/V1/Page/q/0?DocumentID=uXYZ...&ContentType=svgb

Response when SVG is not available:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8

{
  "errorCode": "SvgNotAvailable",
  "pageAttributes": {
    "version": "7.1",
    "contentType": "jpeg,png",
    "imageBitDepth": 8,
    "imageHeight": 280,
    "imageWidth": 593,
    "imageXResolution": 72,
    "imageYResolution": 72
  }
}

GET /PCCIS/V1/Page/q/{PageNumber}/Tile/{X}/{Y}/{Width}/{Height}?DocumentID=[e,u]{ViewingSessionId}&ContentType={ContentType}&Scale={Scale}

Gets a "tile" image, a part of a page, for a page of the source document of a viewing session.

Request

URL Parameters

Query String Parameters

Successful Response

Response Headers

Response Body

Tile image.

Example

Request a 512x512 PNG tile for page 0 starting at x-position 1024 (from left) and y-position 1536 (from top):

GET prizmdoc_server_base_url/PCCIS/V1/Page/q/0/Tile/1024/1536/512/512?DocumentID=uXYZ...

HTTP/1.1 200 OK
Content-Type: image/png

<<PNG bytes>>

GET /PCCIS/V1/Page/q/{PageNumber}/{Width}x{Height}?DocumentID=[e,u]{ViewingSessionId}&ContentType={ContentType}

Gets a thumbnail image for a page of the source document of a viewing session.

The page will be resized, maintaining aspect ratio, to fit within the {Width} and {Height} specified in the URL.

Request

URL Parameters

Query String Parameters

Successful Response

Response Headers

Response Body

Thumbnail image.

Example

Request a thumbnail image of page 0 that fits within a 200x200 square:

GET prizmdoc_server_base_url/PCCIS/V1/Page/q/0/200x200?DocumentID=uXYZ...

HTTP/1.1 200 OK
Content-Type: image/png

<<PNG bytes>>

GET /PCCIS/V1/Document/q/{PageNumberBegin}-{PageNumberEnd}/Text?DocumentID=[e,u]{ViewingSessionId}

Gets currently-available text and text metadata for a range of pages for the source document of a viewing session.

NOTE: This URL is designed to support our viewer. If you want to simply programmatically extract text from a document, use the Search Contexts API instead, specifically [POST /v2/searchContexts] and [GET /v2/searchContexts/{contextId}/records].

Request

URL Parameters

Query String Parameters

Request Headers

Successful Response

Response Headers

Response Body

JSON containing page text and text positioning metadata.

• pages[] (Array of Objects) Always present in case of success. Optional in case of failure. Will contain an array of objects, each containing text data for a page, for pages where text has been successfully extracted. Note, however, that text extraction takes time and text may not yet be available for the range of pages requested. If the array is empty or contains fewer items than the number of pages included in your page range, then the text for the requested page range has not been fully extracted. Repeating the request should eventually produce an array with the expected number of items. Note also that the order of the records is not guaranteed; you must use the number property of each returned item to know its page index. Items may contain:
  • number (Integer) Always present. Page index (zero-indexed page number). The property is named simply number for backwards compatibility reasons.
  • text (String) Page text.
  • errorCode (Integer) When text cannot be extracted for this page, present with a value of 1.
  • errorDescription (String) When text cannot be extracted for this page, a descriptive error message explaining why (such as "No page data was found.") or an empty string if the cause of the error is unknown.
  • width (Number) Page width.
  • height (Number) Page height.
  • rectangles[] (Array of Arrays) Bounding boxes for individual glyphs on the page. Each item will contain four numbers:
    • [0] (Number) Distance from the left edge of the page to the left edge of the glyph bounding box.
    • [1] (Number) Distance from the top edge of the page to the top edge of the glyph bounding box.
    • [2] (Number) Width of the glyph bounding box.
    • [3] (Number) Height of the glyph bounding box.
  • markup[] (Array of Objects) Objects describing hyperlinks, if any. Each item may contain:
    • changeType (String) Value will always be "Add".
    • markType (String) Value will always be "DocumentHyperlink".
    • properties (Object) Properties of the hyperlink.
      • href (String) Destination URL.
      • rectangle (Object) Dimensions of the hyperlink bounding box on the page.
        • x (Number) Distance from the left edge of the page to the left edge of the hyperlink bounding box.
        • y (Number) Distance from the top edge of the page to the top edge of the hyperlink bounding box.
        • width (Number) Width of the hyperlink bounding box.
        • height (Number) Height of the hyperlink bounding box.
      • borderThickness (Number) Border thickness which should be applied.
      • borderHorizontalRadius (Number) Horizontal border radius which should be applied.
      • borderVerticalRadius (Number) Vertical border radius which should be applied.
      • borderOpacity (Integer) Border opacity which should be applied. Value will be from 0 to 255, where 0 represents fully transparent and 255 represents fully opaque.
• errorCode (Integer) Might be present in case of failure and missing pages[] object. When text cannot be extracted for this page, present with a value of 1.
• errorDescription (String) Might be present in case of failure and missing pages[] object. When text cannot be extracted for this page, a descriptive error message explaining why (such as "No page data was found.") or an empty string if the cause of the error is unknown.

Examples

Request text for pages 0 through 9:

GET prizmdoc_server_base_url/PCCIS/V1/Document/q/0-9/Text?DocumentID=xXYZ...

Response when text is not yet available:

HTTP/1.1 200 OK
Content-Type: application/json;charset=utf-8
Accusoft-Data-Encrypted: false

{
  "pages": []
}

Response when text is available (where ... indicates that data has been omitted for brevity):

HTTP/1.1 200 OK
Content-Type: application/json

{
  "pages": [
    {
      "number": 0,
      "text": "the page text",
      "width": 648.00,
      "height": 828.00,
      "rectangles": [
        [
          202.25,
          135.05,
          27.00,
          73.26
        ],
        [
          229.25,
          135.05,
          30.00,
          73.26
        ],
        ...
      ]
      "markup": [
        {
          "changeType": "Add",
          "markType": "DocumentHyperlink",
          "properties": {
            "rectangle": {
              "height": 14.71,
              "width": 86.20,
              "y": 73.50,
              "x": 71.31
            },
            "borderHorizontalRadius": 0.0,
            "borderVerticalRadius": 0.0,
            "borderThickness": 0.0,
            "href": "http://www.google.com/",
            "borderOpacity": 255
          }
        },
        ...
      ]
    },
    ...
  ]
}

GET /v2/viewingSessions/{viewingSessionId}/revisionData?limit={limit}&continueToken={continueToken}

Gets objects which describe known changes between the two documents used as input to a comparison viewing session.

This URL is designed to give you an array of changes in chunks as the individual changes become available. Each GET request will return the currently-known changes up to a limit (default is 100). If a response contains a continueToken, it indicates that additional changes may be available and that you should issue another GET request using that continueToken as a query string parameter to skip the changes you have already received. As long as a response contains a continueToken, use it to issue a subsequent GET for more changes. When you encounter a response which does not have a continueToken, you have received all of the changes and no more GET requests are necessary.

In order to optimize the number of network requests you make, any response which contains a continueToken will also contain a continueAfter value with a recommended number of milliseconds you should wait before sending the next GET request.

Request

URL Parameters

Request Headers

Successful Response

Response Headers

Response Body

JSON with any available changes.

• changes (Array of Objects) Always present. Array of newly-available changes, objects which each describe a difference between the two documents being compared. If no new changes are available, this array will be empty.
  • id (Integer) Unique number assigned to this change.
  • endPageIndex (Integer) Zero-indexed page number where this change ends in the document.
  • type (String) Type of the change. Will be one of the following:
    • "contentInserted"
    • "contentDeleted"
    • "propertyChanged"
    • "paragraphNumberChanged"
    • "paragraphPropertyChanged"
    • "tablePropertyChanged"
    • "sectionPropertyChanged"
    • "styleDefinitionChanged"
    • "contentMovedFrom"
    • "contentMovedTo"
    • "tableCellInserted"
    • "tableCellDeleted"
    • "tableCellsMerged"
• continueToken (String) When present, indicates that more changes may be available. An additional GET request should be made for more changes using this value as the continueToken query string parameter. When not present, indicates that all changes have been obtained and no further changes will be available.
• continueAfter (Number) Recommended milliseconds to delay before issuing the next GET request for more changes.

Error Responses

Example

Here is an example sequence of requests and responses illustrating how you would acquire the full set of changes for a comparison viewing session (for brevity, the total number of changes in this example is small).

You would start with an initial GET:

GET prizmdoc_server_base_url/v2/viewingSessions/luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lkBs8mk63aArufxZ9jaXZ0ykG5LsMlWorI6u3Ui6YApkw/revisionData
Accept-Encoding: gzip

HTTP/1.1 200 OK
Content-Type: application/json
Content-Encoding: gzip

{
  "changes": [],
  "continueToken": "luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lmZwRo30ojTLjaT0J2D2f8D",
  "continueAfter": 500
}

In this case, the initial response did not return any changes at all (the changes array is empty), but the presence of a continueToken indicates they may simply not have been available yet. We should issue another GET request after waiting 500 milliseconds (the amount of time recommended by continueAfter).

So, half a second later, we issue a follow-up request with the continueToken passed in as a query string parameter:

GET prizmdoc_server_base_url/v2/viewingSessions/luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lkBs8mk63aArufxZ9jaXZ0ykG5LsMlWorI6u3Ui6YApkw/revisionData?continueToken=luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lmZwRo30ojTLjaT0J2D2f8D
Accept-Encoding: gzip

HTTP/1.1 200 OK
Content-Type: application/json
Content-Encoding: gzip

{
  "changes": [
    {
      "id": 0,
      "endPageIndex": 0,
      "type": "contentInserted"
    },
    {
      "id": 1,
      "endPageIndex": 0,
      "type": "contentDeleted"
    }
  ],
  "continueToken": "luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lklhqP2L79Yero0nM9aoZ9r",
  "continueAfter": 500
}

This time we receive two changes. The presence of a new continueToken tells us there may be more, so we submit another request with the new continueToken.

Notice in the next response that the changes which have already been given to us are not repeated:

GET prizmdoc_server_base_url/v2/viewingSessions/luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lkBs8mk63aArufxZ9jaXZ0ykG5LsMlWorI6u3Ui6YApkw/revisionData?continueToken=luMJZGIeGQr20veYl5JQwsv77iIvaFsvHAW4x1L88lklhqP2L79Yero0nM9aoZ9r
Accept-Encoding: gzip

HTTP/1.1 200 OK
Content-Type: application/json
Content-Encoding: gzip

{
  "changes": [
    {
      "id": 2,
      "endPageIndex": 5,
      "type": "styleChanged"
    }
  ]
}

This time we get a new change, and the lack of a continueToken tells us we have received all of the changes, so there are no more GET requests to make.