session.setExternalUrls

Set the Urls that the session can be related with. You must first ask for a session key with auth.getSessionKey.

Signature:

XmlRpcStruct session.setExternalUrls(int userId, String sessionKey, int sessionId, String extUrl)

Call:

URL: http://xmlrpc.renderfarm.fi/session

Method: POST only

Protocol: XmlRpc Transport: HTTP

Handler name: session.setExternalURLs

Parameters:

Expected parameters are:

  • int userId: the id of the user
  • String sessionKey: the last session key generated
  • int sessionId: the id of the session being submitted. Returned from the call to auth.getSessionKey
  • String extUrl: The url the session can be related to

Exceptions:

The list of possible exceptions is :

CodeReason
500Parameters incorrect
501Session doens't belong to user
503Session key invalid

 

Returns:

An associative array with the expected parameters :

  • success: tells about the success of the call
  • key: next session key to use

Sample response:

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