16. Roles

Interface

It allows you:

• to get list of roles

Columns that can be used as filters:

• Organization

• Name

• Active

• RoleType

For RoleType, the list of values is:

• "Admin" - in case the role of user has IsAdministrator true;

• "Customer" - in case the role of user has IsUseBPRestrictions true AND the role type is "Role Web Store";

• "Seller" - in case the role of the user is of type "Role Comercial Customer"

• "Supplier" - in case the role of the user is of type "Role Comercial Vendor"

• "User" - none of above.

Actions can be done:

• list

API Methods:

List:

URL: https://api.socratecloud.com/webapi/rest/role/list/{version}?startRow={0}&endRow={100}&accessToken={access_token}

Method: GET

Return: JSON object with next format:

{

    "data": [

        {

            "Organization": "*",

            "Created": "2007-08-22 08:30:05+0300",

            "CreatedBy": "System",

            "Updated": "2014-07-29 13:38:12+0300",

            "UpdatedBy": "SuperVisor",

            "Name": "Rol Admin",

            "RoleType": "Admin",

            "Active": true,

            "IsRoleApps": true

        }

    ],

    "totalRows": 1

}