RHP_API

<back to all web services

PatchUserPhoto

Requires Authentication
The following routes are available for this service:
PATCH/User/Photo
PatchUserPhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDsqueryint[]NoList of photo ID to be effected by the action.
TypequerystringNoDeprecated, do not use.
ActionqueryPhotoActionNoSets the action type, options are Move and Delete.
GalleryIDqueryint?NoFor Move action, the destination GalleryID needs to be set.
PatchedUserPhoto Parameters:
NameParameterData TypeRequiredDescription
MainPhotoformUserPhotoNo
PatchedPhotoIDformint[]No
UserPhoto Parameters:
NameParameterData TypeRequiredDescription
PhotoIDformintNo
MemberIDformlongNo
MainPhotoformboolNo
LockedformboolNo
RejectedformboolNo
FileNameformstringNo
ClassificationformintNo
WidthformintNo
HeightformintNo
ProfileTypeformboolNo
IsReferformboolNo
PhotoFolderIDformintNo
FeaturedformboolNo
DateCreatedformDateTimeNo
IsAutoReviewformboolNo
SortNumberformintNo
MemberLikeCountformintNo

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.

PATCH /User/Photo HTTP/1.1 
Host: tstsrvs.redhotpie.com.au 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PhotoIDs: 
	[
		0
	],
	Type: String,
	Action: Move,
	GalleryID: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	MainPhoto: 
	{
		PhotoID: 0,
		Gallery: 
		{
			GalleryID: 0,
			Name: String,
			IsPublic: False,
			ImageCount: 0,
			Status: Pending,
			ExpiryDateUTC: 0001-01-01
		},
		ThumbUrl: String,
		FullUrl: String,
		ApprovalStatus: Approved,
		MainPhoto: False,
		Height: 0,
		Width: 0,
		IsUserImage: False,
		Classification: 0,
		PrivateGalleryOnly: False,
		SortOrder: 0
	},
	PatchedPhotoID: 
	[
		0
	]
}