License.features: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
No edit summary
w>Jguillo
No edit summary
Line 29: Line 29:
RESPONSE:
RESPONSE:


<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<features>  
<features>  
Line 85: Line 86:
   </feature>  
   </feature>  
</features>
</features>
</pre>


[[Category:API component]]
[[Category:API component]]

Revision as of 08:38, 5 May 2010

Returns a localized list of license features and their applicable values.

You can use this to present the user an explanation of the features for different licenses.

Info

  • Component name: license.features
  • Signature: No signature required
  • Timestamp: Ztime not required

Parameters

  • locale: Locale for feature names

Returns

  • features
    • feature
      • code: Feature code as it apperas in the license features list (see user.licenses)
      • name: Feature full description
      • shortname: Feature name
      • values: Applicable values
        • value: One of YES, YES_WITH_RESTRICTIONS, INHERITANCE, NO, NOT_APPLICABLE (see user.licenses)

Sample

REQUEST:

https://api.safecreative.org/v2/
?component=license.features
&locale=en

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<features> 
  <feature> 
    <code>distribution</code> 
    <name>Work can be copied and distributed</name> 
    <shortname>Distribution</shortname> 
    <values> 
      <value>YES</value> 
      <value>YES_WITH_RESTRICTIONS</value> 
      <value>NO</value> 
      <value>NOT_APPLICABLE</value> 
    </values> 
  </feature> 
  <feature> 
    <code>commercial</code> 
    <name>Commercial use of this work is allowed</name> 
    <shortname>Commercial</shortname> 
    <values> 
      <value>YES</value> 
      <value>YES_WITH_RESTRICTIONS</value> 
      <value>NO</value> 
      <value>NOT_APPLICABLE</value> 
    </values> 
  </feature> 
  <feature> 
    <code>derivations</code> 
    <name>Derived works can be produced</name> 
    <shortname>Derivative</shortname> 
    <values> 
      <value>YES</value> 
      <value>YES_WITH_RESTRICTIONS</value> 
      <value>INHERITANCE</value> 
      <value>NO</value> 
      <value>NOT_APPLICABLE</value> 
    </values> 
  </feature> 
  <feature> 
    <code>recognition</code> 
    <name>Author must be recognized</name> 
    <shortname>Recognition</shortname> 
    <values> 
      <value>YES</value> 
      <value>NO</value> 
      <value>NOT_APPLICABLE</value> 
    </values> 
  </feature> 
  <feature> 
    <code>timelimited</code> 
    <name>License has a limited period of application</name> 
    <shortname>Time limited</shortname> 
    <values> 
      <value>YES</value> 
      <value>NOT_APPLICABLE</value> 
    </values> 
  </feature> 
</features>