Work.rightsholders.add - Revision history

Adminwiki: 13 revisions imported

2021-05-07T08:07:39Z

13 revisions imported

← Older revision	Revision as of 08:07, 7 May 2021
(No difference)

w>Jguillo: /* Parameters */

2016-07-14T12:43:57Z

Parameters

← Older revision		Revision as of 12:43, 14 July 2016
Line 31:		Line 31:
	** ''RIGHTS'' to add a rights holder		** ''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
	* '''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]].		* '''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.		* '''percent:''' Percent of authorship or rights the user has over the work. Allows up to two decimals.

w>Jguillo at 12:42, 14 July 2016

2016-07-14T12:42:41Z

← Older revision		Revision as of 12:42, 14 July 2016
Line 7:		Line 7:
	A mail can be sent to the provided address asking for confirmation.		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.~~rightholders~~.confirm]] or to build the confirmation URL https://www.safecreative.org/shareconfirm/CODE as the one sent in the confirmation e-mail.		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.		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.

w>Jguillo at 12:36, 14 July 2016

2016-07-14T12:36:07Z

← Older revision		Revision as of 12:36, 14 July 2016
Line 1:		Line 1:
	Requests a user to be added as an author or ~~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~~.

	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.		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.rightholders.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 29:		Line 32:
	* '''canedit*:''' 1 if user will be able to edit the work		* '''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]].		* '''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]].
			* '''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 34:		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

	= Example =		= Example =
Line 44:		Line 55:
	&'''authkey'''=1i5g2aaf2bz09lyo867cuimqg		&'''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 54:		Line 69:
	<pre>		<pre>
	<?xml version="1.0" encoding="UTF-8"?>		<?xml version="1.0" encoding="UTF-8"?>
	<confirm-~~url~~>~~https://www.safecreative.org/shareconfirm/~~8b017250f9d74615951b94ed4d492384</confirm-~~url~~>		<confirm-code>8b017250f9d74615951b94ed4d492384</confirm-code>
	</pre>		</pre>

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

w>Jguillo: /* Parameters */

2016-07-14T12:24:09Z

Parameters

← Older revision		Revision as of 12:24, 14 July 2016
Line 24:		Line 24:
	** Does not need to be the e-mail address used for logging in Safe Creative.		** 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.		** 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~~		* '''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
			* '''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]].

	<nowiki>*</nowiki> Required parameter		<nowiki>*</nowiki> Required parameter

w>Jguillo: /* Parameters */

2016-07-14T07:43:40Z

Parameters

← Older revision		Revision as of 07:43, 14 July 2016
Line 26:		Line 26:
	* '''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
	* '''private:''' 1 if user will not appear in the work public authors / right holders list

	<nowiki>*</nowiki> Required parameter		<nowiki>*</nowiki> Required parameter

w>Jguillo at 08:46, 14 May 2010

2010-05-14T08:46:18Z

← Older revision		Revision as of 08:46, 14 May 2010
Line 34:		Line 34:
	* '''confirm-url:''' Confirmation URL as sent in the mail to the new copyright holder		* '''confirm-url:''' Confirmation URL as sent in the mail to the new copyright holder

	= ~~Sample~~ =		= Example =

	REQUEST:		REQUEST:

w>Jguillo at 07:36, 6 May 2010

2010-05-06T07:36:18Z

← Older revision		Revision as of 07:36, 6 May 2010
Line 14:		Line 14:
	* '''Timestamp:''' Requires [[ztime parameter]]		* '''Timestamp:''' Requires [[ztime parameter]]
	* '''Authorization level:''' MANAGE		* '''Authorization level:''' MANAGE
			* '''API trust level''': Standard

	= Parameters =		= Parameters =

w>Jguillo at 07:09, 6 May 2010

2010-05-06T07:09:44Z

← Older revision		Revision as of 07:09, 6 May 2010
Line 1:		Line 1:
	~~Add~~ a user as a copyright holder of a work.		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

w>Jguillo at 06:55, 6 May 2010

2010-05-06T06:55:30Z

← Older revision		Revision as of 06:55, 6 May 2010
Line 34:		Line 34:

	<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		&'''roles'''=AUTHOR%2CRIGHTS_OWNER
Line 46:		Line 46:

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