YM REST Services

<back to all web services

CommunityPhotos

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
GET/Ams/{ClientID}/CommunityPhotos/{PhotoId}Return the data for a photo including comments.
PUT/Ams/{ClientID}/CommunityPhotos/{PhotoId}Update a photo.
CommunityPhotos Parameters:
NameParameterData TypeRequiredDescription
PhotoIdpathintNo
CaptionbodystringNo
PostedBybodystringNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
CommunityPhotosResponse Parameters:
NameParameterData TypeRequiredDescription
PostedUTCformDateTimeNo
PostedByMugshotformstringNo
ShareCountformintNo
LikeCountformintNo
CommentCountformintNo
PhotoCommentListformList<PhotoComment>No
PhotoComment Parameters:
NameParameterData TypeRequiredDescription
CommentIDformintNo
CdbIDformintNo
PostedformDateTimeNo
PostedUTCformDateTimeNo
GalleryItemIDformintNo
SchoolIDformintNo
CommentformstringNo
PostedByformstringNo
PostedByMugshotformstringNo
PostedDateformstringNo
GroupIDformintNo
IsOwnerformboolNo
LikeIDformintNo
LikedCommentformboolNo
LikeCountformintNo
SkipCrossPostformboolNo

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.

PUT /Ams/{ClientID}/CommunityPhotos/{PhotoId} HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CommunityPhotos 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>
  <Caption>String</Caption>
  <PhotoId>0</PhotoId>
  <PostedBy>String</PostedBy>
</CommunityPhotos>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CommunityPhotosResponse 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>
  <Caption>String</Caption>
  <PhotoId>0</PhotoId>
  <PostedBy>String</PostedBy>
  <CommentCount>0</CommentCount>
  <LikeCount>0</LikeCount>
  <PhotoCommentList xmlns:d2p1="http://schemas.datacontract.org/2004/07/YM.SaaS.BusinessObjects.PhotoGallery">
    <d2p1:PhotoComment>
      <d2p1:CdbID>0</d2p1:CdbID>
      <d2p1:Comment>String</d2p1:Comment>
      <d2p1:GalleryItemID>0</d2p1:GalleryItemID>
      <d2p1:GroupID>0</d2p1:GroupID>
      <d2p1:IsOwner>false</d2p1:IsOwner>
      <d2p1:LikeCount>0</d2p1:LikeCount>
      <d2p1:LikeID>0</d2p1:LikeID>
      <d2p1:LikedComment>false</d2p1:LikedComment>
      <d2p1:Posted>0001-01-01T00:00:00</d2p1:Posted>
      <d2p1:PostedBy>String</d2p1:PostedBy>
      <d2p1:PostedByMugshot>String</d2p1:PostedByMugshot>
      <d2p1:PostedDate>String</d2p1:PostedDate>
      <d2p1:PostedUTC>0001-01-01T00:00:00</d2p1:PostedUTC>
      <d2p1:SchoolID>0</d2p1:SchoolID>
      <d2p1:SkipCrossPost>false</d2p1:SkipCrossPost>
    </d2p1:PhotoComment>
  </PhotoCommentList>
  <PostedByMugshot>String</PostedByMugshot>
  <PostedUTC>0001-01-01T00:00:00</PostedUTC>
  <ShareCount>0</ShareCount>
</CommunityPhotosResponse>