Introduction

NOTE: The following URLs have been deprecated and will be removed from the public API in a future release. They are not available at all in PrizmDoc Cloud. Please use the newer Content Converters API instead.

Deprecated URLs

POST /contentConverters (Deprecated)

Deprecated. Use POST /v2/viewingSessions/{viewingSessionId}/contentConverters instead.

Converts a viewing session to a PDF.

Note that this URL is only available with PrizmDoc Self-Hosted.

Routes key: CreateContentConverter

Starts a conversion process for a particular document based on the viewing session.

POST http://localhost:3000/contentConverters
Content-Type: application/json

{ "viewingSessionId": "1234" }

Successful Response

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

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

Error Responses

When an unknown error occurs while gathering data:

HTTP/1.1 580 Server Error
Content-Type: application/json

{
    "errorCode": "InternalError"
}

GET /contentConverters/{processId} (Deprecated)

Routes key: PollContentConverter

Deprecated. Use GET /v2/viewingSessions/{viewingSessionId}/contentConverters/{processId} instead.

Gets the status of the process which is converting the viewing session to a PDF.

GET http://localhost:3000/contentConverters/9BgnvnYFK96E0YOsK-A9xA
Accusoft-Affinity-Token: wxyz

Successful Response

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

{
    "input": {
        "dest": {
            "format": "pdf",
            "pdfOptions": {
                "forceOneFilePerPage": false
            }
        },
        "sources": [
            {
                "fileId": "9BgnvnYFK96E0YOsK-A9xA",
                "pages": ""
            }
        ]
    },
    "expirationDateTime": "2015-11-04T19:20:09.280Z",
    "processId": "mxivIVSw7UhtL1yWwt3QEA",
    "state": "complete",
    "percentComplete": 100,
    "output": {
        "results": [
            {
                "fileId": "eOsJIqI8aHkxVV0yJug",
                "sources": [
                    {
                        "fileId": "9BgnvnYFK96E0YOsK-A9xA",
                        "pages": "1-4"
                    }
                ],
                "pageCount": 4
            }
        ]
    }
}

Error Responses

When an unknown error occurs while gathering data:

HTTP/1.1 580 Server Error
Content-Type: application/json

{
    "errorCode": "InternalError"
}

GET /WorkFile/{fileId}?ContentDispositionFilename={file name}&affinityToken={affinityToken} (Deprecated)

Deprecated. Use GET /v2/viewingSessions/{viewingSessionId}/contentConverters/{processId}/results/{index}/file instead.

Used to get the output PDF.

Note that this URL is only available with PrizmDoc Self-Hosted.

Routes key: GetWorkFile

GET http://localhost:3000/WorkFile/eOsJIqI8aHkxVV0yJug?ContentDispositionFilename=MyFile&affinityToken=wxyz

Successful Response

HTTP/1.1 200 OK
Content-Disposition: attachment; filename={documentDisplayName}.{ext}
Content-Type: {content type of the specific document}