Work.list - Revision history

Adminwiki: 4 revisions imported

2021-05-07T08:07:37Z

4 revisions imported

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

w>Jguillo: /* Parameters */

2016-03-10T11:01:39Z

Parameters

@@ Line 13: / Line 13: @@
 * '''page:''' Page number
 * '''locale:''' Locale for work type, license names,...
 <nowiki>* Required parameter</nowiki>

w>Jguillo at 08:44, 14 May 2010

2010-05-14T08:44:34Z

← Older revision		Revision as of 08:44, 14 May 2010
Line 25:		Line 25:
	** '''state''': Work state (see [[About works]])		** '''state''': Work state (see [[About works]])

	= ~~Sample~~ =		= Example =
	REQUEST:		REQUEST:

w>Jguillo at 07:35, 6 May 2010

2010-05-06T07:35:21Z

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

	= Parameters =		= Parameters =

w>Jguillo: Created page with 'Returns a user's registered works list. = Info = * '''Component name:''' work.list * '''Signature:''' Requires signature using the authkey's private key * '''Timestamp:''' Requi…'

2010-05-05T11:58:44Z

Created page with 'Returns a user's registered works list. = Info = * '''Component name:''' work.list * '''Signature:''' Requires signature using the authkey's private key * '''Timestamp:''' Requi…'

New page

Returns a user's registered works list.

= Info =
* '''Component name:''' work.list
* '''Signature:''' Requires signature using the authkey's private key
* '''Timestamp:''' Requires [[ztime parameter]]
* '''Authorization level:''' GET

= Parameters =
* '''authkey*:''' User's authorization key
* '''ztime*:''' Z-Timestamp
* '''page:''' Page number
* '''locale:''' Locale for work type, license names,...

<nowiki>* Required parameter</nowiki>

= Returns =

A [[paginated list]] of ''work'' elements:
* '''work'''
** '''code''': Safe Creative work code
** '''title''': Work title
** '''entrydate''': Work registration date
** '''state''': Work state (see [[About works]])

= Sample =
REQUEST:

<nowiki>https://api.safecreative.org/v2/</nowiki>
?'''component'''=work.list
&'''authkey'''=1i5g2aaf2bz09lyo867cuimqg
&'''page'''=1
&'''ztime'''=1271749847821
&'''signature'''=40c6cabb341a463e4d824e702b1c4606692fa293

RESPONSE:

<pre>
<?xml version="1.0" encoding="UTF-8"?>
<listpage>
<recordtotal>2</recordtotal>
<pagetotal>1</pagetotal>
<list>
<work>
<code>1003030120266</code>
<title>memorymanagement_whitepaper</title>
<entrydate>2010-03-03T08:17:15Z</entrydate>
<state>REGISTERED</state>
</work>
<work>
<code>1003030120259</code>
<title>Big times</title>
<entrydate>2010-03-03T08:16:30Z</entrydate>
<state>REGISTERED</state>
</work>
</list>
</listpage>
</pre>

[[Category:API component]]