YM REST Services

Notifications

**Requires Authentication**
Requires any of the roles:	member, oauthmember

The following routes are available for this service:
GET	/Ams/{ClientID}/Member/{MemberID}/Notifications	Return a list of notifications for a member.
POST	/Ams/{ClientID}/Member/{MemberID}/Notifications	Update the notifications status for a member and reset the count flag date.

**Notifications** Parameters:
Name	Parameter	Data Type	Required
Id	body	int	No
PageNumber	body	int	No
PageSize	body	int	No
Offset	body	int	No

**MemberBaseSharedDto** Parameters:
Name	Parameter	Data Type	Required	Description
MemberID	form	int	No

**BaseSharedDto** Parameters:
Name	Parameter	Data Type	Required
ClientID	form	int	No
ResponseStatus	form	ResponseStatus	No
BypassCache	form	bool	No
DateCached	form	DateTime	No
Device	form	Device	No

**NotificationsResponse** Parameters:
Name	Parameter	Data Type	Required	Description
NotificationCount	form	int	No
NotificationList	form	List<Notification>	No

**Notification** Parameters:
Name	Parameter	Data Type	Required
Id	form	int	No
Message	form	string	No
Headline	form	PostHeadline	No
MemberId	form	int	No
PostId	form	int	No
HeadshotImage	form	string	No
IsRead	form	bool	No
DateCreated	form	DateTime	No
Category	form	string	No
ActionType	form	ActionType	No
NavigateUrl	form	string	No
PrimaryId	form	int	No
PhotoUrl	form	string	No
PhotoUrlLarge	form	string	No

**PostHeadline** Parameters:
Name	Parameter	Data Type	Required
HeadlineText	form	string	No
HeadlineLink	form	List<LinkDetail>	No
Photo	form	string	No
PhotoId	form	int	No
PhotoOwnerId	form	int	No
PostId	form	int	No
CommentId	form	int	No
PhotoCommentId	form	int	No
GroupId	form	int	No

**LinkDetail** Parameters:
Name	Parameter	Data Type	Required
Start	form	int	No
End	form	int	No
Length	form	int	No
Url	form	string	No
MemberId	form	int	No
PostId	form	int	No
EventId	form	int	No
GroupId	form	int	No
IsBold	form	bool	No
IsLink	form	bool	No

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.

POST /Ams/{ClientID}/Member/{MemberID}/Notifications HTTP/1.1 
Host: ws.yourmembership.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<Notifications 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>
  <Id>0</Id>
  <Offset>0</Offset>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
</Notifications>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<NotificationsResponse 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>
  <Id>0</Id>
  <Offset>0</Offset>
  <PageNumber>0</PageNumber>
  <PageSize>0</PageSize>
  <NotificationCount>0</NotificationCount>
  <NotificationList>
    <Notification>
      <ActionType>None</ActionType>
      <Category>String</Category>
      <DateCreated>0001-01-01T00:00:00</DateCreated>
      <Headline>
        <CommentId>0</CommentId>
        <GroupId>0</GroupId>
        <HeadlineLink>
          <PostHeadline.LinkDetail>
            <End>0</End>
            <EventId>0</EventId>
            <GroupId>0</GroupId>
            <IsBold>false</IsBold>
            <IsLink>false</IsLink>
            <Length>0</Length>
            <MemberId>0</MemberId>
            <PostId>0</PostId>
            <Start>0</Start>
            <Url>String</Url>
          </PostHeadline.LinkDetail>
        </HeadlineLink>
        <HeadlineText>String</HeadlineText>
        <Photo>String</Photo>
        <PhotoCommentId>0</PhotoCommentId>
        <PhotoId>0</PhotoId>
        <PhotoOwnerId>0</PhotoOwnerId>
        <PostId>0</PostId>
      </Headline>
      <HeadshotImage>String</HeadshotImage>
      <Id>0</Id>
      <IsRead>false</IsRead>
      <MemberId>0</MemberId>
      <Message>String</Message>
      <NavigateUrl>String</NavigateUrl>
      <PhotoUrl>String</PhotoUrl>
      <PhotoUrlLarge>String</PhotoUrlLarge>
      <PostId>0</PostId>
      <PrimaryId>0</PrimaryId>
    </Notification>
  </NotificationList>
</NotificationsResponse>