Resource Description for Kpi

Properties for Kpi

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
calculateForAcademicUnits bool
calculateForGroups bool
calculateForSchool bool
calculateForStudentAcademicUnitEnrolments bool
calculateForStudents bool
calculationClass string
calculationClassParams string
category string
code string
dateRangePeriodCount int
dateRangePeriodOffset int
dateRangePeriodType string
decimalPlaces int
description string
direction string
kpiName string
significantFigures int
valueType string

SDK Example for PHP

<?PHP

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

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

$kpi = Kpi::retrieve(5433);

$code = $kpi->getCode();
$kpiName = $kpi->getKpiName();
$description = $kpi->getDescription();
$calculationClass = $kpi->getCalculationClass();
$calculationClassParams = $kpi->getCalculationClassParams();
$valueType = $kpi->getValueType();
$dateRangePeriodType = $kpi->getDateRangePeriodType();
$dateRangePeriodCount = $kpi->getDateRangePeriodCount();
$dateRangePeriodOffset = $kpi->getDateRangePeriodOffset();
$formatDecimalPlaces = $kpi->getFormatDecimalPlaces();
$calculateForSchool = $kpi->getCalculateForSchool();
$calculateForGroups = $kpi->getCalculateForGroups();
$calculateForAcademicUnits = $kpi->getCalculateForAcademicUnits();
$calculateForStudents = $kpi->getCalculateForStudents();
$calculateForStudentAcademicUnitEnrolments = $kpi->getCalculateForStudentAcademicUnitEnrolments();