• If you are citizen of an European Union member nation, you may not use this service unless you are at least 16 years old.

  • Files spread between Dropbox, Google Drive, Gmail, Slack, and more? Dokkio, a new product from the PBworks team, integrates and organizes them for you. Try it for free today.

View
 

Open Actions XML -- Open Actions XML Documentation

Page history last edited by Peter Deitz 10 years, 4 months ago

What is Open Actions XML ?

 

Open Actions XML is an open standard for publishing up-to-date information about online and offline actions and their anticipated impact in XML. Open Actions XML independent of any particular aggregation. Social Actions views the development of a versatile XML schema for publishing information about online and offline actions and their anticipated impact as a critical component of the philanthropic web.

 

Elements

 

Thre are two feed level tags in the open actions name space:

* result_count: the total number of enties in the search result

* page_count: the total number of pages that must be fetched to get all results (result_count divded by limit)

The following elements refer to a feed entry (Atom <entry>, RSS <item>). All elements described below must be in the "http://socialactions.com/oa/beta" namespace. Unless otherwise specified, all values must be plain text (i.e., no entity-encoded html).

* goal - Describes the goal that the action aims to achieve. If used, it has two required elements, amount and type, and two optional ones, completed and numberOfContributors.

* type - The type of goal, eg "USD" or "Signatures"

* amount - The amount of the type that is being aimed at

* completed - How much has been completed already. This should be in the same format as amount.

* numberOfContributors - The number of people who have contributed towards amount.

* platform - Describes the platform on which a social action is listed. If used, it has two required elements, name and url, and one optional one, email.

* name - The name of the social action platform

* url - The URL of the social action platform

* email - A contact email address for the social action platform

* organization - Describes the organization that is carrying out or that benefits from the action. If used, it has two required elements, name and url, and two optional ones, email and ein.

* name - The name of the initiator organization

* url - The URL of the initiator organization

* email - A contact email address for the initiator organization

* ein - The EIN of the initiator organization. This can be used, for example, to automate donations to the organization.

* embedWidget - An entity-encoded HTML fragment containing a widget describing the social action for a user to put on another site.

SECURITY NOTICE: This will usually be executable code such as flash or javascript. If you consume this element, be sure that you trust the provider of the feed. Similarly, if you are producing this field, make sure that you are taking necessary steps to prevent code injection.

 

Implementation guidelines

 

There are a number of pieces of information which social action platforms often want to make available which can be described using standard elements from popular feed formats. The following examples will use elements from Atom 1.0, but the same information can be used in RSS 1.0 and RSS 2.0 feeds.

Title atom:title
Description atom:content
URL atom:link
Creation Time atom:published
Update Time atom:updated
Initiator Name atom:author/atom:name
Initiator URL atom:author/atom:url
Initiator Email Address atom:author/atom:email
Tag atom:category

TODO: add geo tags

TODO: add RFC5005 reference and context

The following elements from the dcterms namespace("http://purl.org/dc/terms/") may also be useful for representing social action data.

Subtitle / fulfillment trailer dcterms:alternative
Expiry Date dcterms:valid

 

Action Type

 

TODO: describe action type & how to use category scheme

<category term="Volunteer" scheme="http://socialactions.com/action_types"/>

 

Example

 

<?xml version="1.0" encoding="UTF-8"?>

<feed xmlns="http://www.w3.org/2005/Atom" xmlns:oa="http://socialactions.com/oa/beta" xmlns:dcterms="http://purl.org/dc/terms/">

<title>Example.org Open Actions Feed</title>

<id>tag:example.org,2008:test_feed</id>

<link rel="self" href="http://search.example.org/actions.atom"/>

<updated>2008-09-24T18:16:56-04:00</updated>

<oa:result_count>13218</oa:result_count>

<oa:page_count>1321</oa:page_count>

<entry>

<id>tag:example.org,2008:entry1</id>

<published>2008-09-24T21:38:45-04:00</published>

<updated>2008-09-24T18:16:56-04:00</updated>

<title>Help Test Open Actions!</title>

<dcterms:alternative>We need people to test the implementation of Open Actions...</dcterms:alternative>

<content type="html">The text is derived from Cicero's De Finibus Bonorum et Malorum (On the Ends of Goods and Evils, or alternatively [About] The Purposes of Good and Evil ).[1] The original passage began: Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit (Translation: "Neither is there anyone who loves grief itself since it is grief and thus wants to obtain it").</content>

<link href="http://example.org/actions/1"/>

<oa:goal>

<oa:amount>30</oa:amount>

<oa:type>Volunteers</oa:type>

<oa:completed>4</oa:completed>

<oa:numberOfContributors>4</oa:numberOfContributors>

</oa:goal>

<author>

<name>Josh Crawford</name>

<url>http://josh.brattcollective.com</url>

<email>example@brattcollective.com</email>

</author>

<dcterms:valid>end=2008-12-15T00:00Z</dcterms:valid>

<category term="Volunteer" scheme="http://socialactions.com/action_types"/>

<category term="Feed Format Extensions"/>

<oa:platform>

<oa:name>Example Platform</oa:name>

<oa:url>http://example.org</oa:url>

<oa:email>example@example.org</oa:email>

</oa:platform>

<oa:embedWidget><script type="text/javascript" src="http://www.socialactions.com/related-ways-to-take-action/ra.js"></script></oa:embedWidget>

<oa:organization>

<oa:name>Brattleboro Tech Collective</oa:name>

<oa:url>http://brattcollective.com</oa:url>

<oa:ein>44-5555555</oa:ein>

<oa:email>example@brattcollective.com</oa:email>

</oa:organization>

</entry>

</feed>

 

Comments (0)

You don't have permission to comment on this page.