Affero Web Services

The general form of a HOF request is
http://pws.affero.net/hof/<request>[?<url-args>]
Where <request> is one of the requests as described below, and <url-args>, well, you probably already have a decent feeling for what that is.

requests

doc

Return this documentation. This request takes no arguments. If supplied, they are ignored

topBeneficiaries

Return a list of beneficiaries and, associated with each, a count of the number of contributors over the time period.

Valid arguments: lim=, type=

membBen

Display a table of beneficiaries associated with an affero member.

Valid arguments: v=, p=, from=, to=, lim=, type=
Exactly one of p= or v= must be set to a existing, active affero member name.

If p= is set then the table returned will reflect the sum of dollar amounts donated by the Affero member to various foundations.

If v= is set then the table returned will reflect the sum of dollar amounts inspired by the Affero member that were donated to various foundations.

If the member name is not valid then the table returned will be the same as if the 'topBeneficiaries' service had been requested.

If both of p= and v= are set then p= is dropped.

recentComments

Display a table of recent rating comments (possibly associated with an affero member)

Valid arguments: v=, p=, la=, from=, to=, lim=, type=, rcf=
Either of p= or v= may be set to a existing, active affero member name. in this case the table will contain recent comments made by that user or on that user, respectively. If the member name is not valid then the table returned will be the same as if no argument had been passed. If both of p= and v= are set then p= is dropped.

If neither of p= or v= is specified then a table of comments made on all users will be returned.

type= can be one of {"html" | "xml" | "rdf"} with "html" being the default.

rcf= {"none" | "default"}
"none" do not do any filtering or scoring on the recent comments

"default" do default scoring and filtering on recent comments

recentGifts

Build a table of recent gifts made to selected foundations.

Valid arguments: v=, p=, la=, lf=, from=, to=, lim=, type=

Either of p= or v= may be set to a existing, active affero member name. in this case the table will contain recent gifts made by that user or on behalf of that user, respectively. If the member name is not valid then the table returned will be the same as if no argument had been passed. If both of p= and v= are set then p= is dropped.

type= can be one of {''html'' | ''xml'' | ''rdf''} with ``html'' being the default.

topPatrons

Return a list of members who have given donations and a sum of the amount donated. Note that patrons who have their gift history to 'private' will not be included in this output.

valid arguments: la=, lf=, rf=, tc=, from=, to=, lim=, type=

tc= can be set to one of {"count"|"donations"}
"count" will return a table of the total number of members who have been rated by this patron. If tc=count is given then lf= will be ignored if present. "donations" (the default) will return a sum of the donations given by the member.

topVolunteers

Return a list of members who have inspired contributions and the amounts contributed on their behalves(?)

valid arguments: la=, lf=, rf=, tc=, from=, to=, lim=, type=

tc= {"values"|"count"|"donations"}
"values" will return a table of averaged ratings by member"count" will returna table of the total number of members who have rated that volunteer "donations" (the default) will return a sum of the donations given or inspired by each member
rf= {''text''|''all''}
set to "text" to consider only those ratings which have a text comment associated with them. the default is ``all''.

URL args not described above

note that the date arguments (from= and to=) are eventually parsed according to GNU date syntax and thus their values can take a wide variety of forms. Have a look at the GNU manual page titled Date Input Formats. Here's the url:
http://www.gnu.org/manual/tar-1.12/html_chapter/tar_7.html
All values must be url-escaped.

a note on colors

There are several colors which can be set from url arguments. Each of the tables is thought of as having three regions. In each region, two color attributes can be set: Font and Bkgr, so there are 6 URL arguments which can be set independently modify the tables colors. They are listed below with their default values:
hdr1BkgrColor => #486591

hdr1FontColor => #ffffff

hdr2BkgrColor => #cfd9ff

hdr2FontColor => #000000

tbodBkgrColor => #e6e6e6

tbodFontColor => #000000
The value passed in on the URL argument is eventually copied in to an HTML attribute tag as, for instance,
<font color="{$hdr1FontColor}"...> ... </font>
the value passed in is neither modified or checked.

Examples

HOF requests are served from pws.affero.net. So here are some examples of valid requests -which, for purposes of presentation, do not have their url arguments escaoped- along with descriptions of the output:

  1. http://pws.affero.net/hof/topPatrons?hdr1BkgrColor=red

    this request will return the most active patrons over the last two months. the table will have at most 10 (the default) rows and the topmost header will have bgcolor="red".
  2. http://pws.affero.net/hof/topVolunteers?from=yesterday&lim=5

    this request will return the most active volunteers since yesterday. the table will have at most 5 rows.
  3. http://pws.affero.net/hof/topPatrons?la=lq*g*

    this request will return the most active patrons from forums starting with 'lq' that have a 'g' in their names. results will be extracted from data collected over the last two months. the table will have at most 10 (the default) rows
  4. http://pws.affero.net/hof/topPatrons?lf=*FSF*

    this request will return the most active patrons who have donated to foundations with FSF in their names. results will be extracted from data collected over the last two months. the table will have at most 10 (the default) rows
  5. http://pws.affero.net/hof/membBen?v=poole

    this request will return a table of the foundations who have received contributions as a result of affero member poole's donations along with the amounts raised. the table will have at most 10 (the default) rows.
  6. http://pws.affero.net/hof/recentGifts?type=rdf

    this request will return an RDF/XML encoded description of the recent gifts made at Affero.

About this document ...

Affero Web Services

This document was generated using the LaTeX2HTML translator Version 2002-2-1 (1.70)

Copyright © 1993, 1994, 1995, 1996, Nikos Drakos, Computer Based Learning Unit, University of Leeds.
Copyright © 1997, 1998, 1999, Ross Moore, Mathematics Department, Macquarie University, Sydney.

The command line arguments were:
latex2html -split 0 -no_navigation publicInterface.tex

The translation was initiated by lee doolan on 2003-05-27


lee doolan 2003-05-27