getConfiguration()

Pixelsilk API function that returns the key/value set of configuration settings for the site--these settings are entered in the administration area and stored in the database
Parameters:
The getConfiguration function does not have any parameters.

Output:
The getConfiguration function returns a collection of key/value pairs. The key is the name of the setting; the value is its value.

C# Example:
IDictionary<string, string> settings = GetConfiguration();
Note the capital first letter of the C# method.

HTTP Example:
Request Headers:
POST /api2/getConfiguration HTTP/1.1
HOST: www.example.com
Content-Length: 36
Content-Type: application/x-www-form-urlencoded
Cookie: auth=14D76E663B34...276BB0D0B2DE

Request Data:
Unencoded Data:
token=7AdbNHZQBtwc...RPTEK8UvSUQ=

Url-encoded Data:
token=7AdbNHZQBtwc...TEK8UvSUQ=

Response Headers:
HTTP/1.1 200 OK
Set-Cookie: auth=865FA9AE97AD...9EB56092416; path=/
Content-Type: text/javascript; charset=UTF-8
Content-Length: 191

Response Data:
{"DefaultFileName":"Default.aspx","EnableSysControl":"true"}

JavaScript Example:
Method Call:
pixelsilk2.getConfiguration(callback)

Input Object:
There is no input object for getConfiguration().

Returned Data:
{
    "EnableSearchAdvice":"True",
    "EventAddUserUrl":"http://www.example.com/"
}

Back to Configuration »