PrizmDoc® Viewer v14.0 Release - Updated
PrizmDoc Viewer / API Reference / PAS REST API / General Information / Back-end Proxy
In This Topic
    Back-end Proxy
    In This Topic

    Introduction

    The following routes are proxied through PAS to PrizmDoc Server. Many of them are direct proxies to corresponding PrizmDoc Server routes, and more information about them can be found in the PrizmDoc Server REST API documentation.

    Routes for document viewing

    GET /Document/q/Attributes?DocumentID=u{viewingSessionId}

    Routes key: GetDocumentAttributes

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

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/Document/q/Attributes.

    GET /Document/q/{PageNumberBegin}-{PageNumberEnd}/Text?DocumentID=u{viewingSessionId}

    Routes key: GetPageText

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

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/Document/q/{PageNumberBegin}-{PageNumberEnd}/Text.

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

    Routes key: GetDocumentRevisionData

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

    For more information, see the PrizmDoc Server endpoint GET /v2/viewingSessions/{viewingSessionId}/revisionData.

    GET /Page/q/{pageNumber}?DocumentID=u{viewingSessionId}

    Routes key: GetPage

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

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/Page/q/{PageNumber}.

    GET /Page/q/{pageNumber}/Tile/{x}/{y}/{width}/{height}?DocumentID=u{viewingSessionId}

    Routes key: GetPageTile

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

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/Page/q/{PageNumber}/Tile/{x}/{y}/{width}/{height}.

    GET /Page/q/{pageNumber}/Attributes?DocumentID=u{viewingSessionId}

    Routes key: GetPageAttributes

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

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/Page/q/{PageNumber}/Attributes.

    GET /Page/q/{pageNumber}/{width}x{height}?DocumentID=u{viewingSessionId}

    Routes key: GetThumbnail

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

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/Page/q/{PageNumber}/{Width}x{Height}.

    Routes related to the original document

    POST /ViewingSession/u{viewingSessionId}/Replacement

    Routes key: CreateViewingSessionReplacement

    Replaces the existing viewing session with a new one. Useful for supplying passwords on password protected documents.

    Example

    POST pas_base_url/ViewingSession/uXYZ.../Replacement
    Content-Type: application/json
    
    {
        "password": "pdfPassword"
    }
    
    

    NOTE: See the Base URL for PAS topic for more information.

    GET /ViewingSession/u{viewingSessionId}/SourceFile

    Routes key: GetSourceFile

    Downloads the original document that is being viewed.

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/ViewingSession/u{viewingSessionId}/SourceFile.

    GET /SaveDocument/q?DocumentID=u{viewingSessionId}

    Routes key: SaveDocument

    Downloads the original document that is being viewed, automatically setting the Content-Disposition header with a filename based upon information given in the original POST /ViewingSession request. Like GET /ViewingSession/u{viewingSessionId}/SourceFile, except that this endpoint does not allow you to provide a custom ContentDispositionFilename.

    This endpoint is designed for requests which originate from a browser. If you are writing server-side application code which downloads the document from a viewing session, consider using GET /ViewingSession/u{viewingSessionId}/SourceFile instead.

    Example

    GET pas_base_url/SaveDocument/q?DocumentID=uXYZ...
    
    

    NOTE: See the Base URL for PAS topic for more information.

    GET /v2/viewingSessions/{ViewingSessionID}/sourceFile/original

    Routes key: GetOriginalSourceFile

    Downloads the "original" (as opposed to "revised") document that is being used for a comparison session.

    For more information, see the PrizmDoc Server endpoint GET /v2/viewingSessions/{viewingSessionId}/sourceFile/original.

    GET /v2/viewingSessions/{ViewingSessionID}/sourceFile/revised

    Routes key: GetRevisedSourceFile

    Downloads the "revised" document that is being used for a comparison session.

    For more information, see the PrizmDoc Server endpoint GET /v2/viewingSessions/{viewingSessionId}/sourceFile/revised.

    GET /ViewingSession/u{viewingSessionId}/Attachments

    Routes key: GetAttachments

    Gets information about the document attachments (such as ones available on an eml, msg, or pdf file).

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/ViewingSession/u{ViewingSessionID}/Attachments.

    Routes for markup burning

    POST /ViewingSession/u{viewingSessionId}/MarkupBurner

    Routes key: CreateMarkupBurner

    Creates a document burning task for the specific document in the viewing session.

    For more information, see the PrizmDoc Server endpoint POST /PCCIS/V1/ViewingSession/u{viewingSessionId}/MarkupBurner.

    GET /ViewingSession/u{viewingSessionId}/MarkupBurner/{markupBurnerId}

    Routes key: PollMarkupBurner

    Checks the status of the markup burning task.

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/ViewingSession/u{viewingSessionId}/MarkupBurner/{processId}.

    GET /ViewingSession/u{viewingSessionId}/MarkupBurner/{markupBurnerId}/Document

    Routes key: GetBurnedDocument

    Downloads the resulting burned-in document.

    For more information, see the PrizmDoc Server endpoint GET /PCCIS/V1/ViewingSession/u{viewingSessionId}/MarkupBurner/{processId}/Document.

    GET /License/ClientViewer

    Routes key: GetClientViewerLicense

    NOTE: This URL has been deprecated and will be removed from the public API in a future release. It no longer functions and returns HTTP 500 Internal Server Error.