Resource Description for Snippet

Properties for Snippet

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
category string
isShared bool
linkedToEntity mixed
snippetName string
snippetText string
staff Staff

SDK Example for PHP

<?PHP

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

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

$snippet = Snippet::retrieve(5433);

$snippetName = $snippet->getSnippetName();
$snippetText = $snippet->getSnippetText();
$filterByReportCardTemplate = $snippet->getFilterByReportCardTemplate();
$filterByReportCardTemplateSection = $snippet->getFilterByReportCardTemplateSection();
$filterBySubject = $snippet->getFilterBySubject();
$filterByAcademicUnit = $snippet->getFilterByAcademicUnit();
$filterByAcademicLevel = $snippet->getFilterByAcademicLevel();
$filterByStaff = $snippet->getFilterByStaff();

 

Related Resources

See also: Staff