Waiting for engine...
Skip to main content

Overview

Third party applications can use MFT FS View API to view files stored on MFT FS server in a browser by calling URL to Viewing API and supplying prepared parameters.

View API Tool displays an image file or the first page of pdf file in canvas element in browser and executes reporting redirects on success or failure.

View API is available through the following URL: https://thruservername/APITool/1.0/View/<shortId> where shortID is prepared in advance by web service call.

String GetViewerRequestKey(Guid sessionId, FTHViewerRequest request)

which will be specified below and represents the following data structure:

    FTHViewerRequest
    {
        public Guid SessionId,
        public int FileId,
        public string SuccessUrl,
        public string ErrorReportingUrl
    }

Structure fields:

  • SessionId: Unique identifier of the current session.
  • FileId: ID of file for view obtained by previous web service calls.
  • SuccessUrl: Redirect to this URL if viewing is success.
  • ErrorReportingUrl: Redirect to this URL if viewing failed.

If viewing failed, a server returns server error code using parameter ThruErrorCode. If an error occurred and ErrorReportingUrl is not defined, then server throws unhandled exception.

note

The value of ErrorReportingUrl is not validated. Ensure this is a valid URL.

Reporting redirect rules:

  • Image successfully displayed: call to <SuccessUrl> in iFrame, image is still displayed in a browser tab

  • Image cannot be displayed: redirect to <ErrorReportingUrl> in the following format: <ErrorReportingUrl>?ThruErrorCode=<errorCode>

Server error codes

The codes below are passed as parameters to the ErrorReportingUrl in case any error occurs:

  1. SessionId is not a valid session id format
  2. Unknown SessionId. Provided session identifier does not exist on server
  3. FileId is not valid FileId format
  4. FileId does not reference existing file
  5. FileId references to the file of a type not supported for viewing
  6. View failed. This error code is returned for any error that can’t be detected as other ErrorCode

File formats supported for viewing

  • Image files: JPG, PNG, GIF, and BMP are supported by all browsers, other image types are supported depending on browser, refer to Image format support.

  • PDF

Sample File View API URL:
[https://<your-domain>/APITool/1.0/View/4E2CH827YO6OUUQVMSM3](http://test.thruinc.net/APITool/1.0/View/4E2CH827YO6OUUQVMSM3)

Sample steps to work with View API

WDSL file for API version 4.0 is located at https://<servername>/ws4/fthservice.asmx?WSDL

  1. Get session id: 

Open() or OpenImmutable() or other Open* calls in MFT FS API

  1. Get FileId for viewing by using one of the file browsing or search methods.
  2. Provide SuccessUrl and ErrorReportingUrl and fill in the structure 

FTHViewerRequest

  1. Generate ShortId: 

    ShortId=GetViewerRequestKey(Guid sessionId, FTHViewerRequest request)

  2. Compose View URL and open browser window with the link: 

    https://<serverName>/APITool/1.0/View/<shortId>