Work.get

From Safe Creative API
Revision as of 09:25, 5 May 2010 by w>Jguillo (Created page with 'Public component to query data about a work. Using this component you can get public information about any work registered on Safe Creative, as if visiting its Safe Creative pag…')
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

Public component to query data about a work.

Using this component you can get public information about any work registered on Safe Creative, as if visiting its Safe Creative page http://www.safecreative.org/work/{workcode}.

You don't need a shared key to use this component.

Info

  • Component name: work.get
  • Signature: No signature required
  • Timestamp: Ztime is not required

Parameters

  • code*: Work code of registered work
  • locale: Locale for work type, license names,...

* Required parameter

Returns

Some works include more information than others. Not all fields will be present in all works.

  • work
    • code: Safe Creative work code
    • title: Work title
    • entrydate: Work registration date
    • excerpt: Work excerpt or description
    • tags: Comma-separated list of tags
    • thumbnail: URL to the work thumbnail (if any)
    • links: Work links
      • link: Link URL. Includes the link name and type (INFO|DOWNLOAD) as XML attributes
    • relations: Work relations with other works
      • relation: Includes the relation type (VERSION|DERIVATION|COMPOSITION|RELATED) as XML attribute. This is a list of works related in this type
        • work: Work related to this work
          • name: Related work title
          • code: Related work code
    • authors: List of authors
      • author
        • code: Author's Safe Creative user code
        • name: Author's full name
        • human-url: URL to the author's Safe Creative public profile
        • image: URL to the author's public image
    • rights-holders: List of rights holders
      • rights-holder
        • code: Rights holder's Safe Creative user code
        • name: Rights holder's full name
        • human-url: URL to the rights holder's Safe Creative public profile
        • image: URL to the rights holder's public image
    • license: Work license
      • code: License code
      • name: License name
      • shortname: License short name
      • endDate: License expiration date (only for time-limited licenses)
      • human-url: URL to license text
      • features: License features (see user.licenses
    • human-url: URL to this work web page in Safe Creative
    • machine-url: URL to this work API info page (this same info)
    • allowdownload: This work can be downloaded (true|false)
    • languagecode: Code of this work language (see work.languages)
    • worktype: Work type (see work.types, work.types.tree)
      • code: Work type code
      • name: Work type name
    • worktypegroup: Work type group (see work.types.tree)
      • code: Work type group code
      • name: Work type group name


Sample

REQUEST:

https://api.safecreative.org/v2/
?component=work.get
&code=0910244743710

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<work> 
  <code>0910244743710</code> 
  <title>Scrum Manager Proyectos</title> 
  <entrydate>2009-10-24T10:31:09Z</entrydate> 
  <excerpt>Texto de formación de Scrum Manager para el área de Gestión de proyectos.
Versión 1.3</excerpt> 
  <tags>agilidad, scrum, scrum manager, gestión de proyectos</tags> 
  <authors> 
    <author> 
      <code>0709270000504</code> 
      <name>Juan Palacio</name> 
      <human-url>http://www.safecreative.org/user/0709270000504</human-url> 
      <image>https://thumbnails-safecreative-org.s3.amazonaws.com/1/00000121/caf4/d273/9454/bda170cfbf4d/jpalacio_thumb.png</image> 
    </author> 
    <author> 
      <code>1002250133049</code> 
      <name>Claudia Verónica Ruata</name> 
      <human-url>http://www.safecreative.org/user/1002250133049</human-url> 
    </author> 
  </authors> 
  <rights-holders> 
    <rights-holder> 
      <code>0804040057129</code> 
      <name>Scrum Manager</name> 
      <human-url>http://www.safecreative.org/user/0804040057129</human-url> 
    </rights-holder> 
  </rights-holders> 
  <license> 
    <code>http://creativecommons.org/licenses/by-nc-nd/3.0/</code> 
    <name>Creative Commons Attribution Non-commercial No Derivatives 3.0</name> 
    <shortname>CC by-nc-nd</shortname> 
    <endDate></endDate> 
    <human-url>http://creativecommons.org/licenses/by-nc-nd/3.0/legalcode</human-url> 
    <features> 
      <recognition>YES</recognition> 
      <derivations>NO</derivations> 
      <distribution>YES</distribution> 
      <commercial>NO</commercial> 
      <timelimited>NOT_APPLICABLE</timelimited> 
    </features> 
  </license> 
  <human-url>http://www.safecreative.org/work/0910244743710</human-url> 
  <machine-url>http://www.safecreative.org/v2/?component=work.get&code=0910244743710</machine-url> 
  <allowdownload>true</allowdownload> 
  <languagecode>ES</languagecode> 
  <worktype> 
    <code>education</code> 
    <name>Education, Informative</name> 
  </worktype> 
  <worktypegroup> 
    <code>Literary</code> 
    <name>Literary</name> 
  </worktypegroup> 
</work>