]> git.mxchange.org Git - friendica.git/blob - doc/API-Entities.md
Added documentation
[friendica.git] / doc / API-Entities.md
1 # Friendica API entities
2
3 * [Home](help)
4   * [Using the APIs](help/api)
5
6
7 ## Activities
8
9 <table class="table table-condensed table-striped table-bordered">
10 <thead>
11 <tr>
12 <th>Attribute</th>
13 <th>Type</th>
14 <th align="center">Nullable</th>
15 </tr>
16 </thead>
17 <tbody>
18
19 <tr>
20 <td><code>like</code></td>
21 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
22 <td align="center">No</td>
23 </tr>
24
25 <tr>
26 <td><code>dislike</code></td>
27 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
28 <td align="center">No</td>
29 </tr>
30
31 <tr>
32 <td><code>attendyes</code></td>
33 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
34 <td align="center">No</td>
35 </tr>
36
37 <tr>
38 <td><code>attendno</code></td>
39 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
40 <td align="center">No</td>
41 </tr>
42
43 <tr>
44 <td><code>attendmaybe</code></td>
45 <td>List of <a href="help/API-Entities#Contact">Contacts</a></td>
46 <td align="center">No</td>
47 </tr>
48
49 </tbody>
50 </table>
51
52 ## Attachment
53
54 <table class="table table-condensed table-striped table-bordered">
55 <thead>
56 <tr>
57 <th>Attribute</th>
58 <th>Type</th>
59 <th align="center">Nullable</th>
60 </tr>
61 </thead>
62 <tbody>
63
64 <tr>
65 <td><code>url</code></td>
66 <td>String (URL)</td>
67 <td align="center">No</td>
68 </tr>
69
70 <tr>
71 <td><code>mimetype</code></td>
72 <td>String</td>
73 <td align="center">No</td>
74 </tr>
75
76 <tr>
77 <td><code>size</code></td>
78 <td>Integer (bytes)</td>
79 <td align="center">No</td>
80 </tr>
81
82 </tbody>
83 </table>
84
85 ## Contact
86
87 <table class="table table-condensed table-striped table-bordered">
88 <thead>
89 <tr>
90 <th>Attribute</th>
91 <th>Type</th>
92 <th align="center">Nullable</th>
93 </tr>
94 </thead>
95
96 <tbody>
97 <tr>
98 <td><code>id</code></td>
99 <td>Integer</td>
100 <td align="center">No</td>
101 </tr>
102
103 <tr>
104 <td><code>id_str</code></td>
105 <td>String</td>
106 <td align="center">No</td>
107 </tr>
108
109 <tr>
110 <td><code>name</code></td>
111 <td>String</td>
112 <td align="center">No</td>
113 </tr>
114
115 <tr>
116 <td><code>screen_name</code></td>
117 <td>String</td>
118 <td align="center">No</td>
119 </tr>
120
121 <tr>
122 <td><code>location</code></td>
123 <td>String</td>
124 <td align="center">No</td>
125 </tr>
126
127 <tr>
128 <td><code>description</code></td>
129 <td>String</td>
130 <td align="center">No</td>
131 </tr>
132
133 <tr>
134 <td><code>profile_image_url</code></td>
135 <td>String (URL)</td>
136 <td align="center">No</td>
137 </tr>
138
139 <tr>
140 <td><code>profile_image_url_https</code></td>
141 <td>String (URL)</td>
142 <td align="center">No</td>
143 </tr>
144
145 <tr>
146 <td><code>profile_image_url_profile_size</code></td>
147 <td>String (URL)</td>
148 <td align="center">No</td>
149 </tr>
150
151 <tr>
152 <td><code>profile_image_url_large</code></td>
153 <td>String (URL)</td>
154 <td align="center">No</td>
155 </tr>
156
157 <tr>
158 <td><code>url</code></td>
159 <td>String (URL)</td>
160 <td align="center">No</td>
161 </tr>
162
163 <tr>
164 <td><code>protected</code></td>
165 <td>Boolean</td>
166 <td align="center">No</td>
167 </tr>
168
169 <tr>
170 <td><code>followers_count</code></td>
171 <td>Integer</td>
172 <td align="center">No</td>
173 </tr>
174
175 <tr>
176 <td><code>friends_count</code></td>
177 <td>Integer</td>
178 <td align="center">No</td>
179 </tr>
180
181 <tr>
182 <td><code>listed_count</code></td>
183 <td>Integer</td>
184 <td align="center">No</td>
185 </tr>
186
187 <tr>
188 <td><code>favourites_count</code></td>
189 <td>Integer</td>
190 <td align="center">No</td>
191 </tr>
192
193 <tr>
194 <td><code>statuses_count</code></td>
195 <td>Integer</td>
196 <td align="center">No</td>
197 </tr>
198
199 <tr>
200 <td><code>created_at</code></td>
201 <td>String (Date)<br/>
202 Ex: Wed May 23 06:01:13 +0000 2007
203 </td>
204 <td align="center">No</td>
205 </tr>
206
207 <tr>
208 <td><code>utc_offset</code></td>
209 <td>Integer</td>
210 <td align="center">No</td>
211 </tr>
212
213 <tr>
214 <td><code>time_zone</code></td>
215 <td>String</td>
216 <td align="center">No</td>
217 </tr>
218
219 <tr>
220 <td><code>geo_enabled</code></td>
221 <td>Boolean</td>
222 <td align="center">No</td>
223 </tr>
224
225 <tr>
226 <td><code>verified</code></td>
227 <td>Boolean</td>
228 <td align="center">No</td>
229 </tr>
230
231 <tr>
232 <td><code>lang</code></td>
233 <td>String</td>
234 <td align="center">No</td>
235 </tr>
236
237 <tr>
238 <td><code>contributors_enabled</code></td>
239 <td>Boolean</td>
240 <td align="center">No</td>
241 </tr>
242
243 <tr>
244 <td><code>is_translator</code></td>
245 <td>Boolean</td>
246 <td align="center">No</td>
247 </tr>
248
249 <tr>
250 <td><code>is_translation_enabled</code></td>
251 <td>Boolean</td>
252 <td align="center">No</td>
253 </tr>
254
255 <tr>
256 <td><code>following</code></td>
257 <td>Boolean</td>
258 <td align="center">No</td>
259 </tr>
260
261 <tr>
262 <td><code>follow_request_sent</code></td>
263 <td>Boolean</td>
264 <td align="center">No</td>
265 </tr>
266
267 <tr>
268 <td><code>statusnet_blocking</code></td>
269 <td>Boolean</td>
270 <td align="center">No</td>
271 </tr>
272
273 <tr>
274 <td><code>notifications</code></td>
275 <td>Boolean</td>
276 <td align="center">No</td>
277 </tr>
278
279 <tr>
280 <td><code>statusnet_profile_url</code></td>
281 <td>String (URL)</td>
282 <td align="center">No</td>
283 </tr>
284
285 <tr>
286 <td><code>uid</code></td>
287 <td>Integer</td>
288 <td align="center">No</td>
289 </tr>
290
291 <tr>
292 <td><code>cid</code></td>
293 <td>Integer</td>
294 <td align="center">No</td>
295 </tr>
296
297 <tr>
298 <td><code>pid</code></td>
299 <td>Integer</td>
300 <td align="center">No</td>
301 </tr>
302
303 <tr>
304 <td><code>self</code></td>
305 <td>Integer</td>
306 <td align="center">No</td>
307 </tr>
308
309 <tr>
310 <td><code>network</code></td>
311 <td>String</td>
312 <td align="center">No</td>
313 </tr>
314
315 </tbody>
316 </table>
317
318
319 ## Entities
320
321 <table class="table table-condensed table-striped table-bordered">
322 <thead>
323 <tr>
324 <th>Attribute</th>
325 <th>Type</th>
326 <th align="center">Nullable</th>
327 </tr>
328 </thead>
329 <tbody>
330
331 <tr>
332 <td><code>hashtags</code></td>
333 <td>List of <a href="help/API-Entities#Hashtag">Hashtags</a></td>
334 <td align="center">No</td>
335 </tr>
336
337 <tr>
338 <td><code>symbols</code></td>
339 <td>List of <a href="help/API-Entities#Symbol">Symbols</a></td>
340 <td align="center">No</td>
341 </tr>
342
343 <tr>
344 <td><code>urls</code></td>
345 <td>List of <a href="help/API-Entities#URL">URLs</a></td>
346 <td align="center">No</td>
347 </tr>
348
349 <tr>
350 <td><code>user_mentions</code></td>
351 <td>List of <a href="help/API-Entities#User+Mention">User mentions</a></td>
352 <td align="center">No</td>
353 </tr>
354
355 <tr>
356 <td><code>media</code></td>
357 <td>List of <a href="help/API-Entities#Media">Medias</a></td>
358 <td align="center">No</td>
359 </tr>
360
361 </tbody>
362 </table>
363
364 ## Event
365
366 <table class="table table-condensed table-striped table-bordered">
367 <thead>
368 <tr>
369 <th>Attribute</th>
370 <th>Type</th>
371 <th>Description</th>
372 </tr>
373 </thead>
374
375 <tbody>
376 <tr>
377 <td><code>id</code></td>
378 <td>Integer</td>
379 <td></td>
380 </tr>
381
382 <tr>
383 <td><code>uid</code></td>
384 <td>Integer</td>
385 <td>Owner User Id</td>
386 </tr>
387
388 <tr>
389 <td><code>cid</code></td>
390 <td>Integer</td>
391 <td>Target Contact Id</td>
392 </tr>
393
394 <tr>
395 <td><code>uri</code></td>
396 <td>String</td>
397 <td>Item unique URI string</td>
398 </tr>
399
400 <tr>
401 <td><code>name</code></td>
402 <td>String (Plaintext)</td>
403 <td>Title</td>
404 </tr>
405
406 <tr>
407 <td><code>desc</code></td>
408 <td>String (HTML)</td>
409 <td>Description</td>
410 </tr>
411
412 <tr>
413 <td><code>startTime</code></td>
414 <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
415 <td></td>
416 </tr>
417
418 <tr>
419 <td><code>endTime</code></td>
420 <td>String (UTC <code>YYYY-MM-DD HH:II:SS)</code>)</td>
421 <td>Optional (null date is <code>0001-01-01 00:00:00</code></td>
422 </tr>
423
424 <tr>
425 <td><code>type</code></td>
426 <td>String (<code>event</code> or <code>birthday</code>)</td>
427 <td></td>
428 </tr>
429
430 <tr>
431 <td><code>nofinish</code></td>
432 <td>Boolean</td>
433 <td>Ongoing event</td>
434 </tr>
435
436 <tr>
437 <td><code>place</code></td>
438 <td>String</td>
439 <td>Optional. Location.</td>
440 </tr>
441
442 <tr>
443 <td><code>adjust</code></td>
444 <td>Boolean</td>
445 <td>???</td>
446 </tr>
447
448 <tr>
449 <td><code>ignore</code></td>
450 <td>Boolean</td>
451 <td>???</td>
452 </tr>
453
454 <tr>
455 <td><code>allow_cid</code></td>
456 <td>String (angle-brackets escaped integers)</td>
457 <td>Optional. List of allowed contact ids</td>
458 </tr>
459
460 <tr>
461 <td><code>allow_gid</code></td>
462 <td>String (angle-brackets escaped integers)</td>
463 <td>Optional. List of allowed group ids</td>
464 </tr>
465
466 <tr>
467 <td><code>deny_cid</code></td>
468 <td>String (angle-brackets escaped integers)</td>
469 <td>Optional. List of disallowed contact ids</td>
470 </tr>
471
472 <tr>
473 <td><code>deny_gid</code></td>
474 <td>String (angle-brackets escaped integers)</td>
475 <td>Optional. List of disallowed group ids</td>
476 </tr>
477
478 </tbody>
479 </table>
480
481 ## Hashtag
482
483 Unused
484
485 ## Item
486
487 <table class="table table-condensed table-striped table-bordered">
488 <thead>
489 <tr>
490 <th>Attribute</th>
491 <th>Type</th>
492 <th align="center">Nullable</th>
493 </tr>
494 </thead>
495
496 <tbody>
497 <tr>
498 <td><code>text</code></td>
499 <td>String (Plaintext)</td>
500 <td align="center">No</td>
501 </tr>
502
503 <tr>
504 <td><code>truncated</code></td>
505 <td>Boolean</td>
506 <td align="center">No</td>
507 </tr>
508
509 <tr>
510 <td><code>created_at</code></td>
511 <td>String (Date)<br/>
512 Ex: Wed May 23 06:01:13 +0000 2007
513 </td>
514 <td align="center">No</td>
515 </tr>
516
517 <tr>
518 <td><code>in_reply_to_status_id</code></td>
519 <td>Integer</td>
520 <td align="center">No</td>
521 </tr>
522
523 <tr>
524 <td><code>in_reply_to_status_id_str</code></td>
525 <td>String</td>
526 <td align="center">No</td>
527 </tr>
528
529 <tr>
530 <td><code>source</code></td>
531 <td>String</td>
532 <td align="center">No</td>
533 </tr>
534
535 <tr>
536 <td><code>id</code></td>
537 <td>Integer</td>
538 <td align="center">No</td>
539 </tr>
540
541 <tr>
542 <td><code>id_str</code></td>
543 <td>String</td>
544 <td align="center">No</td>
545 </tr>
546
547 <tr>
548 <td><code>in_reply_to_user_id</code></td>
549 <td>Integer</td>
550 <td align="center">No</td>
551 </tr>
552
553 <tr>
554 <td><code>in_reply_to_user_id_str</code></td>
555 <td>String</td>
556 <td align="center">No</td>
557 </tr>
558
559 <tr>
560 <td><code>in_reply_to_screen_name</code></td>
561 <td>String</td>
562 <td align="center">No</td>
563 </tr>
564
565 <tr>
566 <td><code>geo</code></td>
567 <td>String</td>
568 <td align="center">Yes</td>
569 </tr>
570
571 <tr>
572 <td><code>favorited</code></td>
573 <td>Boolean</td>
574 <td align="center">No</td>
575 </tr>
576
577 <tr>
578 <td><code>user</code></td>
579 <td><a href="help/API-Entities#Contact">Contact</a></td>
580 <td align="center">No</td>
581 </tr>
582
583 <tr>
584 <td><code>friendica_author</code></td>
585 <td><a href="help/API-Entities#Contact">Contact</a></td>
586 <td align="center">No</td>
587 </tr>
588
589 <tr>
590 <td><code>friendica_owner</code></td>
591 <td>
592  
593 <a href="help/API-Entities#Contact">Contact</a></td>
594 <td align="center">No</td>
595 </tr>
596
597 <tr>
598 <td><code>friendica_private</code></td>
599 <td>Boolean</td>
600 <td align="center">No</td>
601 </tr>
602
603 <tr>
604 <td><code>statusnet_html</code></td>
605 <td>String (HTML)</td>
606 <td align="center">No</td>
607 </tr>
608
609 <tr>
610 <td><code>statusnet_conversation_id</code></td>
611 <td>Integer</td>
612 <td align="center">No</td>
613 </tr>
614
615 <tr>
616 <td><code>external_url</code></td>
617 <td>String (URL)</td>
618 <td align="center">No</td>
619 </tr>
620
621 <tr>
622 <td><code>friendica_activities</code></td>
623 <td><a href="help/API-Entities#Activities">Activities</a></td>
624 <td align="center">No</td>
625 </tr>
626
627 <tr>
628 <td><code>friendica_title</code></td>
629 <td>String (Plaintext)</td>
630 <td align="center">No</td>
631 </tr>
632
633 <tr>
634 <td><code>friendica_html</code></td>
635 <td>String (HTML)</td>
636 <td align="center">No</td>
637 </tr>
638
639 <tr>
640 <td><code>attachments</code></td>
641 <td>List of <a href="help/API-Entities#Attachment">Attachments</a></td>
642 <td align="center">Yes</td>
643 </tr>
644
645 <tr>
646 <td><code>entities</code></td>
647 <td><a href="help/API-Entities#Entities">Entities</a></td>
648 <td align="center">Yes</td>
649 </tr>
650
651 </tbody>
652 </table>
653
654 ## Media
655
656 Identical to [the Twitter Media Object](https://developer.twitter.com/en/docs/tweets/data-dictionary/overview/entities-object#media).
657
658 <table class="table table-condensed table-striped table-bordered">
659 <thead>
660 <tr>
661 <th>Attribute</th>
662 <th>Type</th>
663 <th align="center">Nullable</th>
664 </tr>
665 </thead>
666 <tbody>
667
668 <tr>
669 <td><code>id</code></td>
670 <td>Integer</td>
671 <td align="center">No</td>
672 </tr>
673
674 <tr>
675 <td><code>id_str</code></td>
676 <td>String</td>
677 <td align="center">No</td>
678 </tr>
679
680 <tr>
681 <td><code>indices</code></td>
682 <td>List of Integer</td>
683 <td align="center">No</td>
684 </tr>
685
686 <tr>
687 <td><code>media_url</code></td>
688 <td>String (URL)</td>
689 <td align="center">No</td>
690 </tr>
691
692 <tr>
693 <td><code>media_url_https</code></td>
694 <td>String (URL)</td>
695 <td align="center">No</td>
696 </tr>
697
698 <tr>
699 <td><code>url</code></td>
700 <td>String (URL)</td>
701 <td align="center">No</td>
702 </tr>
703
704 <tr>
705 <td><code>display_url</code></td>
706 <td>String (URL)</td>
707 <td align="center">No</td>
708 </tr>
709
710 <tr>
711 <td><code>expanded_url</code></td>
712 <td>String (URL)</td>
713 <td align="center">No</td>
714 </tr>
715
716 <tr>
717 <td><code>ext_alt_text</code></td>
718 <td>String</td>
719 <td align="center">No</td>
720 </tr>
721
722 <tr>
723 <td><code>type</code></td>
724 <td>String</td>
725 <td align="center">No</td>
726 </tr>
727
728 <tr>
729 <td><code>sizes</code></td>
730 <td><a href="help/API-Entities#Sizes">Sizes</a></td>
731 <td align="center">No</td>
732 </tr>
733
734 </tbody>
735 </table>
736
737 ## Notification
738
739 <table class="table table-condensed table-striped table-bordered">
740 <thead>
741 <tr>
742 <th>Attribute</th>
743 <th>Type</th>
744 <th>Description</th>
745 </tr>
746 </thead>
747 <tbody>
748
749 <tr>
750 <td><code>id</code></td>
751 <td>Integer</td>
752 <td></td>
753 </tr>
754
755 <tr>
756 <td><code>hash</code></td>
757 <td>String</td>
758 <td></td>
759 </tr>
760
761 <tr>
762 <td><code>type</code></td>
763 <td>Integer</td>
764 <td><ul>
765 <li>1: Inbound follow request</li>
766 <li>2: Outbound follow request confirmation</li>
767 <li>4: Wall-to-wall post</li>
768 <li>8: Reply</li>
769 <li>16: Private message</li>
770 <li>32: Friend suggestion</li>
771 <li>64: Unused</li>
772 <li>128: Mention</li>
773 <li>256: Tag added to a post</li>
774 <li>512: Poke</li>
775 <li>1024: New post</li>
776 <li>16384: System email</li>
777 <li>32768: System event</li>
778 </ul></td>
779 </tr>
780
781 <tr>
782 <td><code>name</code></td>
783 <td>String</td>
784 <td>Full name of the contact subject</td>
785 </tr>
786
787 <tr>
788 <td><code>url</code></td>
789 <td>String (URL)</td>
790 <td>Profile page URL of the contact subject</td>
791 </tr>
792
793 <tr>
794 <td><code>photo</code></td>
795 <td>String (URL)</td>
796 <td>Profile photo URL of the contact subject</td>
797 </tr>
798
799 <tr>
800 <td><code>date</code></td>
801 <td>String (Date)</td>
802 <td><code>YYYY-MM-DD hh:mm:ss</code> local server time</td>
803 </tr>
804
805 <tr>
806 <td><code>msg</code></td>
807 <td>String (BBCode)</td>
808 <td></td>
809 </tr>
810
811 <tr>
812 <td><code>uid</code></td>
813 <td>Integer</td>
814 <td>Owner User Id</td>
815 </tr>
816
817 <tr>
818 <td><code>link</code></td>
819 <td>String (URL)</td>
820 <td>Notification URL</td>
821 </tr>
822
823 <tr>
824 <td><code>iid</code></td>
825 <td>Integer</td>
826 <td>Item Id</td>
827 </tr>
828
829 <tr>
830 <td><code>parent</code></td>
831 <td>Integer</td>
832 <td>Parent Item Id</td>
833 </tr>
834
835 <tr>
836 <td><code>seen</code></td>
837 <td>Integer (Boolean)</td>
838 <td>Whether the notification was read or not.</td>
839 </tr>
840
841 <tr>
842 <td><code>verb</code></td>
843 <td>String (URL)</td>
844 <td>[Activity Streams](http://activitystrea.ms) Verb URL</td>
845 </tr>
846
847 <tr>
848 <td><code>seen</code></td>
849 <td>Integer (Boolean)</td>
850 <td>Whether the notification was read or not.</td>
851 </tr>
852
853 <tr>
854 <td><code>otype</code></td>
855 <td>Enum</td>
856 <td>Subject type (`item`, `intro` or `mail`)</td>
857 </tr>
858
859 <tr>
860 <td><code>name_cache</code></td>
861 <td>String (HTML)</td>
862 <td>Full name of the contact subject</td>
863 </tr>
864
865 <tr>
866 <td><code>msg_cache</code></td>
867 <td>String (Plaintext)</td>
868 <td>Plaintext version of the notification text with a placeholder (`{0}`) for the subject contact's name.</td>
869 </tr>
870
871 <tr>
872 <td><code>timestamp</code></td>
873 <td>Integer</td>
874 <td>Unix timestamp</td>
875 </tr>
876
877 <tr>
878 <td><code>date_rel</code></td>
879 <td>String</td>
880 <td>Time since the note was posted, eg "1 hour ago"</td>
881 </tr>
882
883
884 <tr>
885 <td><code>msg_html</code></td>
886 <td>String (HTML)</td>
887 <td></td>
888 </tr>
889
890 <tr>
891 <td><code>msg_plain</code></td>
892 <td>String (Plaintext)</td>
893 <td></td>
894 </tr>
895
896 </tbody>
897 </table>
898
899 ## Photo
900
901 <table class="table table-condensed table-striped table-bordered">
902 <thead>
903 <tr>
904 <th>Attribute</th>
905 <th>Type</th>
906 <th>Description</th>
907 </tr>
908 </thead>
909 <tbody>
910
911 <tr>
912 <td><code>id</code></td>
913 <td>String</td>
914 <td>Resource ID (32 hex chars)</td>
915 </tr>
916
917 <tr>
918 <td><code>created</code></td>
919 <td>String (Date)</td>
920 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
921 </tr>
922
923 <tr>
924 <td><code>edited</code></td>
925 <td>String (Date)</td>
926 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
927 </tr>
928
929 <tr>
930 <td><code>title</code></td>
931 <td>String</td>
932 <td></td>
933 </tr>
934
935 <tr>
936 <td><code>desc</code></td>
937 <td>String (Plaintext)</td>
938 <td>Picture caption</td>
939 </tr>
940
941 <tr>
942 <td><code>album</code></td>
943 <td>String</td>
944 <td>Album name</td>
945 </tr>
946
947 <tr>
948 <td><code>filename</code></td>
949 <td>String</td>
950 <td>Original image filename</td>
951 </tr>
952
953 <tr>
954 <td><code>type</code></td>
955 <td>String</td>
956 <td>MIME Type</td>
957 </tr>
958
959 <tr>
960 <td><code>height</code></td>
961 <td>Integer</td>
962 <td>Image height in pixels</td>
963 </tr>
964
965 <tr>
966 <td><code>width</code></td>
967 <td>Integer</td>
968 <td>Image width in pixels</td>
969 </tr>
970
971 <tr>
972 <td><code>profile</code></td>
973 <td>Integer</td>
974 <td>1 if it is a profile photo</td>
975 </tr>
976
977 <tr>
978 <td><code>allow_cid</code></td>
979 <td>String (ACL)</td>
980 <td>List of contact ids wrapped in angle brackets allowed to access the photo.</td>
981 </tr>
982
983 <tr>
984 <td><code>allow_gid</code></td>
985 <td>String (ACL)</td>
986 <td>List of contact group ids wrapped in angle brackets allowed to access the photo.</td>
987 </tr>
988
989 <tr>
990 <td><code>deny_cid</code></td>
991 <td>String (ACL)</td>
992 <td>List of contact ids wrapped in angle brackets forbidden to access the photo.</td>
993 </tr>
994
995 <tr>
996 <td><code>deny_gid</code></td>
997 <td>String (ACL)</td>
998 <td>List of contact group ids wrapped in angle brackets forbidden to access the photo.</td>
999 </tr>
1000
1001 <tr>
1002 <td><code>link</code></td>
1003 <td>Array of Strings (URL)</td>
1004 <td>
1005 URLs to the different scales indexed by scale number if no specific scale was requested.
1006 Mutually exclusive with <code>data</code> <code>datasize</code>.
1007 </td>
1008 </tr>
1009
1010 <tr>
1011 <td><code>datasize</code></td>
1012 <td>Integer</td>
1013 <td>
1014 Picture size in bytes if a single scale was requested.
1015 Mutually exclusive with <code>link</code>.
1016 </td>
1017 </tr>
1018
1019 <tr>
1020 <td><code>data</code></td>
1021 <td>String</td>
1022 <td>
1023 Base64-encoded image data if a single scale was requested.
1024 Mutually exclusive with <code>link</code>.
1025 </td>
1026 </tr>
1027
1028 <tr>
1029 <td><code>friendica_activities</code></td>
1030 <td><a href="help/API-Entities#Activities">Activities</a></td>
1031 <td></td>
1032 </tr>
1033
1034 <tr>
1035 <td><code>friendica_comments</code></td>
1036 <td>List of <a href="help/API-Entities#Item">Items</a></td>
1037 <td></td>
1038 </tr>
1039
1040 <tr>
1041 <td><code>rights_mismatch</code></td>
1042 <td>Boolean</td>
1043 <td>True if the ACL differs between the picture and the associated item.</td>
1044 </tr>
1045
1046 </tbody>
1047 </table>
1048
1049 ## Photo List Item
1050
1051 <table class="table table-condensed table-striped table-bordered">
1052 <thead>
1053 <tr>
1054 <th>Attribute</th>
1055 <th>Type</th>
1056 <th>Description</th>
1057 </tr>
1058 </thead>
1059 <tbody>
1060
1061 <tr>
1062 <td><code>id</code></td>
1063 <td>String</td>
1064 <td>Resource ID (32 hex chars)</td>
1065 </tr>
1066
1067 <tr>
1068 <td><code>album</code></td>
1069 <td>String</td>
1070 <td>Album name</td>
1071 </tr>
1072
1073 <tr>
1074 <td><code>filename</code></td>
1075 <td>String</td>
1076 <td>Original image filename</td>
1077 </tr>
1078
1079 <tr>
1080 <td><code>type</code></td>
1081 <td>String</td>
1082 <td>MIME Type</td>
1083 </tr>
1084
1085 <tr>
1086 <td><code>created</code></td>
1087 <td>String (Date)</td>
1088 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
1089 </tr>
1090
1091 <tr>
1092 <td><code>edited</code></td>
1093 <td>String (Date)</td>
1094 <td>Format <code>YYYY-MM-DD HH:MM:SS</code></td>
1095 </tr>
1096
1097 <tr>
1098 <td><code>desc</code></td>
1099 <td>String (Plaintext)</td>
1100 <td>Picture caption</td>
1101 </tr>
1102
1103 <tr>
1104 <td><code>thumb</code></td>
1105 <td>String (URL)</td>
1106 <td>URL of the smallest scale version of the picture.</td>
1107 </tr>
1108
1109 </tbody>
1110 </table>
1111
1112 ## Private message
1113
1114 <table class="table table-condensed table-striped table-bordered">
1115 <thead>
1116 <tr>
1117 <th>Attribute</th>
1118 <th>Type</th>
1119 <th>Description</th>
1120 </tr>
1121 </thead>
1122 <tbody>
1123
1124 <tr>
1125 <td><code>id</code></td>
1126 <td>Integer</td>
1127 <td></td>
1128 </tr>
1129
1130 <tr>
1131 <td><code>sender_id</code></td>
1132 <td>Integer</td>
1133 <td>Sender Contact Id</td>
1134 </tr>
1135
1136 <tr>
1137 <td><code>text</code></td>
1138 <td>String</td>
1139 <td>Can be HTML or plaintext depending on the API call parameter `getText`.</td>
1140 </tr>
1141
1142 <tr>
1143 <td><code>recipient_id</code></td>
1144 <td>Integer</td>
1145 <td>Recipient Contact Id</td>
1146 </tr>
1147
1148 <tr>
1149 <td><code>created_at</code></td>
1150 <td>String (Date)</td>
1151 <td>Ex: Wed May 23 06:01:13 +0000 2007</td>
1152 </tr>
1153
1154 <tr>
1155 <td><code>sender_screen_name</code></td>
1156 <td>String</td>
1157 <td></td>
1158 </tr>
1159
1160 <tr>
1161 <td><code>recipient_screen_name</code></td>
1162 <td>String</td>
1163 <td></td>
1164 </tr>
1165
1166 <tr>
1167 <td><code>sender</code></td>
1168 <td><a href="help/API-Entities#Contact">Contact</a></td>
1169 <td></td>
1170 </tr>
1171
1172 <tr>
1173 <td><code>recipient</code></td>
1174 <td><a href="help/API-Entities#Contact">Contact</a></td>
1175 <td></td>
1176 </tr>
1177
1178 <tr>
1179 <td><code>title</code></td>
1180 <td>String</td>
1181 <td>Empty if the API call parameter `getText` is empty or absent.</td>
1182 </tr>
1183
1184 <tr>
1185 <td><code>friendica_seen</code></td>
1186 <td>Integer (Boolean)</td>
1187 <td>Whether the private message has been read or not.</td>
1188 </tr>
1189
1190 <tr>
1191 <td><code>friendica_parent_uri</code></td>
1192 <td>String</td>
1193 <td></td>
1194 </tr>
1195
1196 </tbody>
1197 </table>
1198
1199 ## Profile
1200
1201 <table class="table table-condensed table-striped table-bordered">
1202 <thead>
1203 <tr>
1204 <th>Attribute</th>
1205 <th>Type</th>
1206 <th>Description</th>
1207 </tr>
1208 </thead>
1209 <tbody>
1210
1211 <tr>
1212 <td><code>profile_id</code></td>
1213 <td>Integer</td>
1214 <td></td>
1215 </tr>
1216
1217 <tr>
1218 <td><code>profile_name</code></td>
1219 <td>String</td>
1220 <td></td>
1221 </tr>
1222
1223 <tr>
1224 <td><code>is_default</code></td>
1225 <td>Boolean</td>
1226 <td></td>
1227 </tr>
1228
1229 <tr>
1230 <td><code>hide_friends</code></td>
1231 <td>Boolean</td>
1232 <td>Whether the user chose to hide their contact list on their profile.</td>
1233 </tr>
1234
1235 <tr>
1236 <td><code>profile_photo</code></td>
1237 <td>String (URL)</td>
1238 <td>Largest size profile picture URL.</td>
1239 </tr>
1240
1241 <tr>
1242 <td><code>profile_thumb</code></td>
1243 <td>String (URL)</td>
1244 <td>Smallest size profile picture URL.</td>
1245 </tr>
1246
1247 <tr>
1248 <td><code>publish</code></td>
1249 <td>Boolean</td>
1250 <td>Whether the user chose to publish their profile in the local directory.</td>
1251 </tr>
1252
1253 <tr>
1254 <td><code>net_publish</code></td>
1255 <td>Boolean</td>
1256 <td>Whether the user chose to publish their profile in the global directory.</td>
1257 </tr>
1258
1259 <tr>
1260 <td><code>description</code></td>
1261 <td>String</td>
1262 <td></td>
1263 </tr>
1264
1265 <tr>
1266 <td><code>date_of_birth</code></td>
1267 <td>String</td>
1268 <td></td>
1269 </tr>
1270
1271 <tr>
1272 <td><code>address</code></td>
1273 <td>String</td>
1274 <td></td>
1275 </tr>
1276
1277 <tr>
1278 <td><code>city</code></td>
1279 <td>String</td>
1280 <td></td>
1281 </tr>
1282
1283 <tr>
1284 <td><code>region</code></td>
1285 <td>String</td>
1286 <td></td>
1287 </tr>
1288
1289 <tr>
1290 <td><code>postal_code</code></td>
1291 <td>String</td>
1292 <td></td>
1293 </tr>
1294
1295 <tr>
1296 <td><code>country</code></td>
1297 <td>String</td>
1298 <td></td>
1299 </tr>
1300
1301 <tr>
1302 <td><code>public_keywords</code></td>
1303 <td>String</td>
1304 <td>Comma-separated list of words meant to be displayed as hashtags.</td>
1305 </tr>
1306
1307 <tr>
1308 <td><code>private_keywords</code></td>
1309 <td>String</td>
1310 <td>Comma-separated list of words meant to be used for search only.</td>
1311 </tr>
1312
1313 <tr>
1314 <td><code>homepage</code></td>
1315 <td>String (URL)</td>
1316 <td></td>
1317 </tr>
1318
1319 </tbody>
1320 </table>
1321
1322 ## Size
1323
1324 <table class="table table-condensed table-striped table-bordered">
1325 <thead>
1326 <tr>
1327 <th>Attribute</th>
1328 <th>Type</th>
1329 <th align="center">Nullable</th>
1330 </tr>
1331 </thead>
1332 <tbody>
1333 <table class="table table-condensed table-striped table-bordered">
1334 <thead>
1335 <tr>
1336 <th>Attribute</th>
1337 <th>Type</th>
1338 <th align="center">Nullable</th>
1339 </tr>
1340 </thead>
1341 <tbody>
1342
1343 <tr>
1344 <td><code>w</code></td>
1345 <td>Integer</td>
1346 <td align="center">No</td>
1347 </tr>
1348
1349 <tr>
1350 <td><code>h</code></td>
1351 <td>Integer</td>
1352 <td align="center">No</td>
1353 </tr>
1354
1355 <tr>
1356 <td><code>resize</code></td>
1357 <td>Enum (fit, crop)</td>
1358 <td align="center">Yes</td>
1359 </tr>
1360
1361 </tbody>
1362 </table>
1363
1364
1365 ## Sizes
1366
1367 <table class="table table-condensed table-striped table-bordered">
1368 <thead>
1369 <tr>
1370 <th>Attribute</th>
1371 <th>Type</th>
1372 <th align="center">Nullable</th>
1373 </tr>
1374 </thead>
1375 <tbody>
1376
1377 <tr>
1378 <td><code>medium</code></td>
1379 <td><a href="help/API-Entities#Size">Size</a></td>
1380 <td align="center">No</td>
1381 </tr>
1382
1383 <tr>
1384 <td><code>large</code></td>
1385 <td><a href="help/API-Entities#Size">Size</a></td>
1386 <td align="center">Yes</td>
1387 </tr>
1388
1389 <tr>
1390 <td><code>thumb</code></td>
1391 <td><a href="help/API-Entities#Size">Size</a></td>
1392 <td align="center">Yes</td>
1393 </tr>
1394
1395 <tr>
1396 <td><code>small</code></td>
1397 <td><a href="help/API-Entities#Size">Size</a></td>
1398 <td align="center">Yes</td>
1399 </tr>
1400
1401 </tbody>
1402 </table>
1403
1404 ## Symbol
1405
1406 Unused
1407
1408 ## URL
1409
1410 <table class="table table-condensed table-striped table-bordered">
1411 <thead>
1412 <tr>
1413 <th>Attribute</th>
1414 <th>Type</th>
1415 <th align="center">Nullable</th>
1416 </tr>
1417 </thead>
1418 <tbody>
1419
1420 <tr>
1421 <td><code>url</code></td>
1422 <td>String (URL)</td>
1423 <td align="center">No</td>
1424 </tr>
1425
1426 <tr>
1427 <td><code>expanded_url</code></td>
1428 <td>String (URL)</td>
1429 <td align="center">No</td>
1430 </tr>
1431
1432 <tr>
1433 <td><code>display_url</code></td>
1434 <td>String (URL)</td>
1435 <td align="center">No</td>
1436 </tr>
1437
1438 <tr>
1439 <td><code>indices</code></td>
1440 <td>List of Integer</td>
1441 <td align="center">No</td>
1442 </tr>
1443
1444 </tbody>
1445 </table>
1446
1447 ## User Mention
1448
1449 Unused