Markup Burner

POST /ViewingSession/u{viewingSessionId}/MarkupBurner

Routes key: CreateMarkupBurner

Burn annotations and redactions into the document that is currently being viewed. This endpoint creates a burn task and returns immediately, often before the task is completed. Check the state value of the response to see the current state.

POST pas_base_url/ViewingSession/uXYZ...
Content-Type application/xml

<?xml version="1.0">...

Successful Response:

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

{
    "input": null,
    "processId": "Be3enRqsA0ttkYwK1w5XOA",
    "state": "processing",
    "percentComplete": 0,
    "errorCode": null,
    "output": null
}

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

Routes key: PollMarkupBurner

Checks the status of the burn task. Check the state value of the response to see if it has completed or not. A completed task will have a state of complete.

GET pas_base_url/ViewingSession/uXYZ.../MarkupBurner/Be3enRqsA0ttkYwK1w5XOA

Successful Response:

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

{
    "input": null,
    "processId": "Be3enRqsA0ttkYwK1w5XOA",
    "state": "complete",
    "percentComplete": 100,
    "errorCode": null,
    "output": null
}

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

Routes key: GetBurnedDocument

Downloads the resulting burned-in document. It will be served with the correct Content-Type of the document, and using the specified ContentDispositionFilename as the name, along with the correct file extension.

GET pas_base_url/ViewingSession/uXYZ.../MarkupBurner/Be3enRqsA0ttkYwK1w5XOA/Document?ContentDispositionFilename={documentDisplayName}

Successful Response:

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

<<document bytes>>