PATCH | /User/Photo |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PhotoIDs | query | int[] | No | List of photo ID to be effected by the action. |
Type | query | string | No | Deprecated, do not use. |
Action | query | PhotoAction | No | Sets the action type, options are Move and Delete. |
GalleryID | query | int? | No | For Move action, the destination GalleryID needs to be set. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MainPhoto | form | UserPhoto | No | |
PatchedPhotoID | form | int[] | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PhotoID | form | int | No | |
MemberID | form | long | No | |
MainPhoto | form | bool | No | |
Locked | form | bool | No | |
Rejected | form | bool | No | |
FileName | form | string | No | |
Classification | form | int | No | |
Width | form | int | No | |
Height | form | int | No | |
ProfileType | form | bool | No | |
IsRefer | form | bool | No | |
PhotoFolderID | form | int | No | |
Featured | form | bool | No | |
DateCreated | form | DateTime | No | |
IsAutoReview | form | bool | No | |
SortNumber | form | int | No | |
MemberLikeCount | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 ] }