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 .xml suffix or ?format=xml

HTTP + XML

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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<MediaGalleryAlbumResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/YM.Web.Services.Ams">
  <BypassCache xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">false</BypassCache>
  <ClientID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</ClientID>
  <Device xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">Desktop</Device>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types" xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <MemberID xmlns="http://schemas.datacontract.org/2004/07/YM.Toolkit">0</MemberID>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <ProfileID>0</ProfileID>
  <GalleryAlbumList>
    <GalleryAlbum>
      <AlbumID>0</AlbumID>
      <ImageURI>String</ImageURI>
      <Name>String</Name>
    </GalleryAlbum>
  </GalleryAlbumList>
</MediaGalleryAlbumResponse>