user.getAllSessions
Once the user is authenticated against our service, he can browse simple information about his sessions.
Signature:
XmlRpcStruct user.getAllSessions()
Call:
URL: http://xmlrpc.renderfarm.fi/user.getAllSessions
Method: POST only
Protocol: OAuth v1.0 using HMAC-SHA1 for signing the requests
Transport: HTTP
Parameters:
Expected parameters are as defined in the OAuth protocol:
- oauth_consumer_key: the consumer key provided by Renderfarm
- oauth_token: the access token obtained previously
- oauth_signature_method: the method used to sign the request, in our case "HMAC-SHA1"
- oauth_signature: the signature
- oauth_timestamp: the timestamp in seconds
- oauth_nonce: a non reproducable value. Can be produced thanks to the timestamps in milliseconds
Exceptions:
In case anything goes wront such as authentication or signature validation.
Returns:
An XmlRpcStruct with the sessions that belong to the user. There's three different categories of sessions:
- accept: the sessions that will be review by an admin before rendering
- active: the sessions that are being rendered
- completed: the sessins that have been completed
For each session, only basic information is available:
- submitTimestamp: the timestamp when the session has been submitted to our service
- sessionShortDescription: the short description of the session
Sample response:
<?xml version="1.0" encoding="utf-16"?>
<methodResponse>
<params>
<param>
<value>
<struct>
<member>
<!-- All session have been accepted --!
<name>accept</name>
<value>
</struct>
</value>
</member>
<member>
<name>active</name>
<value>
<struct>
<member>
<name>413</name>
<value>
<struct>
<member>
<name>title</name>
<value>
<string>Flower animation</string>
</value>
</member>
<member>
<name>shortDescription</name>
<value>
<string>Small animation that uses particules</string>
</value>
</member>
<member>
<name>submitTimestamp</name>
<value>
<i4>1277815385</i4>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>346</name>
<value>
<struct>
<member>
<name>title</name>
<value>
<string>Blur sahara effect</string>
</value>
</member>
<member>
<name>shortDescription</name>
<value>
<string>Test animation for the blur effect</string>
</value>
</member>
<member>
<name>submitTimestamp</name>
<value>
<i4>1274971740</i4>
</value>
</member>
</struct>
</value>
</member>
<member>
<name>262</name>
<value>
<struct>
<member>
<name>title</name>
<value>
<string>Heavy animation</string>
</value>
</member>
<member>
<name>shortDescription</name>
<value>
<string>School project</string>
</value>
</member>
<member>
<name>submitTimestamp</name>
<value>
<i4>1271948872</i4>
</value>
</member>
</struct>
</value>
</member>
<member>
</struct>
</value>
</member>
<member>
<!-- None yet --!
<name>completed</name>
<value>
</struct>
</value>
</member>
</struct>
</value>
</param>
</params>
</methodResponse>