Introduction

The content converters REST API is used by our viewer to allow the user to download the document they are viewing as a PDF.

This REST API is designed for our viewer. If your application needs to convert a document to a different format, we recommend you use PrizmDoc Server’s content converters REST API instead. It offers more options and does not require the use of a viewing session.

Available URLs

POST /v2/viewingSessions/{viewingSessionId}/contentConverters

Routes key: CreateContentConverterV2

Starts a conversion process for the source document of a particular viewing session. This URL has the following parameters:

Request

Body: Empty. An error will be returned if any data is present.

NOTE: PDF is currently the only supported destination format. A successful response will include several input properties as shown below. A future release will allow these properties to be set in the request body to create various kinds of output.

Response

Body: a JSON object with the following properties:

Examples

POST pas_base_url/v2/viewingSessions/ZGZhc2RmYXNkZmFzZGZkcw/contentConverters

Successful Response

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

{
    "input": {
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": false
            }
        },
        "sources": [
            {
                "pages": ""
            }
        ]
    },
    "expirationDateTime": "2015-11-04T19:20:09.280Z",
    "processId": "mxivIVSw7UhtL1yWwt3QEA",
    "state": "processing",
    "percentComplete": 0
}

Errored Responses

When a response with a status code of 580 is received check the response body for details:

HTTP/1.1 580 InternalError
Content-Type: application/json

{
    "errorCode": "InternalError"
}

When a viewing session does not exist for the given viewingSessionId:

HTTP/1.1 404 Not Found

When any data is present in the body of the request:

HTTP/1.1 480 ReservedInput
Content-Type: application/json

{
    "errorCode": "ReservedInput",
    "errorDetails": {
        "in": "body"
    }
}

When the server's license could not be verified:

HTTP/1.1 480 LicenseCouldNotBeVerified
Content-Type: application/json

{
    "errorCode": "LicenseCouldNotBeVerified"
}

GET /v2/viewingSessions/{viewingSessionId}/contentConverters/{processId}

Routes key: PollContentConverterV2

Gets the status of the specific converter process. This URL has the following parameters:

Response

Body: a JSON object with the following properties:

Example

GET pas_base_url/v2/viewingSessions/ZGZhc2RmYXNkZmFzZGZkcw/contentConverters/mxivIVSw7UhtL1yWwt3QEA

Successful Response

When the converter process completes with no conversion failures:

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

{
    "input": {
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": false
            }
        },
        "sources": [
            {
                "pages": ""
            }
        ]
    },
    "processId": "mxivIVSw7UhtL1yWwt3QEA",
    "state": "complete",
    "percentComplete": 100,
    "output": {
        "results": [
            {
                "fileId": "eOsJIqI8aHkxVV0yJug",
                "sources": [
                    {
                        "pages": "1-4"
                    }
                ],
                "pageCount": 4
            }
        ]
    }
}

When the converter process completes with a failure:

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

{
    "input": {
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": false
            }
        },
        "sources": [
            {
                "pages": ""
            }
        ]
    },
    "processId": "mxivIVSw7UhtL1yWwt3QEA",
    "state": "error",
    "percentComplete": 100,
    "errorCode": "CouldNotConvert",
    "output": {
        "results": [
            {
                "errorCode": "CouldNotConvertPage",
                "sources": [
                    {
                        "pages": "3"
                    }
                ]
            }
        ]
    }
}

Error Responses

When a response with a status code of 580 is received check the response body for details:

HTTP/1.1 580 InternalError
Content-Type: application/json

{
    "errorCode": "InternalError"
}

When a converter process does not exist for the given processId:

HTTP/1.1 404 Not Found

GET /v2/viewingSessions/{viewingSessionId}/contentConverters/{processId}/results/{index}/file?ContentDispositionFilename={fileName}

Routes key: GetContentConverterOutputFileV2

Gets the contents of a file produced by the converter process. This URL has the following parameters:

Response Headers

Response Body

The raw bytes of the result document.

Example

GET pas_base_url/v2/viewingSessions/ZGZhc2RmYXNkZmFzZGZkcw/contentConverters/mxivIVSw7UhtL1yWwt3QEA/results/0/file?ContentDispositionFilename=MyFile

Successful Response

HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Disposition: attachment; filename="Greek____.pdf"; filename*=UTF-8''Greek%CE%91%CE%92%CE%93%CE%94.pdf


<<PDF data>>

Error Responses

When an output file does not exist for the given index:

HTTP/1.1 404 Not Found