Work.get.private

From SafeCreativeWiki

Jump to: navigation, search

Returns all data of a user's work. This includes private data not available to the public.

Contents

Info

  • Component name: work.get.private
  • Signature: Requires signature using the authkey's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: GET
  • API trust level: Standard

Parameters

  • authkey*: User's authorization key
  • ztime*: Z-Timestamp
  • code*: Work code
  • 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
    • state: Work state (see About works)
    • excerpt: Work excerpt or description
    • observations: Work private notes
    • 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)
    • 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)
    • allowdownload: This work can be downloaded (true|false)
    • allowevaluation: An evaluation version of this work can be downloaded (true|false)
    • registrypublic: Work registration is public (true|false)
    • usealias: Work is registered under pseudonym (true|false)
    • userauthor: User is author of this work (true|false)
    • userrights: User is a rights holder of this work (true|false)
    • useralias: User pseudonym this work is registered under
    • languagecode: Work language code (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

Example

REQUEST:

https://api.safecreative.org/v2/
?component=work.get.private
&authkey=1i5g2aaf2bz09lyo867cuimqg
&code=1004200146116
&ztime=1271749847821
&signature=40c6cabb341a463e4d824e702b1c4606692fa293

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<work>
  <code>1004200146116</code>
  <title>My first long registration</title>
  <entrydate>2010-04-20T07:50:43Z</entrydate>
  <updatedate>2010-08-26T03:00:00Z</updatedate>
  <state>PRE_REGISTERED</state>
  <excerpt>Very long text about registry philosophy</excerpt>
  <observations>Obs 2</observations>
  <tags>tag1, tag2</tags>
  <mimetype>text/plain</mimetype>
  <license>
    <code>http://creativecommons.org/licenses/nc-sampling+/1.0/</code>
    <name>Creative Commons NonCommercial Sampling Plus 1.0</name>
    <shortname>CC nc-sampling+-1.0</shortname>
    <endDate></endDate>
    <human-url>http://creativecommons.org/licenses/nc-sampling+/1.0/legalcode</human-url>
    <features>
      <derivations>YES</derivations>
      <distribution>YES</distribution>
      <recognition>YES</recognition>
      <commercial>NO</commercial>
      <timelimited>NOT_APPLICABLE</timelimited>
    </features>
  </license>
  <allowdownload>true</allowdownload>
  <registrypublic>true</registrypublic>
  <languagecode>EN</languagecode>
  <usealias>false</usealias>
  <userauthor>true</userauthor>
  <userrights>true</userrights>
  <worktype>
    <code>article</code>
    <name>Article</name>
  </worktype>
  <worktypegroup>
    <code>Literary</code>
    <name>Literary</name>
  </worktypegroup>
</work>
Personal tools
Safe Stamper API