YM REST Services

<back to all web services

FacebookProfile

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Social/FacebookProfileGet a profile from Facebook for an authorized user.
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
FacebookProfileResponse Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
emailformstringNo
first_nameformstringNo
middle_nameformstringNo
last_nameformstringNo
nameformstringNo
linkformstringNo
websiteformstringNo
profile_pictureformFacebookProfilePictureNo
FacebookProfilePicture Parameters:
NameParameterData TypeRequiredDescription
dataformFacebookProfilePictureDataNo
FacebookProfilePictureData Parameters:
NameParameterData TypeRequiredDescription
is_silhouetteformboolNo
urlformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/Social/FacebookProfile HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"id":"String","email":"String","first_name":"String","middle_name":"String","last_name":"String","name":"String","link":"String","website":"String","profile_picture":{"data":{"is_silhouette":false,"url":"String"}},"UsingRedis":true,"AppInitTime":"2024-05-03T08:24:19.2461065-04:00","ServerID":"WS-4-69-031","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T10:59:29.0939535-04:00","Device":"Desktop"}