getNewsFeeds

Returns the requested number of PC2 admin newsfeed messages and total message count designated for the supplied fr_id and groups the requesting constituent or supplied cons_id is a member of.

Client Servlet Server Servlet HTTP Methods Supported Requires Authentication
CRTeamraiserAPI None. POST Yes.

Client API Syntax

https://secure2.convio.net/organization/site/CRTeamraiserAPI?method=getNewsFeeds &api_key=value &v=value [ &auth=value ] [ &center_id=value ] [ &error_redirect=value ] [ &redirect=value ] [ &response_format=xml | json ] [ &sign_redirects=value ] [ &source=value ] [ &sub_source=value ] [ &success_redirect=value ] [ &suppress_response_codes=value ] &fr_id=value [ &feed_count=value ] [ &feed_id=value ] [ &last_pc2_login=value ] [ &list_ascending=value ] [ &list_sort_column=MODIFY_DATE | CREATION_DATE | FEED_TITLE | STATUS | PUBLISHED_DATE | UNPUBLISHED_DATE | FEED_NAME ] [ &auth=value ] [ &sso_auth_token=value ]

Client API Parameters

Common Client Parameters

See topic Common Parameters.

fr_id

Required. The TeamRaiser event ID.

Type xsd:nonNegativeInteger.

feed_count

Optional. The maximum number of newsfeed messages that will be returned.

Type xsd:integer.

Default is -1.

feed_id

Optional. The unique id of the message to be returned.

Type xsd:integer.

Default is -1.

last_pc2_login

Optional. The time of last pc2 login for the participant requesting news feeds.

Type xsd:nonNegativeInteger.

Default is 0.

list_ascending

Optional. If true, the returned list will be sorted in ascending order, if false, descending order. Default is false.

Type xsd:boolean.

Default is false.

list_sort_column

Optional. The attribute used to sort a list of newsfeed messages.

Type xsd:string.

Default is MODIFY_DATE.

Options are:
  • MODIFY_DATE
  • CREATION_DATE
  • FEED_TITLE
  • STATUS
  • PUBLISHED_DATE
  • UNPUBLISHED_DATE
  • FEED_NAME
auth

Optional. You must provide either this parameter or the sso_auth_token parameter. If using this parameter, you must specify an auth token generated by an embedded [[S86]] session tag in a Convio web page.

sso_auth_token

Optional. You must provide either this parameter or the auth parameter. If using this parameter, you must specify a valid session authentication token returned by login, authenticateUser, or getSingleSignOnToken.

Response

See topic HTTP Status Codes.

XML response
<?xml version="1.0" encoding="UTF-8"?>
<getNewsFeedsResponse xmlns="http://convio.com/crm/v1.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <numberOfFeeds xsi:schemaLocation="http://convio.com/crm/v1.0 http://service.convio.net/xmlschema/crm.public.v1.xsd">2</numberOfFeeds>
  <numberOfNewFeeds>1</numberOfNewFeeds>
  <newsFeed>
    <feedId>1000</feedId>
    <feedTitle>Example Newsfeed Message Title 0</feedTitle>
    <feedContent>Example Newsfeed Message Body 0</feedContent>
    <imageSrc>url/to/image0.jpg</imageSrc>
    <imageAltText>image alt text 0</imageAltText>
    <isNew>true</isNew>
    <lastModifiedDate>12/25/2010</lastModifiedDate>
    <mediaSrcs>
      <videoSource>http://www.youtube.com</videoSource>
      <videoDescription>youtube</videoDescription>
    </mediaSrcs>
    <feedType>Event</feedType>
    <isCaptainsOnly>false</isCaptainsOnly>
  </newsFeed>
  <newsFeed>
    <feedId>1001</feedId>
    <feedTitle>Example Newsfeed Message Title 1</feedTitle>
    <feedContent>Example Newsfeed Message Body 1</feedContent>
    <imageSrc>url/to/image1.jpg</imageSrc>
    <imageAltText>image alt text 1</imageAltText>
    <isNew>false</isNew>
    <lastModifiedDate>12/25/2010</lastModifiedDate>
    <mediaSrcs>
      <videoSource>http://www.youtube.com</videoSource>
      <videoDescription>youtube</videoDescription>
    </mediaSrcs>
    <feedType>Event</feedType>
    <isCaptainsOnly>false</isCaptainsOnly>
  </newsFeed>
</getNewsFeedsResponse>

        
JSON response
{"getNewsFeedsResponse":{"newsFeed":[{"feedId":"1000","feedTitle":"Example Newsfeed Message Title 0","imageSrc":"url/to/image0.jpg","isCaptainsOnly":"false","feedType":"Event","isNew":"true","lastModifiedDate":"12/25/2010","feedContent":"Example Newsfeed Message Body 0","mediaSrcs":{"videoSource":"http://www.youtube.com","videoDescription":"youtube"},"imageAltText":"image alt text 0"},{"feedId":"1001","feedTitle":"Example Newsfeed Message Title 1","imageSrc":"url/to/image1.jpg","isCaptainsOnly":"false","feedType":"Event","isNew":"false","lastModifiedDate":"12/25/2010","feedContent":"Example Newsfeed Message Body 1","mediaSrcs":{"videoSource":"http://www.youtube.com","videoDescription":"youtube"},"imageAltText":"image alt text 1"}],"numberOfFeeds":{"content":"2"},"numberOfNewFeeds":"1"}}

        

Leave a Comment

Nickname
Comment
Enter this word: