Work.rightsholders.add

From Safe Creative API
Revision as of 12:24, 14 July 2016 by w>Jguillo (→‎Parameters)
Jump to navigation Jump to search

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

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

A mail will be sent to the provided address asking for confirmation. This method returns the confirmation URL sent to the mail address.

Be careful not to visit the returned 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.rightholders.confirm.

* Required parameter

Returns

  • confirm-url: Confirmation URL as sent in the mail to the new copyright holder

Example

REQUEST:

https://api.safecreative.org/v2/
?component=work.rightsholders.add
&authkey=1i5g2aaf2bz09lyo867cuimqg
&mail=sholmes%40baker.fake
&roles=AUTHOR%2CRIGHTS_OWNER
&canedit=1
&workcode=1004200146116
&ztime=1271749848300
&signature=2975fb609c151e46ca26bbaabab16732288b126a

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<confirm-url>https://www.safecreative.org/shareconfirm/8b017250f9d74615951b94ed4d492384</confirm-url>