Estate Repository

Manage real estate data from onOffice. The resource type is estate.

Querying Estates

use Innobrain\OnOfficeAdapter\Facades\EstateRepository;

$estates = EstateRepository::query()->get();
$estate = EstateRepository::query()->first();
$estate = EstateRepository::query()->find(100);

Selecting Fields

$estates = EstateRepository::query()
    ->select(['Id', 'kaufpreis', 'objekttitel'])
    ->addSelect('wohnflaeche')
    ->get();

Filtering

Operators: =, >, <, >=, <=, !=, <>, between, like, not like, in, not in.

$estates = EstateRepository::query()
    ->where('status', 1)
    ->where('kaufpreis', '<', 300000)
    ->whereIn('objektart', ['haus', 'wohnung'])
    ->whereNotIn('objekttyp', ['buero'])
    ->whereNot('reserviert', 1)
    ->whereBetween('wohnflaeche', 50, 150)
    ->whereLike('objekttitel', '%Villa%')
    ->whereNotLike('objekttitel', '%Garage%')
    ->get();

Conditional Queries

$estates = EstateRepository::query()
    ->when($minPrice, fn ($q) => $q->where('kaufpreis', '>=', $minPrice))
    ->get();

Sorting & Pagination

$estates = EstateRepository::query()
    ->orderBy('kaufpreis')
    ->orderByDesc('geaendert_am')
    ->offset(100)
    ->limit(50)
    ->pageSize(100) // Records per API call (max 500)
    ->get();

Search

Search by estate address, owner, or external estate number:

$estates = EstateRepository::query()
    ->setInput('Karmelitenstr.')
    ->search();

Create & Modify

$estate = EstateRepository::query()
    ->create([
        'objektart' => 'haus',
        'nutzungsart' => 'wohnen',
        'vermarktungsart' => 'kauf',
        'kaufpreis' => 200000,
    ]);

EstateRepository::query()
    ->addModify(['kaufpreis' => 180000, 'status2' => 'status2obj_aktiv'])
    ->modify(100);

WARNING

status cannot be written: an integer is rejected as a type error, a string returns success without being applied, and on create it is silently ignored. Write status2 instead (status2obj_aktiv, status2obj_archiviert). It cascades into status.

WARNING

Modifying benutzer (Betreuer) only works while the record still belongs to the API user, and the value is never validated. A nonexistent ID is stored. Once benutzer is anyone else, every further benutzer modify returns success and changes nothing.

Estate Files

$files = EstateRepository::files(100)->get();
$file = EstateRepository::files(100)->find(12);

EstateRepository::files(100)
    ->addModify('Art', 'Titelbild')
    ->modify(12);

EstateRepository::files(100)->delete(12);

Estate Pictures

$pictures = EstateRepository::pictures(100)->get();
$pictures = EstateRepository::pictures([100, 101])->get();

$pictures = EstateRepository::pictures(100)
    ->category(['Titelbild', 'Foto'])
    ->size(800, 600)
    ->language('en')
    ->get();

EstateRepository::pictures([100, 101])->each(function (array $pictures) {
    // Process chunk
});

Categories: Titelbild, Foto, Foto_gross, Grundriss, Lageplan, Epass_Skala, Panorama, Link, Film-Link, Ogulo-Link, Objekt-Link, Expose

Customers can define their own categories. The API cannot enumerate them, so custom names must be known up front.

Estate Languages

Read the language variants of a multilingual estate (multi-language module). The resource type is estateLanguage.

$languages = EstateRepository::languages(100)->get();
$language = EstateRepository::languages(100)->first();

Each variant is its own estate record: id is the variant's estate id, language is a 3-letter ISO code, and mainLangId points to the main variant's id.

[
    ['id' => 100, 'type' => 'estateLanguage', 'elements' => ['language' => 'DEU', 'isMain' => true, 'mainLangId' => 100]],
    ['id' => 101, 'type' => 'estateLanguage', 'elements' => ['language' => 'ENG', 'isMain' => false, 'mainLangId' => 100]],
]

get() reads all variants in a single request. There is no pagination and no each(). To read the variants of many estates in one API call, batch the builders with Query::batch():

use Innobrain\OnOfficeAdapter\Facades\Query;

$results = Query::batch([
    EstateRepository::languages(100),
    EstateRepository::languages(200),
])->once();

To read the translated field contents of a specific variant, query the estate with the estatelanguage parameter (see Custom Parameters below).

Custom Parameters

$estates = EstateRepository::query()
    ->parameters([
        'georangesearch' => ['country' => 'DEU', 'zip' => '52068', 'radius' => 10],
    ])
    ->get();

$estates = EstateRepository::query()
    ->parameters(['estatelanguage' => 'ENG', 'filterid' => 109])
    ->get();

Counting & Chunked Processing

$count = EstateRepository::query()->where('status', 1)->count();

EstateRepository::query()
    ->where('status', 1)
    ->each(function (array $estates) {
        // Process chunk
    });

Debugging

EstateRepository::query()->dump()->get();  // Dump request
EstateRepository::query()->dd()->get();    // Dump and die
EstateRepository::query()->raw()->get();   // Dump raw array

Middleware

EstateRepository::query()
    ->before(fn ($request) => Log::info('Sending', ['r' => $request]))
    ->after(fn ($response) => Log::info('Received', ['s' => $response->status()]))
    ->get();

Alternative Credentials

$estates = EstateRepository::query()
    ->withCredentials($token, $secret, $apiClaim)
    ->get();

Common Field Names

Field	Description
status	1 = Active, 2 = Pending, 0 = Archive. Read-only; write status2
status2	status2obj_aktiv / status2obj_archiviert. The writable status
objektart	Property type (haus, wohnung, grundstueck)
nutzungsart	Type of use (wohnen, gewerbe)
vermarktungsart	Marketing type (kauf, miete)
kaufpreis	Purchase price
kaltmiete / warmmiete	Cold/warm rent
wohnflaeche	Living area
grundstuecksflaeche	Plot area
anzahl_zimmer	Number of rooms
verkauft	Sold/rented (1 = yes)
reserviert	Reserved (1 = yes)
geaendert_am	Last modified date

See also: File Repository