YM REST Services

<back to all web services

PhotoComments

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
POST/Ams/{ClientID}/Member/{MemberID}/Photos/{PhotoId}/CommentsAdd a comment to a photo.
DELETE/Ams/{ClientID}/Member/{MemberID}/Photos/{PhotoId}/Comments/{CommentId}Remove a comment from a photo.
PhotoComments Parameters:
NameParameterData TypeRequiredDescription
PhotoIdpathintNo
CommentIdpathintNo
CommentbodystringNo
PostedBybodystringNo
PostedByMugshotbodystringNo
GroupIDbodyintNo
IsOwnerbodyboolNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
PhotoCommentsResponse Parameters:
NameParameterData TypeRequiredDescription
NewCommentformPhotoCommentNo
PhotoComment Parameters:
NameParameterData TypeRequiredDescription
CommentIDformintNo
CdbIDformintNo
PostedformDateTimeNo
PostedUTCformDateTimeNo
GalleryItemIDformintNo
SchoolIDformintNo
CommentformstringNo
PostedByformstringNo
PostedByMugshotformstringNo
PostedDateformstringNo
GroupIDformintNo
IsOwnerformboolNo
LikeIDformintNo
LikedCommentformboolNo
LikeCountformintNo
SkipCrossPostformboolNo

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.

POST /Ams/{ClientID}/Member/{MemberID}/Photos/{PhotoId}/Comments HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PhotoId: 0,
	CommentId: 0,
	Comment: String,
	PostedBy: String,
	PostedByMugshot: String,
	GroupID: 0,
	IsOwner: False,
	MemberID: 0,
	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:09:20.3547336-04:00,
	Device: Desktop
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	NewComment: 
	{
		CommentID: 0,
		CdbID: 0,
		Posted: 0001-01-01,
		PostedUTC: 0001-01-01,
		GalleryItemID: 0,
		SchoolID: 0,
		Comment: String,
		PostedBy: String,
		PostedByMugshot: String,
		PostedDate: String,
		GroupID: 0,
		IsOwner: False,
		LikeID: 0,
		LikedComment: False,
		LikeCount: 0,
		SkipCrossPost: False
	},
	PhotoId: 0,
	CommentId: 0,
	Comment: String,
	PostedBy: String,
	PostedByMugshot: String,
	GroupID: 0,
	IsOwner: False,
	MemberID: 0,
	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:09:20.3703233-04:00,
	Device: Desktop
}