POST api/v2.0/Contacts/GetContactContributions
Returns a list of published items a given Contact has authored. The list includes Announcements, Blogs, Discussion Messages, Library Entries, Questions, and Answers.
Request Information
URI Parameters
None.
Body Parameters
Properties to apply to return a paginated/scrollable list of items
ContactContributionRequestName | Description | Type | Additional information |
---|---|---|---|
ContactKey |
The key of the Contact whose contributions to return |
globally unique identifier |
None. |
SortOrder |
Sort Order possible values: asc or desc. Default: desc |
string |
None. |
NumberToReturn |
Number of items to return in the feed. Valid number to return is between 0 and 25. Default is 10. |
integer |
None. |
Direction |
Direction to fetch from the specified marker up (Larger Value) down (Smaller Value) |
string |
None. |
Marker |
Origin marker that can be used to grab the next set of feed items based on a marker from a previous request. |
string |
None. |
Request Formats
application/json, text/json
{ "ContactKey": "b60c9b48-262f-4b85-b962-a5af3b215e20", "SortOrder": "sample string 2", "NumberToReturn": 3, "Direction": "sample string 4", "Marker": "sample string 5" }
application/xml, text/xml
<ContactContributionRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.DataFeed"> <Direction>sample string 4</Direction> <Marker>sample string 5</Marker> <NumberToReturn>3</NumberToReturn> <ContactKey>b60c9b48-262f-4b85-b962-a5af3b215e20</ContactKey> <SortOrder>sample string 2</SortOrder> </ContactContributionRequest>
Response Information
Resource Description
A list of items and pagination/scrolling properties
Collection of DataFeedItemName | Description | Type | Additional information |
---|---|---|---|
ItemKey |
The primary key associated with the item based on its content type |
globally unique identifier |
None. |
Title |
Title |
string |
None. |
Body |
Description |
string |
None. |
Contributor |
Author or Contributor of the data feed item |
DataFeedContributor |
None. |
ParentContainer |
Parent in which the data feed item is contained. Ex: Community |
DataFeedParentContainer |
None. |
ActionText |
Action Taken Text |
string |
None. |
CreateDate |
UTC timestamp for when the item was created. Use only if PublishedDate is not available. |
date |
None. |
PublishedDate |
UTC timestamp for when the item was published to users on the site |
date |
None. |
PublicationStatus |
Item status determined by PublishedOn date - the possible statuses include "scheduled", "draft", and "published" |
string |
None. |
Date01 |
Custom date field used for certain content types such as the start date for events. As well as best response date for questions and answers. |
date |
None. |
Date02 |
Custom date field used for certain content types such as the end date for events |
date |
None. |
HasRecommended |
Whether or not the current user has liked/recommended the feed item |
boolean |
None. |
HasReplied |
Whether or not the current user has replied/commented on the feed item |
boolean |
None. |
Bool01 |
Generic boolean value specific to the type, ex: Whether or not the current user has registered for the item/event. |
boolean |
None. |
Bool02 |
Generic boolean value specific to the type, ex: Whether or not the item/event is open for registration. |
boolean |
None. |
ItemType |
The type of content, such as blog, announcement, ... |
string |
None. |
LinkToViewItem |
Provides a url to view the item on the website |
string |
None. |
Tags |
All of the tags indexed for the item. This includes user tags and admin based tags |
Collection of ItemTagResponse |
None. |
RecommendationCount |
The number of times the item has been "recommended" or "liked" |
integer |
None. |
AttachmentsContainer |
The attachment container info, the attachments within the container, and their necessary metadata related to the specified item |
DataFeedAttachmentsContainer |
None. |
ResponseCount |
The number of responses for the thread that the item is contained in. If it is not contained within a thread it should not return. |
integer |
None. |
Text01 |
Custom text field used for certain content types such as the location for events |
string |
None. |
Text02 |
Custom text field used for certain content types such as the start/end date string for events |
string |
None. |
Text03 |
Custom text field used for certain content types such as the event type name for events |
string |
None. |
Text04 |
Custom text field used for certain content types such as the registration type for events |
string |
None. |
FeaturedImageUrl |
Returns a link to an image/icon to display for the data feed item |
string |
None. |
ThreadKey |
The ID of the thread containing the item |
globally unique identifier |
None. |
Marker |
Item origin marker |
string |
None. |
Response Formats
application/json, text/json
[ { "ItemKey": "cafcbb01-f17a-40eb-8851-ffa28d045dfb", "Title": "sample string 2", "Body": "sample string 3", "Contributor": { "ContactKey": "8dacada8-b252-4561-a12e-7973d14a61e8", "PictureUrl": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "DisplayName": "sample string 5", "ViewUrl": "sample string 6" }, "ParentContainer": { "ContainerKey": "a7601d37-1641-4f35-9f1a-6a78a201d6e4", "ContainerName": "sample string 2", "ContainerType": "sample string 3" }, "ActionText": "sample string 4", "CreateDate": "2024-12-14T12:56:02.240491Z", "PublishedDate": "2024-12-14T12:56:02.240491Z", "PublicationStatus": "published", "Date01": "2024-12-14T12:56:02.240491Z", "Date02": "2024-12-14T12:56:02.240491Z", "HasRecommended": true, "HasReplied": true, "Bool01": true, "Bool02": true, "ItemType": "sample string 13", "LinkToViewItem": "sample string 14", "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "RecommendationCount": 15, "AttachmentsContainer": { "DocumentKey": "2ca5968e-b1e1-4352-a7e0-f09a68055774", "Attachments": [ { "AttachmentKey": "a2060aaa-191c-4631-a8dc-0a980f92ecd6", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" }, { "AttachmentKey": "a2060aaa-191c-4631-a8dc-0a980f92ecd6", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" } ] }, "ResponseCount": 16, "Text01": "sample string 17", "Text02": "sample string 18", "Text03": "sample string 19", "Text04": "sample string 20", "FeaturedImageUrl": "sample string 21", "ThreadKey": "2f7638d9-a9cd-46b4-be61-7eb668ceadda", "Marker": "sample string 23" }, { "ItemKey": "cafcbb01-f17a-40eb-8851-ffa28d045dfb", "Title": "sample string 2", "Body": "sample string 3", "Contributor": { "ContactKey": "8dacada8-b252-4561-a12e-7973d14a61e8", "PictureUrl": "sample string 2", "FirstName": "sample string 3", "LastName": "sample string 4", "DisplayName": "sample string 5", "ViewUrl": "sample string 6" }, "ParentContainer": { "ContainerKey": "a7601d37-1641-4f35-9f1a-6a78a201d6e4", "ContainerName": "sample string 2", "ContainerType": "sample string 3" }, "ActionText": "sample string 4", "CreateDate": "2024-12-14T12:56:02.240491Z", "PublishedDate": "2024-12-14T12:56:02.240491Z", "PublicationStatus": "published", "Date01": "2024-12-14T12:56:02.240491Z", "Date02": "2024-12-14T12:56:02.240491Z", "HasRecommended": true, "HasReplied": true, "Bool01": true, "Bool02": true, "ItemType": "sample string 13", "LinkToViewItem": "sample string 14", "Tags": [ { "Tag": "sample string 1", "TagType": "sample string 2" }, { "Tag": "sample string 1", "TagType": "sample string 2" } ], "RecommendationCount": 15, "AttachmentsContainer": { "DocumentKey": "2ca5968e-b1e1-4352-a7e0-f09a68055774", "Attachments": [ { "AttachmentKey": "a2060aaa-191c-4631-a8dc-0a980f92ecd6", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" }, { "AttachmentKey": "a2060aaa-191c-4631-a8dc-0a980f92ecd6", "AttachmentName": "sample string 2", "AttachmentUrl": "sample string 3", "MimeType": "sample string 4" } ] }, "ResponseCount": 16, "Text01": "sample string 17", "Text02": "sample string 18", "Text03": "sample string 19", "Text04": "sample string 20", "FeaturedImageUrl": "sample string 21", "ThreadKey": "2f7638d9-a9cd-46b4-be61-7eb668ceadda", "Marker": "sample string 23" } ]
application/xml, text/xml
<ArrayOfDataFeedItem xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.DataFeed"> <DataFeedItem> <ActionText>sample string 4</ActionText> <AttachmentsContainer> <Attachments> <DataFeedAttachment> <AttachmentKey>a2060aaa-191c-4631-a8dc-0a980f92ecd6</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> <DataFeedAttachment> <AttachmentKey>a2060aaa-191c-4631-a8dc-0a980f92ecd6</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> </Attachments> <DocumentKey>2ca5968e-b1e1-4352-a7e0-f09a68055774</DocumentKey> </AttachmentsContainer> <Body>sample string 3</Body> <Bool01>true</Bool01> <Bool02>true</Bool02> <Contributor> <ContactKey>8dacada8-b252-4561-a12e-7973d14a61e8</ContactKey> <DisplayName>sample string 5</DisplayName> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <PictureUrl>sample string 2</PictureUrl> <ViewUrl>sample string 6</ViewUrl> </Contributor> <CreateDate>2024-12-14T07:56:02.240491-05:00</CreateDate> <Date01>2024-12-14T07:56:02.240491-05:00</Date01> <Date02>2024-12-14T07:56:02.240491-05:00</Date02> <FeaturedImageUrl>sample string 21</FeaturedImageUrl> <HasRecommended>true</HasRecommended> <HasReplied>true</HasReplied> <ItemKey>cafcbb01-f17a-40eb-8851-ffa28d045dfb</ItemKey> <ItemType>sample string 13</ItemType> <LinkToViewItem>sample string 14</LinkToViewItem> <Marker>sample string 23</Marker> <ParentContainer> <ContainerKey>a7601d37-1641-4f35-9f1a-6a78a201d6e4</ContainerKey> <ContainerName>sample string 2</ContainerName> <ContainerType>sample string 3</ContainerType> </ParentContainer> <PublishedDate>2024-12-14T07:56:02.240491-05:00</PublishedDate> <RecommendationCount>15</RecommendationCount> <ResponseCount>16</ResponseCount> <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Tagging"> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> </Tags> <Text01>sample string 17</Text01> <Text02>sample string 18</Text02> <Text03>sample string 19</Text03> <Text04>sample string 20</Text04> <ThreadKey>2f7638d9-a9cd-46b4-be61-7eb668ceadda</ThreadKey> <Title>sample string 2</Title> </DataFeedItem> <DataFeedItem> <ActionText>sample string 4</ActionText> <AttachmentsContainer> <Attachments> <DataFeedAttachment> <AttachmentKey>a2060aaa-191c-4631-a8dc-0a980f92ecd6</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> <DataFeedAttachment> <AttachmentKey>a2060aaa-191c-4631-a8dc-0a980f92ecd6</AttachmentKey> <AttachmentName>sample string 2</AttachmentName> <AttachmentUrl>sample string 3</AttachmentUrl> <MimeType>sample string 4</MimeType> </DataFeedAttachment> </Attachments> <DocumentKey>2ca5968e-b1e1-4352-a7e0-f09a68055774</DocumentKey> </AttachmentsContainer> <Body>sample string 3</Body> <Bool01>true</Bool01> <Bool02>true</Bool02> <Contributor> <ContactKey>8dacada8-b252-4561-a12e-7973d14a61e8</ContactKey> <DisplayName>sample string 5</DisplayName> <FirstName>sample string 3</FirstName> <LastName>sample string 4</LastName> <PictureUrl>sample string 2</PictureUrl> <ViewUrl>sample string 6</ViewUrl> </Contributor> <CreateDate>2024-12-14T07:56:02.240491-05:00</CreateDate> <Date01>2024-12-14T07:56:02.240491-05:00</Date01> <Date02>2024-12-14T07:56:02.240491-05:00</Date02> <FeaturedImageUrl>sample string 21</FeaturedImageUrl> <HasRecommended>true</HasRecommended> <HasReplied>true</HasReplied> <ItemKey>cafcbb01-f17a-40eb-8851-ffa28d045dfb</ItemKey> <ItemType>sample string 13</ItemType> <LinkToViewItem>sample string 14</LinkToViewItem> <Marker>sample string 23</Marker> <ParentContainer> <ContainerKey>a7601d37-1641-4f35-9f1a-6a78a201d6e4</ContainerKey> <ContainerName>sample string 2</ContainerName> <ContainerType>sample string 3</ContainerType> </ParentContainer> <PublishedDate>2024-12-14T07:56:02.240491-05:00</PublishedDate> <RecommendationCount>15</RecommendationCount> <ResponseCount>16</ResponseCount> <Tags xmlns:d3p1="http://schemas.datacontract.org/2004/07/HigherLogic.API.Models.Enterprise.Tagging"> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> <d3p1:ItemTagResponse> <d3p1:Tag>sample string 1</d3p1:Tag> <d3p1:TagType>sample string 2</d3p1:TagType> </d3p1:ItemTagResponse> </Tags> <Text01>sample string 17</Text01> <Text02>sample string 18</Text02> <Text03>sample string 19</Text03> <Text04>sample string 20</Text04> <ThreadKey>2f7638d9-a9cd-46b4-be61-7eb668ceadda</ThreadKey> <Title>sample string 2</Title> </DataFeedItem> </ArrayOfDataFeedItem>