View source for Work.rightsholders.list

Returns a list of the copyright holders of a work.

'Shared works management' professional service must be active for the authorizing user.

= Info =

* '''Component name:''' work.rightsholders.list
* '''Signature:''' Requires signature using the authorization key's private key
* '''Timestamp:''' ZTime is not required
* '''Authorization level:''' GET
* '''API trust level''': Standard

= Parameters =

* '''authkey*:''' Authorization key
* '''workcode*:''' Work code

<nowiki>*</nowiki> Required parameter

= Returns =

* '''rightsholders'''
** '''rightsholder'''
*** '''usercode''': Copyright holder's Safe Creative code
*** '''name''': Full name, pseudonym or mail address (if not confirmed yet)
*** '''can-edit''': Can edit the work (true|false)
*** '''state''': Rights sharing state. One of the following:
**** ''PENDING:'' A rights sharing request has been sent, but it has not been answered
**** ''ACTIVE:'' This rights sharing has been confirmed
**** ''REJECTED:'' This rights sharing request has been rejected by the recipient
**** ''INACTIVE:'' This rights sharing has been cancelled
**** ''INVALID:'' This rights sharing has been deemed invalid (e.g. recipient was already a copyright holder of the work)
*** '''entrydate''': Date of acceptance of rights holding
*** '''roles''': List of roles of this copyright holder
**** '''role''': One of AUTHOR, RIGHTS_HOLDER, INFORMER
*** '''pending-request''': There is a pending request to this copyright holder
**** '''confirm-url''': Confirmation URL sent with this request
**** '''request-usercode''': Safe Creative code of the user who made this request
**** '''request-state''': State to apply to this rights sharing if request is confirmed. Can be one of the following:
***** ''ACTIVE:'' It's a request for rights sharing
***** ''INACTIVE:'' It's a request to cancel the copyright holder rights
**** '''request-date''': Date when this request was sent

= Example =

REQUEST:

 <nowiki>https://api.safecreative.org/v2/</nowiki>
 ?'''component'''=work.rightsholders.list
 &'''authkey'''=1i5g2aaf2bz09lyo867cuimqg
 &'''workcode'''=1004200146116
 &'''signature'''=2975fb609c151e46ca26bbaabab16732288b126a

RESPONSE:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<rightsholders>
  <rightsholder>
    <usercode>0702034400200</usercode>
    <name>Sherlock Holmes</name>
    <can-edit>true</can-edit>
    <state>ACTIVE</state>
    <entrydate>2010-03-03T08:16:30Z</entrydate>
    <roles>
      <role>AUTHOR</role>
      <role>RIGHTS_OWNER</role>
    </roles>
  </rightsholder>
  <rightsholder>
    <usercode>0909160000830</usercode>
    <name>John Watson</name>
    <can-edit>false</can-edit>
    <state>REJECTED</state>
    <roles>
      <role>RIGHTS_OWNER</role>
    </roles>
  </rightsholder>
  <rightsholder>
    <usercode>0909160000830</usercode>
    <name>John Watson</name>
    <can-edit>true</can-edit>
    <state>ACTIVE</state>
    <entrydate>2010-05-06T06:53:56Z</entrydate>
    <roles>
      <role>RIGHTS_OWNER</role>
    </roles>
  </rightsholder>
</rightsholders>
</pre>

[[Category:API component]]