getControls()

Pixelsilk API function to get the list of controls for the site--requires the advanced-admin-access permission
Parameters:
The function getControls has no parameters.

Output:
The function getControls returns a list of all controls for the site.

c# Example:
IEnumerable controls = GetControls();
Note the capital first letter of the C# method.

HTTP Example:
Request Headers:
POST /api2/getControls HTTP/1.1
HOST: www.example.com
Content-Length: 36
Content-Type: application/x-www-form-urlencoded
Cookie: auth=3578E1165180...BAF7610F2585

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

Url-encoded Data:
token=7AdbNHZQBtwc...TEK8UvSUQ%3d

Response Headers:
HTTP/1.1 200 OK
Set-Cookie: auth=5B3F31070D66...3F2D6CD0ACE; path=/
Content-Type: text/javascript; charset=UTF-8
Content-Length: 3621

Response Data:
[{"id":"f30d0bf1-6c78-4fa1-8b01-6684ae0954c1",  "name":"ExampleHtmlWebbox","type":"HtmlWebbox","availableTo":[]}, {"id":"93e407d2-cf0e-4ac8-afae-d08fd19fd38d", "name":"ExampleTextWebbox","type":"TextWebbox","availableTo":[]}]

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

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

Returned Data:
[
    {
        "id":"5e591461-bff5-4bbb-ae49-450a1617221b",
        "name":"SiteMap1",
        "type":"SiteMap",
        "availableTo":[
        ],
        "groupName":null
    },
    {
        "id":"f145cf6b-9cfb-407a-8c16-86bd8edc0ef5",
        "name":"SiteMap2",
        "type":"SiteMap",
        "availableTo":[
        ],
        "groupName":null
    },
]
NOTE: many controls have been removed from this list to make it easier to read.

Back to Controls »