License.features: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
w>Jguillo
Created page with '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 = *…'
 
m 5 revisions imported
 
(4 intermediate revisions by one other user not shown)
Line 7: Line 7:
* '''Signature:''' No signature required
* '''Signature:''' No signature required
* '''Timestamp:''' Ztime not required
* '''Timestamp:''' Ztime not required
* '''API trust level''': Public


= Parameters =  
= Parameters =  
Line 20: Line 21:
**** '''value''': One of YES, YES_WITH_RESTRICTIONS, INHERITANCE, NO, NOT_APPLICABLE (see [[user.licenses]])
**** '''value''': One of YES, YES_WITH_RESTRICTIONS, INHERITANCE, NO, NOT_APPLICABLE (see [[user.licenses]])


= Sample =
= Example =
REQUEST:
REQUEST:


Line 29: Line 30:
RESPONSE:
RESPONSE:


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


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

Latest revision as of 08:07, 7 May 2021

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
  • API trust level: Public

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)

Example

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>
Retrieved from "https://www.safecreative.org/mw/index.php?title=License.features&oldid=336"