Introduction

Available URLs

URL	Description
GET /AnnotationList/q/Art/q	Gets the list of available annotation XML files from the server.
GET /Document/q/Art/q	Gets a specific annotations XML file from the server.
POST /Document/q/Art/q	Creates a new annotations XML file using the provided data.

GET /AnnotationList/q/Art/q?DocumentID=u{viewingSessionId}

Routes key: GetAnnotations

Gets the list of available annotation XML files from the server.

GET pas_base_url/AnnotationList/q/Art/q?DocumentID=u1234

Successful Response

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

{
    "annotationFiles": [
        {
            "annotationLabel": "anId",
            "annotationName": "abcd_0_anId.xml",
            "ID": "1"
        }
    ]
}

GET /Document/q/Art/q?DocumentID=u{viewingSessionId}&AnnotationID=u{annotationId}

Routes key: GetAnnotation

Gets a specific annotations XML file from the server.

GET pas_base_url/Document/q/Art/q?DocumentID=u1234&AnnotationID=uanId

Successful Response

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

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

POST /Document/q/Art/q?DocumentID=u{viewingSessionId}&AnnotationID=u{annotationId}

Routes key: CreateAnnotation

Creates a new annotations XML file using the provided data.

POST pas_base_url/Document/q/Art/q?DocumentID=u1234&AnnotationID=uanotherId
Content-Type: application/xml

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

Successful Response

HTTP/1.1 200 OK