Parameter |
Example |
API version |
||
id |
Comment identifier |
integer |
23654 |
|
reviewer_id |
The ID of the reviewer |
integer |
4563 |
|
author |
Name of the comment author |
string |
Joe Blogs |
|
comment |
Comment text |
string |
Original text of the comment |
|
created_at |
Comment date |
string |
2010-07-14 13:14:55 |
|
replies_count |
Number of replies to this comment |
integer |
3 |
|
replies |
Array of SOAPCommentReplyObject |
array |
|
|
url |
URL that will launch the proof page viewer and open this comment by default |
string |
https://domain.proofhq.com/proof/XXXXX/comment/23654 |
|
drawing_xml |
Return the drawing markup XML |
string |
Text annotation:
<drawing>
<fhd>
<styling key="text">
<arrowHead>0</arrowHead>
<straightLine>false</ straightLine>
<type>text</type>
<capsStyle>round</capsStyle>
<pixelHinting>true</ pixelHinting>
<alpha>30</alpha>
<rgb>ff0000</rgb>
<thickness>1</thickness>
<fontSize>10</fontSize>
<fillAlpha>30</fillAlpha>
<fillCol>ff0000</fillCol>
<selectionType>1</ selectionType>
</styling>
<points>-52,-6|54,-6|54,7|-52, 7|-52,-6</points>
<text_selection>0,234.68,650. 52,571.98,19.08,913.32,650.52, 109.32,19.08,234.68,650.52, 787.96,19.08|</text_selection>
<selection_marker>913.32,665. 20</selection_marker>
</fhd>
</drawing>
General drawings:
<drawing>
<fhd>
<styling key="box">
<arrowHead>0</arrowHead>
<straightLine>false</ straightLine>
<type>box</type>
<capsStyle>round</capsStyle>
<pixelHinting>true</ pixelHinting>
<alpha>100</alpha>
<rgb>ff0000</rgb>
<thickness>5</thickness>
<fontSize>10</fontSize>
<fillAlpha/>
<fillCol/>
</styling>
<points>-43,-19|-43,18|42,18| 42,-19|-43,-19</points>
</fhd>
</drawing>
|
|
location |
If this comment was made on a static proof, the method returns the page number of the comment. If this comment was made on an AV proof, the method returns the time at which this comment was made. If this comment was made on SWF file, the method returns an empty location. |
string |
|
12.1 |
attachments |
Array of SOAPCommentAttachmentObject |
array |
|
15.25 |