PrizmDoc Viewer v13.8 - Updated
Markup JSON Specification
Developer Guide > PrizmDoc Server > Markup JSON Specification

Introduction

The following specification describes the PrizmDoc Markup JSON format. A formal JSON schema is also available for automated validation and can be found within the Use the Markup JSON Schema topic.

Specification

The Markup JSON format consists of a top-level object with a marks property that is an array of all marks related to a single document.

Example

The following Markup JSON example creates a rectangle annotation with red background and black border near the top-left corner of the first page in the document:

{
  "marks": [{
      "uid": "bmd3OF8yMDE5LTAxLTE4VDEyOjE5OjU2LjQ0M1pfNGY3MTFx",
      "interactionMode": "Full",
      "pageNumber": 1,
      "type": "RectangleAnnotation",
      "creationDateTime": "2019-01-18T12:19:56.442Z",
      "modificationDateTime": "2019-01-18T12:19:58.089Z",
      "data": {},
      "rectangle": {
        "x": 15.622641509433958,
        "y": 15.622641509433958,
        "width": 143.99999999999997,
        "height": 103.2452830188679
      },
      "pageData": {
        "width": 612,
        "height": 792
      },
      "borderColor": "#000000",
      "borderThickness": 4,
      "fillColor": "#ff0000",
      "opacity": 255
    }
  ]
}

Properties

Mark Specific Properties

EllipseAnnotation

FreehandAnnotation

FreehandSignature

HighlightAnnotation

ImageStampAnnotation

ImageStampRedaction

LineAnnotation

PolylineAnnotation

RectangleAnnotation

RectangleRedaction

StampAnnotation

StampRedaction

StrikethroughAnnotation

TextAnnotation

TextAreaSignature

TextHyperlinkAnnotation

TextInputSignature

TextRedaction

TextSelectionRedaction

TextSignature

TransparentRectangleRedaction