Resource Description for BusinessRole

Properties for BusinessRole

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
active bool
businessRoleDescription string
businessRoleName string
code string
customerManagesDefaultUserRoles bool
dataOrder int
internalStaff bool
teachingStaff bool
userDefinedDescription string
userDefinedName string

SDK Example for PHP

<?PHP

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

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

$businessRole = BusinessRole::retrieve(5433);

$code = $businessRole->getCode();
$active = $businessRole->getActive();
$dataOrder = $businessRole->getDataOrder();
$businessRoleName = $businessRole->getBusinessRoleName();
$businessRoleDescription = $businessRole->getBusinessRoleDescription();
$internalStaff = $businessRole->getInternalStaff();
$teachingStaff = $businessRole->getTeachingStaff();