Work.get: Difference between revisions
Jump to navigation
Jump to search
w>Jguillo No edit summary |
m 18 revisions imported |
||
| (16 intermediate revisions by 2 users not shown) | |||
| Line 2: | Line 2: | ||
Using this component you can get public information about any work registered on Safe Creative, as if visiting its Safe Creative page <code><nowiki>http://www.safecreative.org/work/{workcode}</nowiki></code>. | Using this component you can get public information about any work registered on Safe Creative, as if visiting its Safe Creative page <code><nowiki>http://www.safecreative.org/work/{workcode}</nowiki></code>. | ||
= Info = | = Info = | ||
| Line 9: | Line 7: | ||
* '''Signature:''' No signature required | * '''Signature:''' No signature required | ||
* '''Timestamp:''' Ztime is not required | * '''Timestamp:''' Ztime is not required | ||
* '''API trust level''': Public | |||
= Parameters = | = Parameters = | ||
| Line 23: | Line 22: | ||
** '''title''': Work title | ** '''title''': Work title | ||
** '''entrydate''': Work registration date | ** '''entrydate''': Work registration date | ||
** '''updatedate''': Work update date | |||
** '''excerpt''': Work excerpt or description | ** '''excerpt''': Work excerpt or description | ||
** '''tags''': Comma-separated list of tags | ** '''tags''': Comma-separated list of tags | ||
** '''thumbnail''': URL to the work thumbnail (if any) | ** '''thumbnail''': URL to the work thumbnail (if any) | ||
** '''mimetype''': Work mime type | |||
** '''links''': Work links | ** '''links''': Work links | ||
*** '''link''': Link URL. | *** '''link''': Link URL. | ||
*** '''name''': Link title (XML attribute) | |||
*** '''type''': Link type (INFO|DOWNLOAD) (XML attribute) | |||
** '''relations''': Work relations with other works | ** '''relations''': Work relations with other works | ||
*** '''relation''': | *** '''relation''': List of works related of a ''type'' (VERSION|DERIVATION|COMPOSITION|RELATED as XML attribute) | ||
**** '''work''': Work related to this work | **** '''work''': Work related to this work | ||
***** '''name''': Related work title | ***** '''name''': Related work title (XML attribute) | ||
***** '''code''': Related work code | ***** '''code''': Related work code (XML attribute) | ||
** '''authors''': List of authors | ** '''authors''': List of authors | ||
*** '''author''' | *** '''author''' | ||
| Line 51: | Line 54: | ||
*** '''endDate''': License expiration date (only for time-limited licenses) | *** '''endDate''': License expiration date (only for time-limited licenses) | ||
*** '''human-url''': URL to license text | *** '''human-url''': URL to license text | ||
*** '''features''': License features (see [[user.licenses]] | *** '''features''': License features (see [[user.licenses]]) | ||
** '''human-url''': URL to this work web page in Safe Creative | ** '''human-url''': URL to this work web page in Safe Creative | ||
** '''machine-url''': URL to this work API info page (this same info) | ** '''machine-url''': URL to this work API info page (this same info) | ||
** '''allowdownload''': This work can be downloaded (true|false) | ** '''allowdownload''': This work can be downloaded (true|false) | ||
** '''allowevaluation''': An evaluation version of this work can be downloaded (true|false) | |||
** '''languagecode''': Code of this work language (see [[work.languages]]) | ** '''languagecode''': Code of this work language (see [[work.languages]]) | ||
** '''worktype''': Work type (see [[work.types]], [[work.types.tree]]) | ** '''worktype''': Work type (see [[work.types]], [[work.types.tree]]) | ||
| Line 62: | Line 66: | ||
*** '''code''': Work type group code | *** '''code''': Work type group code | ||
*** '''name''': Work type group name | *** '''name''': Work type group name | ||
** '''registrations''': Work external registrations | |||
*** '''registration''': Declares an external registration entry | |||
**** '''registry''': Info about external registry. Type attribute can be: OFFICIAL (eg: USCO), LEGAL (eg: a local jurisdiction entity), INTERNATIONAL (International standard body such as isbn,isrc,isan,etc..) | |||
***** '''code''': Internal registry code name | |||
***** '''url''': Registry info url | |||
**** '''code''': Work registration code within external registry | |||
** '''metadata''': Work metadata and referenced namespaces (see [[work.metadata.namespaces]]) (see [http://en.wikipedia.org/wiki/RDFa RDFa]) | |||
*** '''value''': Metadata value. | |||
= Example = | |||
= | |||
REQUEST: | REQUEST: | ||
<nowiki>https://api.safecreative.org/v2/</nowiki> | <nowiki>https://api.safecreative.org/v2/</nowiki>?'''component'''=work.get&'''code'''=1002045450603 | ||
RESPONSE: | RESPONSE: | ||
| Line 80: | Line 88: | ||
<title>Crux</title> | <title>Crux</title> | ||
<entrydate>2010-02-04T23:07:00Z</entrydate> | <entrydate>2010-02-04T23:07:00Z</entrydate> | ||
<updatedate>2010-08-26T03:00:00Z</updatedate> | |||
<excerpt>ambient, orchestral drone music</excerpt> | <excerpt>ambient, orchestral drone music</excerpt> | ||
<tags>year:2009, ambient, magnatune, album, orchestral</tags> | <tags>year:2009, ambient, magnatune, album, orchestral</tags> | ||
<mimetype>image/jpeg</mimetype> | |||
<links> | <links> | ||
<link name="Emmalee Crane" type="INFO">http://magnatune.com/artists/emmalee_crane</link> | <link name="Emmalee Crane" type="INFO">http://magnatune.com/artists/emmalee_crane</link> | ||
| Line 124: | Line 134: | ||
<machine-url>http://www.safecreative.org/v2/?component=work.get&code=1002045450603</machine-url> | <machine-url>http://www.safecreative.org/v2/?component=work.get&code=1002045450603</machine-url> | ||
<allowdownload>false</allowdownload> | <allowdownload>false</allowdownload> | ||
<languagecode>EN</languagecode> | |||
<worktype> | <worktype> | ||
<code>music</code> | <code>music</code> | ||
| Line 132: | Line 143: | ||
<name>Audio</name> | <name>Audio</name> | ||
</worktypegroup> | </worktypegroup> | ||
</work> | |||
</pre> | |||
= Example with external registrations and metadata = | |||
REQUEST: | |||
<nowiki>https://api.safecreative.org/v2/</nowiki>?'''component'''=work.get&'''code'''=1212102847585 | |||
RESPONSE: | |||
<pre> | |||
<?xml version="1.0" encoding="UTF-8"?> | |||
<work> | |||
<code>1212102847585</code> | |||
<title>MUJERES AL BORDE DE UN ATAQUE DE NERVIOS</title> | |||
<entrydate>2012-12-10T13:45:18Z</entrydate> | |||
<updatedate>2012-12-10T13:45:20Z</updatedate> | |||
<excerpt></excerpt> | |||
<tags></tags> | |||
<mimetype>application/xml</mimetype> | |||
<authors/> | |||
<rights-holders> | |||
<rights-holder> | |||
<code>1212100738359</code> | |||
<name>Egeda</name> | |||
<human-url>http://www.safecreative.org/user/1212100738359</human-url> | |||
</rights-holder> | |||
</rights-holders> | |||
<informers> | |||
<informer> | |||
<code>1212100738359</code> | |||
<name>Egeda</name> | |||
<human-url>http://www.safecreative.org/user/1212100738359</human-url> | |||
</informer> | |||
</informers> | |||
<license> | |||
<code>copyright</code> | |||
<name>Todos los derechos reservados</name> | |||
<shortname>(c)</shortname> | |||
<endDate></endDate> | |||
<human-url>http://www.safecreative.org/license/copyright</human-url> | |||
<features> | |||
<recognition>NOT_APPLICABLE</recognition> | |||
<derivations>NO</derivations> | |||
<distribution>NO</distribution> | |||
<commercial>NO</commercial> | |||
<timelimited>NOT_APPLICABLE</timelimited> | |||
</features> | |||
</license> | |||
<human-url>http://www.safecreative.org/work/1212102847585-mujeres-al-borde-de-un-ataque-de-nervios</human-url> | |||
<machine-url>http://www.safecreative.org/v2/?component=work.get&code=1212102847585</machine-url> | |||
<allowdownload>false</allowdownload> | |||
<allowevaluation>false</allowevaluation> | |||
<allowsale>false</allowsale> | |||
<allowlicensing>false</allowlicensing> | |||
<languagecode>ES</languagecode> | |||
<worktype> | |||
<code>ffilm</code> | |||
<name>Largometraje</name> | |||
</worktype> | |||
<worktypegroup> | |||
<code>AV</code> | |||
<name>Audiovisual</name> | |||
</worktypegroup> | |||
<registrations> | |||
<registration> | |||
<registry type="OFFICIAL"> | |||
<code>egeda</code> | |||
<url>http://www.egeda.es</url> | |||
</registry> | |||
<code>11098</code> | |||
</registration> | |||
<registration> | |||
<registry type="INTERNATIONAL"> | |||
<code>isan</code> | |||
<url>http://www.isan.org</url> | |||
</registry> | |||
<code>0000-0001-BC82-0000-S-0000-0000-R</code> | |||
</registration> | |||
</registrations> | |||
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:xsd="http://www.w3.org/2001/XMLSchema#" xmlns:rol="http://rdvocab.info/roles/" xmlns:gn="http://www.geonames.org/ontology#"> | |||
<value property="dc:title" xml:lang="PT">MULHERES A BEIRA DE UM ATAQUE DE NERVOS</value> | |||
<value property="dc:title" xml:lang="FI">NAISIA HERMOROMAHDUKSEN PARTAALLA</value> | |||
<value property="dc:title" xml:lang="EN">WOMEN ON THE VERGE OF A NERVOUS BREAKDOWN</value> | |||
<value property="dc:title" xml:lang="RU">ZHENCHSHINY NA GRANI NERVNOGO SRYVA</value> | |||
<value property="dc:title" xml:lang="IT">DONNE SULL'ORLO DI UNA CRISI DI NERVI</value> | |||
<value property="dc:title" xml:lang="FR">FEMMES AU BORD DE LA CRISE DE NERFS</value> | |||
<value property="dc:title" xml:lang="DE">FRAUEN AM RANDE DES NERVENZUSAMMENBRUCH</value> | |||
<value property="dc:title" xml:lang="EL">GYNAIKES STA PROTYRA NEURIKIS KRISIS</value> | |||
<value property="dc:title" xml:lang="PL">KOBIETY NA SKRAJU ZALAMANIA NERWOWEGO</value> | |||
<value property="dc:title" xml:lang="DA">KVINDER PA RANDEN AF ET NERVOST SAMMENBRUD</value> | |||
<value property="dc:title" xml:lang="DA">KVINDER PA RANDEN AF NERVOST SAMMENBRUD</value> | |||
<value property="dc:title" xml:lang="SV">KVINNOR PA GRANSEN TILL NERVSAMMANBROTT</value> | |||
<value property="xsd:gYear">1988</value> | |||
<value property="rol:director">Pedro Almodovar</value> | |||
<value property="dc:extent">90</value> | |||
<value property="rol:actor">Angel De Andres Lopez</value> | |||
<value property="rol:actor">Julieta Serrano</value> | |||
<value property="rol:actor">Maria Barranco</value> | |||
<value property="rol:actor">Kiti Manver</value> | |||
<value property="rol:actor">Isabel Serrano</value> | |||
<value property="rol:actor">Antonio Banderas</value> | |||
<value property="rol:actor">Fernando Guillen</value> | |||
<value property="rol:actor">Guillermo Montesinos</value> | |||
<value property="rol:actor">Carmen Maura</value> | |||
<value property="rol:actor">Loles Leon</value> | |||
<value property="rol:actor">Chus Lampreave</value> | |||
<value property="rol:actor">Rossy De Palma</value> | |||
<value property="gn:countryCode">ES</value> | |||
</metadata> | |||
</work> | </work> | ||
</pre> | </pre> | ||
[[Category:API component]] | [[Category:API component]] | ||
Latest revision as of 08:07, 7 May 2021
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}.
Info
- Component name: work.get
- Signature: No signature required
- Timestamp: Ztime is not required
- API trust level: Public
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
- updatedate: Work update date
- excerpt: Work excerpt or description
- tags: Comma-separated list of tags
- thumbnail: URL to the work thumbnail (if any)
- mimetype: Work mime type
- links: Work links
- link: Link URL.
- name: Link title (XML attribute)
- type: Link type (INFO|DOWNLOAD) (XML attribute)
- relations: Work relations with other works
- relation: List of works related of a type (VERSION|DERIVATION|COMPOSITION|RELATED as XML attribute)
- work: Work related to this work
- name: Related work title (XML attribute)
- code: Related work code (XML attribute)
- work: Work related to this work
- relation: List of works related of a type (VERSION|DERIVATION|COMPOSITION|RELATED as XML attribute)
- 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)
- allowevaluation: An evaluation version of 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
- registrations: Work external registrations
- registration: Declares an external registration entry
- registry: Info about external registry. Type attribute can be: OFFICIAL (eg: USCO), LEGAL (eg: a local jurisdiction entity), INTERNATIONAL (International standard body such as isbn,isrc,isan,etc..)
- code: Internal registry code name
- url: Registry info url
- code: Work registration code within external registry
- registry: Info about external registry. Type attribute can be: OFFICIAL (eg: USCO), LEGAL (eg: a local jurisdiction entity), INTERNATIONAL (International standard body such as isbn,isrc,isan,etc..)
- registration: Declares an external registration entry
- metadata: Work metadata and referenced namespaces (see work.metadata.namespaces) (see RDFa)
- value: Metadata value.
Example
REQUEST:
https://api.safecreative.org/v2/?component=work.get&code=1002045450603
RESPONSE:
<?xml version="1.0" encoding="UTF-8"?>
<work>
<code>1002045450603</code>
<title>Crux</title>
<entrydate>2010-02-04T23:07:00Z</entrydate>
<updatedate>2010-08-26T03:00:00Z</updatedate>
<excerpt>ambient, orchestral drone music</excerpt>
<tags>year:2009, ambient, magnatune, album, orchestral</tags>
<mimetype>image/jpeg</mimetype>
<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>
<languagecode>EN</languagecode>
<worktype>
<code>music</code>
<name>Music</name>
</worktype>
<worktypegroup>
<code>Audio</code>
<name>Audio</name>
</worktypegroup>
</work>
Example with external registrations and metadata
REQUEST:
https://api.safecreative.org/v2/?component=work.get&code=1212102847585
RESPONSE:
<?xml version="1.0" encoding="UTF-8"?>
<work>
<code>1212102847585</code>
<title>MUJERES AL BORDE DE UN ATAQUE DE NERVIOS</title>
<entrydate>2012-12-10T13:45:18Z</entrydate>
<updatedate>2012-12-10T13:45:20Z</updatedate>
<excerpt></excerpt>
<tags></tags>
<mimetype>application/xml</mimetype>
<authors/>
<rights-holders>
<rights-holder>
<code>1212100738359</code>
<name>Egeda</name>
<human-url>http://www.safecreative.org/user/1212100738359</human-url>
</rights-holder>
</rights-holders>
<informers>
<informer>
<code>1212100738359</code>
<name>Egeda</name>
<human-url>http://www.safecreative.org/user/1212100738359</human-url>
</informer>
</informers>
<license>
<code>copyright</code>
<name>Todos los derechos reservados</name>
<shortname>(c)</shortname>
<endDate></endDate>
<human-url>http://www.safecreative.org/license/copyright</human-url>
<features>
<recognition>NOT_APPLICABLE</recognition>
<derivations>NO</derivations>
<distribution>NO</distribution>
<commercial>NO</commercial>
<timelimited>NOT_APPLICABLE</timelimited>
</features>
</license>
<human-url>http://www.safecreative.org/work/1212102847585-mujeres-al-borde-de-un-ataque-de-nervios</human-url>
<machine-url>http://www.safecreative.org/v2/?component=work.get&code=1212102847585</machine-url>
<allowdownload>false</allowdownload>
<allowevaluation>false</allowevaluation>
<allowsale>false</allowsale>
<allowlicensing>false</allowlicensing>
<languagecode>ES</languagecode>
<worktype>
<code>ffilm</code>
<name>Largometraje</name>
</worktype>
<worktypegroup>
<code>AV</code>
<name>Audiovisual</name>
</worktypegroup>
<registrations>
<registration>
<registry type="OFFICIAL">
<code>egeda</code>
<url>http://www.egeda.es</url>
</registry>
<code>11098</code>
</registration>
<registration>
<registry type="INTERNATIONAL">
<code>isan</code>
<url>http://www.isan.org</url>
</registry>
<code>0000-0001-BC82-0000-S-0000-0000-R</code>
</registration>
</registrations>
<metadata xmlns:dc="http://purl.org/dc/elements/1.1/" xmlns:xsd="http://www.w3.org/2001/XMLSchema#" xmlns:rol="http://rdvocab.info/roles/" xmlns:gn="http://www.geonames.org/ontology#">
<value property="dc:title" xml:lang="PT">MULHERES A BEIRA DE UM ATAQUE DE NERVOS</value>
<value property="dc:title" xml:lang="FI">NAISIA HERMOROMAHDUKSEN PARTAALLA</value>
<value property="dc:title" xml:lang="EN">WOMEN ON THE VERGE OF A NERVOUS BREAKDOWN</value>
<value property="dc:title" xml:lang="RU">ZHENCHSHINY NA GRANI NERVNOGO SRYVA</value>
<value property="dc:title" xml:lang="IT">DONNE SULL'ORLO DI UNA CRISI DI NERVI</value>
<value property="dc:title" xml:lang="FR">FEMMES AU BORD DE LA CRISE DE NERFS</value>
<value property="dc:title" xml:lang="DE">FRAUEN AM RANDE DES NERVENZUSAMMENBRUCH</value>
<value property="dc:title" xml:lang="EL">GYNAIKES STA PROTYRA NEURIKIS KRISIS</value>
<value property="dc:title" xml:lang="PL">KOBIETY NA SKRAJU ZALAMANIA NERWOWEGO</value>
<value property="dc:title" xml:lang="DA">KVINDER PA RANDEN AF ET NERVOST SAMMENBRUD</value>
<value property="dc:title" xml:lang="DA">KVINDER PA RANDEN AF NERVOST SAMMENBRUD</value>
<value property="dc:title" xml:lang="SV">KVINNOR PA GRANSEN TILL NERVSAMMANBROTT</value>
<value property="xsd:gYear">1988</value>
<value property="rol:director">Pedro Almodovar</value>
<value property="dc:extent">90</value>
<value property="rol:actor">Angel De Andres Lopez</value>
<value property="rol:actor">Julieta Serrano</value>
<value property="rol:actor">Maria Barranco</value>
<value property="rol:actor">Kiti Manver</value>
<value property="rol:actor">Isabel Serrano</value>
<value property="rol:actor">Antonio Banderas</value>
<value property="rol:actor">Fernando Guillen</value>
<value property="rol:actor">Guillermo Montesinos</value>
<value property="rol:actor">Carmen Maura</value>
<value property="rol:actor">Loles Leon</value>
<value property="rol:actor">Chus Lampreave</value>
<value property="rol:actor">Rossy De Palma</value>
<value property="gn:countryCode">ES</value>
</metadata>
</work>