session.setInputLicense

Set the input license regarding the current session being submitted. You must first ask for a session key with auth.getSessionKey.

Signature:

XmlRpcStruct session.set InputLicense(int userId, String sessionKey, int sessionId, int inLicense)

Call:

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

Method: POST only

Protocol: XmlRpc Transport: HTTP

Handler name: session.setInputLicense

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
  • int inLicense: the id of the license to use as input. Possible values are:
License IdDescription
1Creative Commons: Attribution Non-Commercial No Derivatives
2Creative Commons: Attribution Non-Commercial Share Alike
3Creative Commons: Attribution No Derivatives
4Creative Commons: Attribution Non-Commercial
5Creative Commons: Attribution Share Alike
6Creative Commons: Attribution
7Copyright, no license specified

 

Exceptions:

The list of possible exceptions is :

CodeReason
500Parameters incorrect
501Session doens't belong to user
502Session can't be changed if already submitted
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>