Work.rightsholders.add: Difference between revisions
Jump to navigation
Jump to search
w>Jguillo No edit summary |
w>Jguillo No edit summary |
||
| Line 1: | Line 1: | ||
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. | 'Shared rights management' professional service must be active for the authorizing user. | ||
A mail will be sent to the provided address asking for confirmation. | A mail will be sent to the provided address asking for confirmation. | ||
This method returns the confirmation URL sent to the mail address. | 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 = | = Info = | ||
| Line 18: | Line 20: | ||
* '''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. | ||
** 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. | |||
* '''roles*:''' Comma-separated list of any of the following values: AUTHOR, RIGHTS_OWNER | * '''roles*:''' Comma-separated list of any of the following values: AUTHOR, RIGHTS_OWNER | ||
* '''canedit*:''' 1 if user will be able to edit the work | * '''canedit*:''' 1 if user will be able to edit the work | ||
Revision as of 07:09, 6 May 2010
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
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.
- roles*: Comma-separated list of any of the following values: AUTHOR, RIGHTS_OWNER
- 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
* Required parameter
Returns
- confirm-url: Confirmation URL as sent in the mail to the new copyright holder
Sample
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>