user.attachSession

Once the user is authenticated against our service, he can attach a certain session to your web-application.

Signature:

XmlRpcArray user.attachSession(int sessionId)

Call:

URL: http://xmlrpc.renderfarm.fi/user.attachSession

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

During the call, the expected parameter is expected:

  • int sessionId: the id of the session that belongs to the user who wants to share its content

Exceptions:

In case the id of the session doesn't belong to the user or if the authentication goes unsuccessful. The explanation of the problem is located under oauth_problem.

Returns:

An XmlRpcStruct with the result of the call. The expected attribute is :

  • success: would be true

 Sample response:

<?xml version="1.0" encoding="utf-16"?>
<methodResponse>
    <params>
        <param>
            <value>
                <struct>
                    <member>
                        <name>success</name>
                        <value>
                            <boolean>1</boolean>
                        </value>
                    </member>
                </struct>
            </value>
        </param>
    </params>
</methodResponse>