YM REST Services

<back to all web services

MediaGalleryAlbum

Requires Authentication
Requires any of the roles:member, oauthmember
The following routes are available for this service:
GET/Ams/{ClientID}/Member/{MemberID}/MediaGalleryAlbumReturn a member's media gallery album list.Returned list will include AlbumID of -1 which is a virtual album containing all of the member's media gallery items.
MediaGalleryAlbum Parameters:
NameParameterData TypeRequiredDescription
ProfileIDqueryintNo
PageSizequeryintNo
PageNumberqueryintNo
MemberBaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
MemberIDformintNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MediaGalleryAlbumResponse Parameters:
NameParameterData TypeRequiredDescription
GalleryAlbumListformList<GalleryAlbum>No
GalleryAlbum Parameters:
NameParameterData TypeRequiredDescription
AlbumIDformintNo
NameformstringNo
ImageURIformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Ams/{ClientID}/Member/{MemberID}/MediaGalleryAlbum HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"GalleryAlbumList":[{"AlbumID":0,"Name":"String","ImageURI":"String"}],"ProfileID":0,"PageSize":0,"PageNumber":0,"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-03T06:54:47.4555662-04:00","Device":"Desktop"}