Work.rightsholders.add: Difference between revisions

From Safe Creative API
Jump to navigation Jump to search
← Older edit
w>Jguillo
No edit summary
m 13 revisions imported
 
(9 intermediate revisions by one other user not shown)
Line 1: Line 1:
Add a user as a copyright holder of a work.
Requests a user to be added as an author or rights holder of a work.


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


A mail will be sent to the provided address asking for confirmation.
If the user is added as a rights holder, either the authorizing user or the invited user must have the 'Rights inscription' professional service.
This method returns the confirmation URL sent to the mail address.
 
A mail can be sent to the provided address asking for confirmation.
 
This method returns the confirmation code for the request. This code can be used to confirm or reject the request using [[work.rightsholders.confirm]] or to build the confirmation URL https://www.safecreative.org/shareconfirm/CODE as the one sent in the confirmation e-mail.
 
Be careful not to visit the confirmation URL while logged in on Safe Creative as the authorizing user. This will be understood as the request having been sent to the authorizing user, who already is a copyright holder of the work. This will deem the request invalid.


= Info =
= Info =
Line 12: Line 17:
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Authorization level:''' MANAGE
* '''Authorization level:''' MANAGE
* '''API trust level''': Standard


= Parameters =
= Parameters =
Line 18: Line 24:
* '''ztime*:''' Z-Timestamp
* '''ztime*:''' Z-Timestamp
* '''workcode*:''' Work code
* '''workcode*:''' Work code
* '''mail*:''' E-mail address of the copyright holder
* '''mail*:''' E-mail address of the copyright holder.
* '''roles*:''' Comma-separated list of any of the following values: AUTHOR, RIGHTS_OWNER
** Does not need to be the e-mail address used for logging in Safe Creative.
** In fact, recipient does not need to be a Safe Creative user. An account can be created when visiting the confirmation URL.
* '''type:''' Type of inscription to add:  
** ''AUTHORSHIP'' to add a coauthor
** ''RIGHTS'' to add a rights holder
* '''canedit*:''' 1 if user will be able to edit the work
* '''canedit*:''' 1 if user will be able to edit the work
* '''private:''' 1 if user will not appear in the work public authors / right holders list
* '''sendmail:''' (1/0) Whether to send an e-mail to the user for confirming the coauthorship request. Defaults to true. If no mail is sent, the request must be confirmed using [[work.rightsholders.confirm]].
* '''percent:''' Percent of authorship or rights the user has over the work. Allows up to two decimals.
 
For RIGHTS inscriptions, the following parameters also apply:
* '''rights*:''' Textual description of the rights the user is inscribing. Required for rights inscriptions.
* '''begindate:''' When do the inscribed rights begin to apply.
* '''enddate:''' When do the inscribed rights cease to apply.
* '''jurisdictions:''' On which jurisdictions (countries, geographic zones) do the inscribed rights apply.
* '''rightswindow:''' For which kind of media do the rights apply (e.g. TV broadcast, paperback edition,...)


<nowiki>*</nowiki> Required parameter
<nowiki>*</nowiki> Required parameter
Line 27: Line 45:
= Returns =
= Returns =


* '''confirm-url:''' Confirmation URL as sent in the mail to the new copyright holder
* '''confirm-code:''' Confirmation code for the request


= Sample =
= Example =


REQUEST:
REQUEST:


  <nowiki>https://api.safecreative.org/v2/</nowiki>
  <nowiki>https://api.safecreative.org/v2/</nowiki>
  ?'''authkey'''=1i5g2aaf2bz09lyo867cuimqg
  ?'''component'''=work.rightsholders.add
  &'''component'''=work.rightsholders.add
  &'''authkey'''=1i5g2aaf2bz09lyo867cuimqg
  &'''mail'''=sholmes%40baker.fake
  &'''mail'''=sholmes%40baker.fake
  &'''roles'''=AUTHOR%2CRIGHTS_OWNER
  &'''type'''=RIGHTS
  &'''canedit'''=1
  &'''canedit'''=1
  &'''workcode'''=1004200146116
  &'''workcode'''=1004200146116
&'''rights'''=Distribution
&'''percent'''=100
&'''jurisdictions'''=Worldwide
&'''beginDate'''=2016-07-14T12:00:00Z
  &'''ztime'''=1271749848300
  &'''ztime'''=1271749848300
  &'''signature'''=2975fb609c151e46ca26bbaabab16732288b126a
  &'''signature'''=2975fb609c151e46ca26bbaabab16732288b126a
Line 47: Line 69:
<pre>
<pre>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<?xml version="1.0" encoding="UTF-8"?>
<confirm-code>8b017250f9d74615951b94ed4d492384</confirm-code>
<confirm-url>https://www.safecreative.org/shareconfirm/8b017250f9d74615951b94ed4d492384</confirm-url>
</pre>
</pre>


[[Category: API component]]
[[Category: API component]]

Latest revision as of 08:07, 7 May 2021

Requests a user to be added as an author or rights holder of a work.

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

If the user is added as a rights holder, either the authorizing user or the invited user must have the 'Rights inscription' professional service.

A mail can be sent to the provided address asking for confirmation.

This method returns the confirmation code for the request. This code can be used to confirm or reject the request using work.rightsholders.confirm or to build the confirmation URL https://www.safecreative.org/shareconfirm/CODE as the one sent in the confirmation e-mail.

Be careful not to visit the confirmation URL while logged in on Safe Creative as the authorizing user. This will be understood as the request having been sent to the authorizing user, who already is a copyright holder of the work. This will deem the request invalid.

Info

  • Component name: work.rightsholders.add
  • Signature: Requires signature using the authorization key's private key
  • Timestamp: Requires ztime parameter
  • Authorization level: MANAGE
  • API trust level: Standard

Parameters

  • authkey*: Authorization key
  • ztime*: Z-Timestamp
  • workcode*: Work code
  • mail*: E-mail address of the copyright holder.
    • Does not need to be the e-mail address used for logging in Safe Creative.
    • In fact, recipient does not need to be a Safe Creative user. An account can be created when visiting the confirmation URL.
  • type: Type of inscription to add:
    • AUTHORSHIP to add a coauthor
    • RIGHTS to add a rights holder
  • canedit*: 1 if user will be able to edit the work
  • sendmail: (1/0) Whether to send an e-mail to the user for confirming the coauthorship request. Defaults to true. If no mail is sent, the request must be confirmed using work.rightsholders.confirm.
  • percent: Percent of authorship or rights the user has over the work. Allows up to two decimals.

For RIGHTS inscriptions, the following parameters also apply:

  • rights*: Textual description of the rights the user is inscribing. Required for rights inscriptions.
  • begindate: When do the inscribed rights begin to apply.
  • enddate: When do the inscribed rights cease to apply.
  • jurisdictions: On which jurisdictions (countries, geographic zones) do the inscribed rights apply.
  • rightswindow: For which kind of media do the rights apply (e.g. TV broadcast, paperback edition,...)

* Required parameter

Returns

  • confirm-code: Confirmation code for the request

Example

REQUEST: 

https://api.safecreative.org/v2/
?component=work.rightsholders.add
&authkey=1i5g2aaf2bz09lyo867cuimqg
&mail=sholmes%40baker.fake
&type=RIGHTS
&canedit=1
&workcode=1004200146116
&rights=Distribution
&percent=100
&jurisdictions=Worldwide
&beginDate=2016-07-14T12:00:00Z
&ztime=1271749848300
&signature=2975fb609c151e46ca26bbaabab16732288b126a

RESPONSE: 

<?xml version="1.0" encoding="UTF-8"?>
<confirm-code>8b017250f9d74615951b94ed4d492384</confirm-code>
Retrieved from "https://www.safecreative.org/mw/index.php?title=Work.rightsholders.add&oldid=712"