getColors

This method returns childs of a parent colors in the Fotolia color scheme. If no parent is provided first level colors are returned. This method can be used to display color and subcolors for color search queries.

Authentication

This method does not require authentification.

Arguments

Argument Type Valid Values Default Value Detail
api_key string Valid Values required you need a valid api key to use the API
id int existing color ID or blank blank parent color ID - if this field is not populated first level colors are returned

Returned Values

Element (path) Name Type Description
/[n]/ name string color name
color RBG code
can be used for color search with getSearchResults
/[n]/ id int color ID

Example Query


<?xml version="1.0" encoding="utf-8"?>
<methodCall>
	<methodName>xmlrpc.getColors</methodName>
	<params>
		<param>
			<value>
				<string>YOUR_API_KEY</string>
			</value>
		</param>
		<param>
			<value>
				<int>6</int>
			</value>
		</param>
	</params>
</methodCall>

Example Response


<?xml version="1.0" encoding="UTF-8"?>
<methodResponse>
  <params>
    <param>
      <value>
        <struct>
          <member>
            <name>colors</name>
            <value>
              <struct>
                <member>
                  <name>65</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>65</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>80BFFF</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>70</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>70</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>95BFEA</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>81</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>81</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>AABFD5</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>42</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>42</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>557FAA</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>25</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>25</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>2B7FD4</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>14</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>14</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>15406A</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>21</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>21</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>2B4055</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
                <member>
                  <name>5</name>
                  <value>
                    <struct>
                      <member>
                        <name>id</name>
                        <value>
                          <int>5</int>
                        </value>
                      </member>
                      <member>
                        <name>name</name>
                        <value>
                          <string>004080</string>
                        </value>
                      </member>
                    </struct>
                  </value>
                </member>
              </struct>
            </value>
          </member>
        </struct>
      </value>
    </param>
  </params>
</methodResponse>

Error Codes

001: Service currently unavailable
The requested service is temporarily unavailable.
002: Failed to parse request
The XML-RPC request document could not be parsed.
010: Missing API Key
The API key passed is missing.
011: Invalid API Key
The API key passed is not valid or has expired.
031: Invalid Method
This method does not exist in the method list.
032: Method not Available
This method is not available for this API Key.
601: Invalid Color ID
The Color ID passed is not valid or doesn't exist in the fotolia color scheme