Work.list: Difference between revisions
Jump to navigation
Jump to search
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…' |
w>Jguillo No edit summary |
||
Line 6: | Line 6: | ||
* '''Timestamp:''' Requires [[ztime parameter]] | * '''Timestamp:''' Requires [[ztime parameter]] | ||
* '''Authorization level:''' GET | * '''Authorization level:''' GET | ||
* '''API trust level''': Standard | |||
= Parameters = | = Parameters = |
Revision as of 07:35, 6 May 2010
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
- API trust level: Standard
Parameters
- authkey*: User's authorization key
- ztime*: Z-Timestamp
- page: Page number
- locale: Locale for work type, license names,...
* Required parameter
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:
https://api.safecreative.org/v2/ ?component=work.list &authkey=1i5g2aaf2bz09lyo867cuimqg &page=1 &ztime=1271749847821 &signature=40c6cabb341a463e4d824e702b1c4606692fa293
RESPONSE:
<?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>