Resource Description for GuardianRelationshipType

Properties for GuardianRelationshipType

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
active bool
code string
dataOrder int
isFemale bool
isMale bool
isSibling bool
relationshipName string
shortName string

SDK Example for PHP

<?PHP

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

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

$guardianRelationshipType = GuardianRelationshipType::retrieve(5433);

$code = $guardianRelationshipType->getCode();
$active = $guardianRelationshipType->getActive();
$dataOrder = $guardianRelationshipType->getDataOrder();
$relationshipName = $guardianRelationshipType->getRelationshipName();
$isMale = $guardianRelationshipType->getIsMale();
$isFemale = $guardianRelationshipType->getIsFemale();
$isSibling = $guardianRelationshipType->getIsSibling();