Resource Description for PostalAddressOccupancy

Properties for PostalAddressOccupancy

Property Name Type Required Is Collection?
Property Name Type Required Is Collection?
effectiveDate DateTime
endDate DateTime
isCorrespondenceAddress bool
occupant mixed
postalAddress PostalAddress
postalAddressType string

SDK Example for PHP

<?PHP

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

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

$postalAddressOccupancy = PostalAddressOccupancy::retrieve(5433);

$postalAddress = $postalAddressOccupancy->getPostalAddress();
$occupant = $postalAddressOccupancy->getOccupant();
$effectiveDate = $postalAddressOccupancy->getEffectiveDate();
$endDate = $postalAddressOccupancy->getEndDate();
$postalAddressType = $postalAddressOccupancy->getPostalAddressType();
$isCorrespondenceAddress = $postalAddressOccupancy->getIsCorrespondenceAddress();

 

Related Resources

See also: PostalAddress