Requires any of the roles: | member, oauthmember |
GET | /Ams/{ClientID}/Member/{MemberID}/Photos | Return the list of photos in a single post including comments. | |
---|---|---|---|
GET | /Ams/{ClientID}/Member/{MemberID}/Photos/{PhotoId} | Return the data for a photo including comments. | |
PUT | /Ams/{ClientID}/Member/{MemberID}/Photos/{PhotoId} | Update a photo. |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PhotoId | path | int | No | |
PostId | body | int | No | |
Caption | body | string | No | |
PostedBy | body | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
MemberID | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
ClientID | form | int | No | |
ResponseStatus | form | ResponseStatus | No | |
BypassCache | form | bool | No | |
DateCached | form | DateTime | No | |
Device | form | Device | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
PhotoUrl | form | string | No | |
PostedUTC | form | DateTime | No | |
PostedByMugshot | form | string | No | |
GroupID | form | int | No | |
IsOwner | form | bool | No | |
ShareCount | form | int | No | |
LikeCount | form | int | No | |
LikedPhoto | form | bool | No | |
LikeId | form | int | No | |
AllowComments | form | bool | No | |
CommentCount | form | int | No | |
PhotoCommentList | form | List<PhotoComment> | No | |
CanShare | form | bool | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
CommentID | form | int | No | |
CdbID | form | int | No | |
Posted | form | DateTime | No | |
PostedUTC | form | DateTime | No | |
GalleryItemID | form | int | No | |
SchoolID | form | int | No | |
Comment | form | string | No | |
PostedBy | form | string | No | |
PostedByMugshot | form | string | No | |
PostedDate | form | string | No | |
GroupID | form | int | No | |
IsOwner | form | bool | No | |
LikeID | form | int | No | |
LikedComment | form | bool | No | |
LikeCount | form | int | No | |
SkipCrossPost | form | bool | 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.
PUT /Ams/{ClientID}/Member/{MemberID}/Photos HTTP/1.1
Host: ws.yourmembership.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
PhotoId: 0,
PostId: 0,
Caption: String,
PostedBy: String,
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: 2025-01-15T09:11:40.1803478-05:00,
Device: Desktop
}
HTTP/1.1 200 OK Content-Type: text/jsv Content-Length: length { PhotoUrl: String, PostedUTC: 0001-01-01, PostedByMugshot: String, GroupID: 0, IsOwner: False, ShareCount: 0, LikeCount: 0, LikedPhoto: False, LikeId: 0, AllowComments: False, CommentCount: 0, PhotoCommentList: [ { 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 } ], CanShare: False, PhotoId: 0, PostId: 0, Caption: String, PostedBy: String, 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: 2025-01-15T09:11:40.1803478-05:00, Device: Desktop }