Skip to content

Search Criteria Repository

Manage search criteria. The resource type is searchcriterias.

Modes

ModeDescription
internalBy internal address ID (Datensatznummer)
externalBy customer number (KdNr)
searchcriteriaBy search criteria ID

Querying

php
use Innobrain\OnOfficeAdapter\Facades\SearchCriteriaRepository;

$criteria = SearchCriteriaRepository::query()->mode('searchcriteria')->find(29);
$criteria = SearchCriteriaRepository::query()->mode('searchcriteria')->find([29, 30]);
$criteria = SearchCriteriaRepository::query()->mode('internal')->find(1214);

WARNING

The endpoint cannot list search criteria, so get(), first(), and each() are not supported — use find() with one or more ids.

Creating

php
$created = SearchCriteriaRepository::query()
    ->addressId(1214) // Required
    ->create([
        'vermarktungsart' => ['kauf'],
        'objektart' => ['haus', 'wohnung'],
        'range_kaufpreis' => [100000, 500000],
    ]);

Response Structure

Field values by type:

  • Multiselect: fieldname: [value_1, ..., value_n]
  • Range: range_fieldname: [from, to]
  • Normal: fieldname: value

Meta fields in _meta: internaladdressid, externaladdressid, kocriterias, status, creationdate, editdate

Released under the MIT License.