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 .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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-03T06:25:33.7052010-04:00,
	ServerID: WS-6-183-431,
	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-03T09:19:32.7372400-04:00,
	Device: Desktop
}