-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathAPI.txt
More file actions
889 lines (838 loc) · 18.3 KB
/
API.txt
File metadata and controls
889 lines (838 loc) · 18.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
URI.path(/album/)
GET - Fetches an album and all the photos in it.
Input : id
Output : {
cover_photo string
description string
from User
location string
name string
privacy string
photos string
created_time datetime
updated_time datetime
}
POST - This creates an empty album if id is NULL. Updates the album is id is valid. Gives an error if id is invalid.
Input :
{
id string
description string
from User
location string
name string
privacy string
}
Output : {Success_msg}
DELETE - Deletes the album and all the photos inside it.
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
COMMENT
GET
Input : id
Output : {
id string
created_time datetime
from User
like_count int32
message string
object Object
parent comment
}
POST
Input : {
id string
created_time datetime
from User
like_count int32
message string
object Object
parent comment
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/Conversation/)
GET
Input : id
Output : {
id string
snippet string
updated_time datetime
message_count int
unread_count int
tags object
participants User[]
senders User[]
can_reply boolean
is_subscribed boolean
}
POST
Input : {
id string
snippet string
updated_time datetime
message_count int
unread_count int
tags object
participants User[]
senders User[]
can_reply boolean
is_subscribed boolean
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/friendlist/)
GET
Input : id
Output : {
id
numeric string
name
string
list_type
enum
owner
numeric string
}
POST
Input : {
id
numeric string
name
string
list_type
enum
owner
numeric string
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/group/)
GET
Input : id
Output : {
id string
cover CoverPhoto
description string
email string
icon string
link string
member_request_count int
name string
owner User|Page
parent Group|Page|App
privacy string
updated_time datetime
}
POST
Input : {
id string
cover CoverPhoto
description string
email string
icon string
link string
member_request_count int
name string
owner User|Page
parent Group|Page|App
privacy string
updated_time datetime
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/groupdoc/)
GET
Input : id
Output : {
id string
from User|Page
subject string
message string
icon string
created_time datetime
updated_time datetime
revision int
can_edit boolean
can_delete boolean
}
POST
Input : {
id string
from User|Page
subject string
message string
icon string
created_time datetime
updated_time datetime
revision int
can_edit boolean
can_delete boolean
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/link/) *what does this do?
GET
Input : id
Output : {
id string
created_time datetime
description string
from User
icon string
link string
message string
name string
picture string
}
POST
Input : {
id string
created_time datetime
description string
from User
icon string
link string
message string
name string
picture string
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/message/) *shud it be a private api?
GET
Input : id
Output : {
created_time datetime
from Profile
id string
message string
subject string
tags object[]
to Profile[]
}
POST
Input : {
created_time datetime
from Profile
id string
message string
subject string
tags object[]
to Profile[]
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/notification/) *do we even require this path translation?
GET
Input : id
Output : {
id string
from User|Page|App
to User
created_time datetime
updated_time datetime
title string
link string
application App
unread int
object Object
}
POST
Input : {
id string
from User|Page|App
to User
created_time datetime
updated_time datetime
title string
link string
application App
unread int
object Object
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/objcomments/)
GET
Input : id
Output : {
order enum{chronological, ranked}
total_count int32
}
POST
Input : {
order enum{chronological, ranked}
total_count int32
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/objlikes/)
GET
Input : id
Output : {
total_count int32
}
POST
Input : {
total_count int32
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/post/)
GET
Input : id
Output : {
id string
admin_creator object[]
application App
call_to_action object
caption string
created_time datetime
description string
feed_targeting object
from Profile
icon string
is_hidden boolean
is_published boolean
link string
message string
message_tags object
name string
object_id string
picture string
place Place
privacy object
properties object[]
shares object
source string
status_type enum{mobile_status_update, created_note, added_photos, added_video, shared_story, created_group, created_event, wall_post, app_created_story, published_story, tagged_in_photo, approved_friend}
story string
story_tags array
targeting object
to Profile[]
type enum{link, status, photo, video, offer}
updated_time datetime
with_tags JSON object with a data field that contains a list of Profile objects.
}
POST
Input : {
id string
admin_creator object[]
application App
call_to_action object
caption string
created_time datetime
description string
feed_targeting object
from Profile
icon string
is_hidden boolean
is_published boolean
link string
message string
message_tags object
name string
object_id string
picture string
place Place
privacy object
properties object[]
shares object
source string
status_type enum{mobile_status_update, created_note, added_photos, added_video, shared_story, created_group, created_event, wall_post, app_created_story, published_story, tagged_in_photo, approved_friend}
story string
story_tags array
targeting object
to Profile[]
type enum{link, status, photo, video, offer}
updated_time datetime
with_tags JSON object with a data field that contains a list of Profile objects.
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/page/)
GET
Input : id
Output : {
id numeric string
about string
access_token string
ad_campaign AdCampaign
affiliation string
app_id id
app_links AppLinks
artists_we_likestring
attire string
awards string
band_interests string
band_members string
best_page Page
bio string
birthday string
booking_agent string
built string
business can_checkin
bool
can_post bool
category string
category_list list<PageCategory>
company_overview string
contact_address MailingAddress
context OpenGraphContext
country_page_likes unsigned int32
cover CoverPhoto
culinary_team string
current_location string
description string
description_html string
directed_by string
display_subtext string
emails list<string>
features string
food_styles list<string>
founded string
general_info string
general_manager string
genre string
global_brand_page_name string
global_brand_root_id numeric string
has_added_app bool
leadgen_tos_accepted bool
hometown string
hours map<string, string>
impressum string
influences string
is_always_open bool
is_community_page bool
is_permanently_closed bool
is_published bool
is_unclaimed bool
is_verified bool
keywords null
link string
location Location
mission string
mpg string
name string
name_with_location_descriptor string
network string
new_like_count unsigned int32
offer_eligible bool
parent_page Page
parking PageParking
payment_options PagePaymentOptions
personal_info string
personal_interests string
pharma_safety_info string
phone string
plot_outline string
press_contact string
price_range string
produced_by string
products string
promotion_eligible bool
promotion_ineligible_reason string
public_transit string
record_label string
release_date string
restaurant_services PageRestaurantServices
restaurant_specialties PageRestaurantSpecialties
schedule string
screenplay_by string
season string
starring string
start_info PageStartInfo
store_location_descriptor string
store_number unsigned int32
studio string
talking_about_count unsigned int32
engagement Engagement
single_line_address string
place_type enum
unread_message_count unsigned int32
unread_notif_count unsigned int32
unseen_message_count unsigned int32
username string
voip_info VoipInfo website string
were_here_count unsigned int32
written_by string
featured_video Video
owner_business Business
last_used_time datetime
asset_score float
checkins unsigned int32
likes unsigned int32
members string
}
POST:
Input : {
id numeric string
about string
access_token string
ad_campaign AdCampaign
affiliation string
app_id id
app_links AppLinks
artists_we_likestring
attire string
awards string
band_interests string
band_members string
best_page Page
bio string
birthday string
booking_agent string
built string
business can_checkin
bool
can_post bool
category string
category_list list<PageCategory>
company_overview string
contact_address MailingAddress
context OpenGraphContext
country_page_likes unsigned int32
cover CoverPhoto
culinary_team string
current_location string
description string
description_html string
directed_by string
display_subtext string
emails list<string>
features string
food_styles list<string>
founded string
general_info string
general_manager string
genre string
global_brand_page_name string
global_brand_root_id numeric string
has_added_app bool
leadgen_tos_accepted bool
hometown string
hours map<string, string>
impressum string
influences string
is_always_open bool
is_community_page bool
is_permanently_closed bool
is_published bool
is_unclaimed bool
is_verified bool
keywords null
link string
location Location
mission string
mpg string
name string
name_with_location_descriptor string
network string
new_like_count unsigned int32
offer_eligible bool
parent_page Page
parking PageParking
payment_options PagePaymentOptions
personal_info string
personal_interests string
pharma_safety_info string
phone string
plot_outline string
press_contact string
price_range string
produced_by string
products string
promotion_eligible bool
promotion_ineligible_reason string
public_transit string
record_label string
release_date string
restaurant_services PageRestaurantServices
restaurant_specialties PageRestaurantSpecialties
schedule string
screenplay_by string
season string
starring string
start_info PageStartInfo
store_location_descriptor string
store_number unsigned int32
studio string
talking_about_count unsigned int32
engagement Engagement
single_line_address string
place_type enum
unread_message_count unsigned int32
unread_notif_count unsigned int32
unseen_message_count unsigned int32
username string
voip_info VoipInfo website string
were_here_count unsigned int32
written_by string
featured_video Video
owner_business Business
last_used_time datetime
asset_score float
checkins unsigned int32
likes unsigned int32
members string
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/photo/)
GET
Input : id
Output : {
id numeric string
album Album
created_time datetime
can_delete bool
can_tag bool
from User|Page
height unsigned int32
icon string
images list<PlatformImageSource>
link string
name string
name_tags list<EntityAtTextRange>
page_story_id string
position unsigned int32
source string
updated_time datetime
width unsigned int32
event Event
place Place
backdated_time datetime
backdated_time_granularity enum
picture string
}
POST
Input : {
id numeric string
album Album
created_time datetime
can_delete bool
can_tag bool
from User|Page
height unsigned int32
icon string
images list<PlatformImageSource>
link string
name string
name_tags list<EntityAtTextRange>
page_story_id string
position unsigned int32
source string
updated_time datetime
width unsigned int32
event Event
place Place
backdated_time datetime
backdated_time_granularity enum
picture string
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/status/)
GET
Input : id
Output : {
id string
event Event
from Profile
message string
place Page
updated_time datetime
}
POST
Input : {
id string
event Event
from Profile
message string
place Page
updated_time datetime
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/thread/)
GET
Input : id
Output : {
id string
comments Message[]
to Profile[]
unread integer
unseen integer
updated_time datetime
}
POST
Input : {
id string
comments Message[]
to Profile[]
unread integer
unseen integer
updated_time datetime
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}
--------------------------------------------------------------------------------
URI.path(/user/)
GET
Input : id
Output : {
id numeric string
about string
age_range AgeRange
bio string
birthday string
context UserContext
currency Currency
devices list<UserDevice>
education list<EducationExperience>
email string
favorite_athletes list<Experience>
favorite_teams list<Experience>
first_name string
gender string
hometown Page
inspirational_people list<Experience>
install_type enum
installed bool
interested_in list<string>
is_shared_login bool
is_verified bool
languages list<Experience>
last_name string
link string
location Page
locale string
meeting_for list<string>
middle_name string
name string
name_format string
payment_pricepoints PaymentPricepoints
test_group unsigned int32
political string
relationship_status string
religion string
security_settings SecuritySettings
significant_other User
sports list<Experience>
quotes string
third_party_id string
timezone float (min: -24) (max: 24)
token_for_business string
updated_time datetime
shared_login_upgrade_required_by datetime
verified bool
video_upload_limits VideoUploadLimits
viewer_can_send_gift bool
website string
work list<WorkExperience>
public_key string
cover CoverPhoto
}
POST
Input : {
id numeric string
about string
age_range AgeRange
bio string
birthday string
context UserContext
currency Currency
devices list<UserDevice>
education list<EducationExperience>
email string
favorite_athletes list<Experience>
favorite_teams list<Experience>
first_name string
gender string
hometown Page
inspirational_people list<Experience>
install_type enum
installed bool
interested_in list<string>
is_shared_login bool
is_verified bool
languages list<Experience>
last_name string
link string
location Page
locale string
meeting_for list<string>
middle_name string
name string
name_format string
payment_pricepoints PaymentPricepoints
test_group unsigned int32
political string
relationship_status string
religion string
security_settings SecuritySettings
significant_other User
sports list<Experience>
quotes string
third_party_id string
timezone float (min: -24) (max: 24)
token_for_business string
updated_time datetime
shared_login_upgrade_required_by datetime
verified bool
video_upload_limits VideoUploadLimits
viewer_can_send_gift bool
website string
work list<WorkExperience>
public_key string
cover CoverPhoto
}
Output : {Success_msg}
DELETE
Input : id
Output : {Success_msg}