Resource Description for UserRole

Properties for UserRole

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
active bool
code string
dataOrder int
description string
functionName string
permissionName string
sectionName string

SDK Example for PHP

<?PHP

use Arbor\Api\Gateway\RestGateway;
use Arbor\Model\ModelBase;
use Arbor\Model\UserRole;

ModelBase::setDefaultGateway(
    new RestGateway(
        "https://my-school.arbor.sc/rest-v2",
        "my.username@my-school.arbor.sc",
        "3bh54435v3gh45"
    )
);

$userRole = UserRole::retrieve(5433);

$code = $userRole->getCode();
$active = $userRole->getActive();
$dataOrder = $userRole->getDataOrder();
$sectionName = $userRole->getSectionName();
$functionName = $userRole->getFunctionName();
$permissionName = $userRole->getPermissionName();
$description = $userRole->getDescription();