Overview | Service | Command |
Get Note
Authorization token required | true |
Admin Authorization token required | false |
<GetNoteRequest> ## GetNoteRequest
<note [id="..."] /> ## Id
</GetNoteRequest>
The following table describes elements and attributes you can define within a
<GetNoteRequest>
element:
XPath | Required / Optional | Description |
/note | Required (only 1) | Specification for note |
/note@id | Optional (0 or 1) | Type:String ID |
<GetNoteResponse> ## GetNoteResponse
<note [id="{id}"] [rev="{revision} (Integer)"] [l="{folder-id}"] [d="{date} (Long)"] [f="{flags}"] [t="{tags}"]
[tn="{tag-names}"] [pos="{bounds-x,y[width,height]}"] [color="{color} (Byte)"] [rgb="{rgb-color}"]
[md="{change-date} (Long)"] [ms="{modified-sequence} (Integer)"]> ## NoteInfo
<content>{content} (String)</content>
(<meta [section="{section}"]> ## MailCustomMetadata
(<a n="{key}">{value}</a> ## KeyValuePair)*
</meta>)*
</note>
</GetNoteResponse>
The following table describes elements and attributes you can define within a
<GetNoteResponse>
element:
XPath | Required / Optional | Description |
/note | Required (only 1) | Note information |
/note@id | Optional (0 or 1) | Type:String id |
/note@rev | Optional (0 or 1) | Type:Integer Revision |
/note@l | Optional (0 or 1) | Type:String Folder ID |
/note@d | Optional (0 or 1) | Type:Long Date |
/note@f | Optional (0 or 1) | Type:String Flags |
/note@t | Optional (0 or 1) | Type:String Tags - Comma separated list of integers. DEPRECATED - use "tn" instead |
/note@tn | Optional (0 or 1) | Type:String Comma-separated list of tag names |
/note@pos | Optional (0 or 1) | Type:String Bounds - x,y[width,height] where x,y,width and height are all integers |
/note@color | Optional (0 or 1) | Type:Byte color numeric; range 0-127; defaults to 0 if not present; client can display only 0-7 |
/note@rgb | Optional (0 or 1) | Type:String RGB color in format #rrggbb where r,g and b are hex digits |
/note@md | Optional (0 or 1) | Type:Long Modified date in seconds |
/note@ms | Optional (0 or 1) | Type:Integer Modified sequence |
/note/content | Optional (0 or 1) | Type:{content} (String) Content |
/note/meta | Optional (0 or more) | Custom metadata information |
/note/meta@section | Optional (0 or 1) | Type:String Section. Normally present. If absent this indicates that CustomMetadata info is present but there are no sections to report on. |
/note/meta/a | Optional (0 or more) | Type:{value} Key value pairs Description for element text content:Value |
/note/meta/a@n | Required (only 1) | Type:String Key |