Resource Description for UserDefinedField

Properties for UserDefinedField

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
fieldName string
fieldType string
identifier string
relatedEntityType string

SDK Example for PHP

<?PHP

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

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

$userDefinedField = UserDefinedField::retrieve(5433);

$code = $userDefinedField->getCode();
$active = $userDefinedField->getActive();
$dataOrder = $userDefinedField->getDataOrder();
$fieldName = $userDefinedField->getFieldName();
$relatedEntityType = $userDefinedField->getRelatedEntityType();