Resource Description for CustomGroup

Properties for CustomGroup

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
academicYear AcademicYear
containsGuardians string
containsStaff string
containsStudents string
customGroupName string
description string
isDynamic bool

SDK Example for PHP

<?PHP

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

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

$customGroup = CustomGroup::retrieve(5433);

$customGroupName = $customGroup->getCustomGroupName();
$description = $customGroup->getDescription();

 

Related Resources

See also: AcademicYear