Back-end Proxy
The following routes are proxied to the configured PrizmDoc Server through PrizmDoc Application Services. More information about these routes, their work, and their responses can be found in the PrizmDoc Server REST API documentation.
Routes for document viewing
GET /License/ClientViewer
Routes key: GetClientViewerLicense
GET http://localhost:3000/License/ClientViewer
GET /Document/q/Attributes?DocumentID=u{viewingSessionId}
Routes key: GetDocumentAttributes
GET http://localhost:3000/Document/q/Attributes?DocumentID=u1234
GET /Document/q/{pageNumber}/Text?DocumentID=u{viewingSessionId}
Routes key: GetPageText
GET http://localhost:3000/Page/q/0/Text?DocumentID=u1234
GET /Page/q/{pageNumber}?DocumentID=u{viewingSessionId}
Routes key: GetPage
GET http://localhost:3000/Page/q/0/?DocumentID=u1234&ContentType=svga
GET /Page/q/{pageNumber}/Tile/{x}/{y}/{width}/{height}?DocumentID=u{viewingSessionId}
Routes key: GetPageTile
GET http://localhost:3000/Page/q/0/Tile/0/0/256/256?DocumentID=u1234
GET /Page/q/{pageNumber}/Attributes?DocumentID=u{viewingSessionId}
Routes key: GetPageAttributes
GET http://localhost:3000/Page/q/0/Attributes?DocumentID=u1234
GET /Page/q/{pageNumber}/{width}x{height}?DocumentID=u{viewingSessionId}
Routes key: GetThumbnail
GET http://localhost:3000/Page/q/0/200x200?DocumentID=u1234
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.
POST http://localhost:3000/ViewingSession/u1234/Replacement
Content-Type: application/json
{ "password": "pdfPassword" }
GET /ViewingSession/u{viewingSessionId}/SourceFile
Routes key: GetSourceFile
Downloads the original document that is being viewed.
GET http://localhost:3000/ViewingSession/u1234/SourceFile
For legacy reasons, a second route is available for downloading the original document, as such:
GET /SaveDocument/q?DocumentID=u{viewingSessionId}
Routes key: SaveDocument
GET http://localhost:3000/SaveDocument/q?DocumentID=u1234
Note: when downloading the document programmatically, it is suggested to use the ViewingSession
based API instead of the SaveDocument
legacy API.
GET /ViewingSession/u{viewingSessionId}/Attachments
Routes key: GetAttachments
Gets information about the document attachments (such as ones available on an eml
or msg
file).
GET http://localhost:3000/ViewingSession/u1234/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.
POST http://localhost:3000/ViewingSession/u1234/MarkupBurner
Content-Type: application/xml
<?xml version="1.0">...
GET /ViewingSession/u{viewingSessionId}/MarkupBurner/{markupBurnerId}
Routes key: PollMarkupBurner
Checks the status of the markup burning task.
GET http://localhost:3000/ViewingSession/u1234/MarkupBurner/abcd
GET /ViewingSession/u{viewingSessionId}/MarkupBurner/{markupBurnerId}/Document
Routes key: GetBurnedDocument
Downloads the resulting burned-in document.
GET http://localhost:3000/ViewingSession/u1234/MarkupBurner/abcd/Document