api.safecreative.org

Safe Creative API Web Services Reference v2 - D R A F T

work.rightsholders.add

Info

Component name: work.rightsholders.add
Signature: Requires signature using the authorization key's private key
Timestamp: Requires ztime parameter

Parameters

authkey*: Authorization key
canedit*: 1 if user will be able to edit the work
mail*: E-mail address of the copyright holder
roles*: Comma-separated list of any of the following values: AUTHOR, RIGHTS_OWNER
workcode*: Work code
ztime*: Z-Timestamp

* Required parameter

Description

Add a user as a copyright holder of a work
'Shared works 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.


Example
Example of adding an author to a work:


REQUEST:

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

RESPONSE:

<?xml version="1.0" encoding="UTF-8"?>
<error>
  <errorId>RestParameterNotFound</errorId>
  <errorMessage>Required parameter not found: canedit</errorMessage>
</error>

TOC