-------------------------
Version 1.0 Documentation
-------------------------
:Author: Nathan R. Yergler
:Version: 1.0
:Updated: $Date: 2009-04-02 10:57:29 -0700 (Thu, 02 Apr 2009) $
This document covers the 1.0 release of CC Web Services. Information on the version in development can be found at http://api.creativecommons.org.
Access Method
=============
The 1.0 Web Services are accessible via a REST interface. The interface is rooted at http://api.creativecommons.org/rest/1.0.
Valid Calls
===========
http://api.creativecommons.org/rest/1.0
Returns an XML document describing the available license classes. A license class
is a "family" of licenses. Current classes are standard (basic CC licenses),
publicdomain, and recombo (the Sampling licenses).
Classes may be added at any time in the future without
breaking 1.0 compatibility.
A partial example of the returned document is::
Creative CommonsPublic DomainSampling
http://api.creativecommons.org/rest/1.0/license/[class]
Called with a license class id from the call above as [class]. Returns an XML
document describing the list of fields which must be supplied in order to issue
a license of the given class.
A partial example of the returned document for
http://api.creativecommons.org/rest/1.0/license/standard ::
The licensor permits others to copy, distribute, display, and perform the work. In return, the licensee may not use the work for commercial purposes, unless they get the licensor's permission.enumThe licensor permits others to copy, distribute and perform only unaltered copies of the work, not derivative works based on it.enumIf you desire a license governed by the Copyright Law of a specific jurisdiction, please select the appropriate jurisdiction.enum
Note that a given field or enum element may have more than one label, so long as they
have unique xml:lang attributes. Future language translations may be added at any time
in the future without breaking 1.0 compatibility.
http://api.creativecommons.org/rest/1.0/license/[class]/issue
Called with an HTTP POST whose contents are a single form variable, ``answers``.
The value of answers is an XML string containing values which match each ``field``
element found in the earlier license/[class] call. A sample answers string for the
previous example is::
ny
This example would issue a by-nc license in the generic (default) jurisdiction. Note
each element name matches a field id, and the content of the elements match the
enum id for the selected choice.
The issue method uses the chooselicense.xsl document to generate the resulting XML
document. The result of this sample call would be an XML document, such as::
http://creativecommons.org/licenses/by/2.0/Generic/Attribution 2.0
This work is licensed under a Creative Commons License.
Note the element contains the entire RDF-in-comment which the standard CC license
engine returns.