getEveryone()

Pixelsilk API function to return only the everyone role--requires the access-users permission
Parameters:
The function getEveryone has no parameters.

Output:
The function getEveryone returns an everyone role object containing: id, name, description, isSystemRole, isHidden, adminAccess.

C# Example:
object everyone = GetEveryone();
Note the capital first letter of the C# method.

HTTP Example:
Request Headers:
POST /api2/getEveryone HTTP/1.1
HOST: www.example.com
Content-Length: 36
Content-Type: application/x-www-form-urlencoded
Cookie: auth=CE60764E0412...7676A38EEC4A

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

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

Response Headers:
HTTP/1.1 200 OK
Set-Cookie: auth=B91216F83DED...2DA0B9344E7; path=/
Content-Type: text/javascript; charset=UTF-8
Content-Length: 133

Response Data:
{
  "id":"b69a7b39-7d88-47bf-835c-2baf14781aaa",
  "name":"Everyone",
  "description":"",
  "isSystemRole":true,
  "isHidden":true,
  "adminAccess":[
  ]
}

JavaScript Example:
Method Call:
pixelsilk2.getEveryone(callback);

Input Object:
The function getEveryone has no parameters.

Returned Data:
{
    "id":"a39f316d-3391-43ea-8de7-e7b5904cd908",
    "name":"Everyone",
    "description":"",
    "isSystemRole":true,
    "isHidden":true,
    "adminAccess":[
    ]
}

Back to Users »