Topics


Messages

Announcements

 

GET /api/membership.ashx/users/{UserId}/announcements

Returns a list of all announcements for the specified user.

Response

Status: 200 OK

<ProfileAnnouncementList>
  <ProfileAnnouncement>
    ...
  </ProfileAnnouncement>
  ...
</ProfileAnnouncementList>

 

GET /api/membership.ashx/users/{UserId}/announcements/{AnnouncementId}

This will return the information for the referenced announcement.

Response

Status: 200 OK

<ProfileAnnouncement>
  ...
</ProfileAnnouncement>

 

Create Announcement

POST /api/membership.ashx/users/{UserId}/announcements

Creates a new announcement.

Request

<ProfileAnnouncement>
  ...
</ProfileAnnouncement>

Response

Status: 201 CREATED

<ProfileAnnouncement>
  ...
</ProfileAnnouncement>

 

Update Announcement

PUT /api/membership.ashx/users/{UserId}/announcements/{AnnouncementId}

Request

<ProfileAnnouncement>
  ...
</ProfileAnnouncement>

Response

Status: 200 OK

<ProfileAnnouncement>
  ...
</ProfileAnnouncement>

 

Delete Announcement

DELETE /api/membership.ashx/users/{UserId}/announcements/{AnnouncementId}

Response

Status: 200 OK

 

Comments

 

GET /api/membership.ashx/users/{UserId}/comments

Returns a list of all comments for the specified user.

Response

Status: 200 OK

<ProfileCommentList>
  <ProfileComment>
    ...
  </ProfileComment>
  ...
</ProfileCommentList>

 

GET /api/membership.ashx/users/{UserId}/comments/{CommentId}

This will return the information for the referenced comment.

Response

Status: 200 OK

<ProfileComment>
  ...
</ProfileComment>

 

Create Comment

POST /api/membership.ashx/users/{UserId}/comments

Creates a new comment.

Request

<ProfileComment>
  ...
</ProfileComment>

Response

Status: 201 CREATED

<ProfileComment>
  ...
</ProfileComment>

 

Update Comment

PUT /api/membership.ashx/users/{UserId}/comments/{CommentId}

Request

<ProfileComment>
  ...
</ProfileComment>

Response

Status: 200 OK

<ProfileComment>
  ...
</ProfileComment>

 

Delete Comment

DELETE /api/membership.ashx/users/{UserId}/comments/{CommentId}

Response

Status: 200 OK

 

Conversations

 

GET /api/membership.ashx/users/{UserId}/conversations

Returns a list of all conversations for the specified user.

Response

Status: 200 OK

<ConversationList>
  <Conversation>
    ...
  </Conversation>
  ...
</ConversationList>

 

GET /api/membership.ashx/users/{UserId}/conversations/{ConversationId}

This will return the information for the referenced conversation.

Response

Status: 200 OK

<Conversation>
  ...
</Conversation>

 

Create Conversation

POST /api/membership.ashx/users/{UserId}/conversations

Creates a new conversation.

Request

<ConversationMessage>
  ...
</ConversationMessage>

Response

Status: 201 CREATED

<Conversation>
  ...
</Conversation>

 

Conversation Messages

 

GET /api/membership.ashx/users/{UserId}/conversations/{ConversationId}/messages

Returns a list of all messages in the conversation.

Response

Status: 200 OK

<ConversationMessageList>
  <ConversationMessage>
    ...
  </ConversationMessage>
  ...
</ConversationMessageList>

 

GET /api/membership.ashx/users/{UserId}/conversations/{ConversationId}/messages/{MessageId}

This will return the information for the referenced message within the conversation.

Response

Status: 200 OK

<ConversationMessage>
  ...
</ConversationMessage>

 

Create Conversation Message

POST /api/membership.ashx/users/{UserId}/conversations/{ConversationId}/messages

Creates a new message in the conversation.

Request

<ConversationMessage>
  ...
</ConversationMessage>

Response

Status: 201 CREATED

<ConversationMessage>
  ...
</ConversationMessage>

 

Conversation Participants

 

GET /api/membership.ashx/users/{UserId}/conversations/{ConversationId}/participants

Returns a list of all participants in the conversation.

Response

Status: 200 OK

<MembershipList>
  <UserInfo />
  ...
</MembershipList>

 

GET /api/membership.ashx/users/{UserId}/conversations/{ConversationId}/participants/{ParticipantId}

This will return the information for the referenced participant within the conversation.

Response

Status: 200 OK

<UserInfo />

 

Data Reference

 

ProfileAnnouncement

<ProfileAnnouncement>
  <Id>2497783f-7074-4f71-a103-8b90a9994e45</Id>
  <Author Id="3918"
    Endpoint="http://localhost/cs/api/membership.ashx/users/2101" />
  <Body>&lt;p&gt;Please enjoy my various postings.&lt;/p&gt;</Body>
  <DateCreated>2008-04-30T12:22:42.18</DateCreated>
  <Subject>Welcome to my profile</Subject>
</ProfileAnnouncement>

ProfileComment

<ProfileComment>
  <Id>9c99139c-97ff-42ab-8341-94bb2add00c2</Id>
  <Author Id="6944"
    Endpoint="http://localhost/cs/api/membership.ashx/users/6944" />
  <Body>
    &lt;p&gt;Nice profile!  Keep up the great work.&lt;/p&gt;
  </Body>
  <DateCreated>2008-04-30T12:29:47.78</DateCreated>
  <Subject>Awesome profile!</Subject>
</ProfileComment>

Conversation

<Conversation>
  <Messages
    Endpoint="http://localhost/cs/api/membership.ashx/conversations/a46613ff-2869-4765-9525-ed81143853d8/messages/" />
  <Participants
    Endpoint="http://localhost/cs/api/membership.ashx/conversations/a46613ff-2869-4765-9525-ed81143853d8/participants/" />
  <Id>a46613ff-2869-4765-9525-ed81143853d8</Id>
  <Initiator Id="6944"
    Endpoint="http://localhost/cs/api/membership.ashx/users/6944" />
  <DateCreated>2008-04-30T12:30:32.373</DateCreated>
  <DateUpdated>2008-04-30T12:30:32.373</DateUpdated>
</Conversation>

ConversationMessage

<ConversationMessage>
  <Id>5df08259-b1d5-45ad-9f8a-75b25a20b554</Id>
  <Author Id="2102"
    Endpoint="http://localhost/cs/api/membership.ashx/users/2102" />
  <Body>
    &lt;p&gt;Got&amp;nbsp;beer?&amp;nbsp;&lt;/p&gt;
  </Body>
  <DateCreated>2008-04-30T12:30:32.357</DateCreated>
  <Subject>Beer</Subject>
</ConversationMessage>

UserInfo

<UserInfo Id="2102"
    Endpoint="http://localhost/cs/api/membership.ashx/users/2102" />

 

Query Reference

Query properties are key value pairs separated by a semicolon. Arrays should be formatted as comma separated strings.

Profile Comment Query

Property Type Description
UserId int The UserId of the user whose comments to query for.
AuthorId int The UserId of the author of comments to query for.
PageSize int (defaults to 20)
PageIndex int (defaults to 0)

 

Paged Query

Property Type Description
PageSize int (defaults to 20)
PageIndex int (defaults to 0)