Introduction

The MarkupBurner API is designed to "burn" a markup into a document. NOTE: CAD files are not supported.

Available URLs

POST /ViewingSession/u{viewingSessionId}/MarkupBurner

Routes key: CreateMarkupBurner

Starts a new MarkupBurner using the source document of a viewing session and a provided markup data as input. When the asynchronous process is ultimately finished, the output will be a new document which includes the provided markup as part of the document itself (the original source document of the viewing session is left unaltered).

This is a specialized URL which allows you to do markup burning against the source file of an existing viewing session without needing to use the work file API.

This request merely begins the markup burning process. Once started, you poll the status of the process using the GET /ViewingSession/u{viewingSessionId}/MarkupBurner/{processId} URL below to know when the process has completed.

Request

Request Headers

URL Parameters

Request Body

The JSON or XML markup to burn into the source document.

Response Body

If successful, a JSON object which may contain:

• processId (String) The id of the process.
• state (String) The current state of the markup burning process running on the server. This will always be "processing" in the initial POST response.
• percentComplete (Integer) The percentage (0 – 100) complete of the process. This will always be 0 in the initial POST response.
• input (null) Legacy property which exists only for backwards compatibility. Value will always be null.
• output (null) Legacy property which exists only for backwards compatibility. Value will always be null.

Error Responses

Examples

Request to burn a rectangle annotation using JSON markup

POST pas_base_url/ViewingSession/uDLbVh9sTmXJAmd1GeXbS9Gn3WHxs8oib2xPsW2xEFjnIDdoJcudPtxciodSYFQq6zYGabQ_rJIecdbkImTTkSA/MarkupBurner
Content-Type: application/json

{
  "marks": [
    {
      "uid": "Z2diOV8yMDE3LTAzLTMxVDA3OjQ5OjExLjUyNVpfY2VnNjZy",
      "interactionMode": "Full",
      "pageNumber": 1,
      "type": "RectangleAnnotation",
      "creationDateTime": "2017-03-31T07:49:11.525Z",
      "modificationDateTime": "2017-03-31T07:49:11.526Z",
      "data": {},
      "conversation": {},
      "rectangle": {
        "x": 0,
        "y": 0,
        "width": 0,
        "height": 0
      },
      "pageData": {
        "width": 612,
        "height": 792
      },
      "borderColor": "#000000",
      "borderThickness": 4,
      "fillColor": "#FB0404",
      "opacity": 255
    }
  ]
}

Response

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

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

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

Routes key: PollMarkupBurner

Gets the status of a MarkupBurner for a viewing session.

Requests are typically sent to this URL repeatedly as long as the state is "processing".

When state is "complete", a new document with the provided markup burned into it will be available at:

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

If an error occurred and the output could not be created, the state property will be "error" and the errorCode property will contain an error code string.

Request

URL Parameters

Response Body

If successful, a JSON object which may contain:

• processId (String) The id of the process.
• state (String) The current state of the process. The following values are allowed:
  • "processing" - The markup burning is in progress.
  • "complete" - The markup burning is completed.
  • "error" - The markup burning returns an error.
• percentComplete (Integer) The percentage (0 – 100) complete of the process.
• errorCode (String) An error code string if a problem occurred during processing.
• input (null) Legacy property which exists only for backwards compatibility. Value will always be null.
• output (null) Legacy property which exists only for backwards compatibility. Value will always be null.

Error Responses

Examples

Request

GET pas_base_url/PCCIS/V1/ViewingSession/uDLbVh9sTmXJAmd1GeXbS9Gn3WHxs8oib2xPsW2xEFjnIDdoJcudPtxciodSYFQq6zYGabQ_rJIecdbkImTTkSA/MarkupBurner/5rGUUh3Qxhf6VXm8RkBPfA

Response when the state is "processing"

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

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

Response when the state is "complete"

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

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

Response when the state is "error" because the provided markup XML did not contain valid XML markup or the provided markup JSON was auto-detected as a non-text format

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

{
    "input": null,
    "processId": "53LCkvO8-rsDIaW95WgoFA",
    "state": "error",
    "percentComplete": 0,
    "errorCode": "RedactionError",
    "output": null
}

Response when the state is "error" because the provided markup JSON cannot be parsed as JSON

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

{
    "input": null,
    "processId": "53LCkvO8-rsDIaW95WgoFA",
    "state": "error",
    "percentComplete": 0,
    "errorCode": "InvalidJson",
    "output": null
}

Response when the state is "error" because the provided markup JSON does not match the JSON Marks Schema

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

{
    "input": null,
    "processId": "53LCkvO8-rsDIaW95WgoFA",
    "state": "error",
    "percentComplete": 0,
    "errorCode": "InvalidMarkup",
    "output": null
}

GET /ViewingSession/u{viewingSessionId}/MarkupBurner/{processId}/Document?ContentDispositionFilename={ContentDispositionFilename}

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.

Request

URL Parameters

Error Responses

Examples

Request

GET pas_base_url/ViewingSession/uDLbVh9sTmXJAmd1GeXbS9Gn3WHxs8oib2xPsW2xEFjnIDdoJcudPtxciodSYFQq6zYGabQ_rJIecdbkImTTkSA/MarkupBurner/ElkNzWtrUJp4rXI5YnLUgw/Document

Response

HTTP/1.1 200 OK

<<PDF data>>