Work.get: Difference between revisions
Jump to navigation
Jump to search
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…' |
w>Jguillo No edit summary |
||
Line 77: | Line 77: | ||
<?xml version="1.0" encoding="UTF-8"?> | <?xml version="1.0" encoding="UTF-8"?> | ||
<work> | <work> | ||
<code> | <code>1002045450603</code> | ||
<title> | <title>Crux</title> | ||
<entrydate> | <entrydate>2010-02-04T23:07:00Z</entrydate> | ||
<excerpt> | <excerpt>ambient, orchestral drone music</excerpt> | ||
<tags>year:2009, ambient, magnatune, album, orchestral</tags> | |||
<tags> | <links> | ||
< | <link name="Emmalee Crane" type="INFO">http://magnatune.com/artists/emmalee_crane</link> | ||
< | <link name="Crux" type="INFO">http://magnatune.com/artists/albums/emmalee-crux</link> | ||
</links> | |||
<relations> | |||
<relation type="COMPOSITION"> | |||
<work name="Crux" code="1002045450597"/> | |||
<work name="I Break At Your Touch" code="1002045450573"/> | |||
< | <work name="Silver Blue In Solomon" code="1002045450580"/> | ||
<code> | <work name="You Seem To Reason" code="1002045450528"/> | ||
<name> | <work name="Alms End" code="1002045450542"/> | ||
< | <work name="Illustry" code="1002045450559"/> | ||
</ | <work name="Stair Asterism" code="1002045450511"/> | ||
</authors> | <work name="The Rise Of The Grasshopper" code="1002045450566"/> | ||
<work name="Three Nine Six Twelve" code="1002045450535"/> | |||
</relation> | |||
</relations> | |||
<authors/> | |||
<rights-holders> | <rights-holders> | ||
<rights-holder> | <rights-holder> | ||
<code> | <code>0903160147342</code> | ||
<name> | <name>magnatune</name> | ||
<human-url>http://www.safecreative.org/user/ | <human-url>http://www.safecreative.org/user/0903160147342</human-url> | ||
</rights-holder> | </rights-holder> | ||
</rights-holders> | </rights-holders> | ||
<license> | <license> | ||
<code>http://creativecommons.org/licenses/by-nc- | <code>http://creativecommons.org/licenses/by-nc-sa/1.0/</code> | ||
<name>Creative Commons Attribution Non- | <name>Creative Commons Attribution Non-Comercial Share Alike 1.0</name> | ||
<shortname>CC by-nc- | <shortname>CC by-nc-sa 1.0</shortname> | ||
<endDate></endDate> | <endDate></endDate> | ||
<human-url>http://creativecommons.org/licenses/by-nc- | <human-url>http://creativecommons.org/licenses/by-nc-sa/1.0/legalcode</human-url> | ||
<features> | <features> | ||
<recognition>YES</recognition> | <recognition>YES</recognition> | ||
<derivations> | <derivations>INHERITANCE</derivations> | ||
<distribution>YES</distribution> | <distribution>YES</distribution> | ||
<commercial>NO</commercial> | <commercial>NO</commercial> | ||
Line 117: | Line 121: | ||
</features> | </features> | ||
</license> | </license> | ||
<human-url>http://www.safecreative.org/work/ | <human-url>http://www.safecreative.org/work/1002045450603</human-url> | ||
<machine-url>http://www.safecreative.org/v2/?component=work.get&code= | <machine-url>http://www.safecreative.org/v2/?component=work.get&code=1002045450603</machine-url> | ||
<allowdownload> | <allowdownload>false</allowdownload> | ||
<worktype> | <worktype> | ||
<code> | <code>music</code> | ||
<name> | <name>Music</name> | ||
</worktype> | </worktype> | ||
<worktypegroup> | <worktypegroup> | ||
<code> | <code>Audio</code> | ||
<name> | <name>Audio</name> | ||
</worktypegroup> | </worktypegroup> | ||
</work> | </work> |
Revision as of 09:34, 5 May 2010
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
- work: Work related to this work
- relation: Includes the relation type (VERSION|DERIVATION|COMPOSITION|RELATED) as XML attribute. This is a list of works related in this type
- 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
- author
- 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
- rights-holder
- 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>1002045450603</code> <title>Crux</title> <entrydate>2010-02-04T23:07:00Z</entrydate> <excerpt>ambient, orchestral drone music</excerpt> <tags>year:2009, ambient, magnatune, album, orchestral</tags> <links> <link name="Emmalee Crane" type="INFO">http://magnatune.com/artists/emmalee_crane</link> <link name="Crux" type="INFO">http://magnatune.com/artists/albums/emmalee-crux</link> </links> <relations> <relation type="COMPOSITION"> <work name="Crux" code="1002045450597"/> <work name="I Break At Your Touch" code="1002045450573"/> <work name="Silver Blue In Solomon" code="1002045450580"/> <work name="You Seem To Reason" code="1002045450528"/> <work name="Alms End" code="1002045450542"/> <work name="Illustry" code="1002045450559"/> <work name="Stair Asterism" code="1002045450511"/> <work name="The Rise Of The Grasshopper" code="1002045450566"/> <work name="Three Nine Six Twelve" code="1002045450535"/> </relation> </relations> <authors/> <rights-holders> <rights-holder> <code>0903160147342</code> <name>magnatune</name> <human-url>http://www.safecreative.org/user/0903160147342</human-url> </rights-holder> </rights-holders> <license> <code>http://creativecommons.org/licenses/by-nc-sa/1.0/</code> <name>Creative Commons Attribution Non-Comercial Share Alike 1.0</name> <shortname>CC by-nc-sa 1.0</shortname> <endDate></endDate> <human-url>http://creativecommons.org/licenses/by-nc-sa/1.0/legalcode</human-url> <features> <recognition>YES</recognition> <derivations>INHERITANCE</derivations> <distribution>YES</distribution> <commercial>NO</commercial> <timelimited>NOT_APPLICABLE</timelimited> </features> </license> <human-url>http://www.safecreative.org/work/1002045450603</human-url> <machine-url>http://www.safecreative.org/v2/?component=work.get&code=1002045450603</machine-url> <allowdownload>false</allowdownload> <worktype> <code>music</code> <name>Music</name> </worktype> <worktypegroup> <code>Audio</code> <name>Audio</name> </worktypegroup> </work>