Information Classification: External Restricted.
See https://www.chili-publish.com/security

GET - resources/documents/{itemID}/annotations

Owned by Bram Verniest (Unlicensed)
Apr 22, 2020
1 min read

Returns information on the annotations contained in a document

URI

resources/documents/{itemID}/annotations

HTTP Method

Get

Request parameters

Name

Location

Type

Description

API-KEY

http header

apiKey

The API key previously generated by calling the GenerateApiKey function

itemID

uri

itemID

The ID of the document for which to return the placed annotations

HTTP Return Status

Ok

Returns

xmlString

Overview of the placed annotations. For example:

<annotations>
<item width="40mm" height="40mm" user="ChiliAdmin" x="17.6921 mm" id="D76DDF59-D9F9-8F6E-0AB6-CDA32ABB2233" pageNum="1" type="rectangle" name="New Annotation" dateCreated="Wed Sep 1 14:11:16 2010 UTC" text="First rectangle" y="9.8779 mm" tag="" pageName="1" />
<item width="40mm" height="40mm" user="ChiliAdmin" x="20.338 mm" id="5DAAB948-55DD-5611-E9B4-CDA33E86154E" pageNum="1" type="oval" name="New Annotation 2" dateCreated="Wed Sep 1 14:11:21 2010 UTC" text="first circle" y="142.0659 mm" tag="" pageName="1" />
<item width="40mm" height="40mm" user="ChiliAdmin" x="150.6915 mm" id="5BB0B1B1-3610-0030-2B50-CDA34F5043BF" pageNum="1" type="pin" name="New Annotation 3" dateCreated="Wed Sep 1 14:11:26 2010 UTC" text="a pin" y="106.8934 mm" tag="" pageName="1" />
<item width="40mm" height="40mm" user="ChiliAdmin" x="50mm" id="BCD2EEAA-E1FE-6530-238B-CDA3A743B25A" pageNum="3" type="pin" name="New Annotation" dateCreated="Wed Sep 1 14:11:48 2010 UTC" text="another pin" y="50mm" tag="" pageName="3" />
<item width="40mm" height="40mm" user="ChiliAdmin" x="42.2282 mm" id="98F314F4-AA6A-9BEE-6948-CDA3B16AE18E" pageNum="3" type="rectangle" name="New Annotation 2" dateCreated="Wed Sep 1 14:11:51 2010 UTC" text="Another rectangle" y="107.4931 mm" tag="" pageName="3" />
</annotations>

A valid XML string

All information on this page must be treated as External Restricted, or more strict. https://www.chili-publish.com/security