Interface PlaceSystemsQueryOptions

Allowable query parameters for systems index endpoint

interface PlaceSystemsQueryOptions {
    _poll?: boolean;
    bookable?: boolean;
    cache?: number;
    capacity?: number;
    email?: string;
    features?: string;
    fields?: string;
    limit?: number;
    module_id?: string;
    offset?: number;
    public?: boolean;
    q?: string;
    ref?: string;
    signage?: boolean;
    trigger_id?: string;
    zone_id?: string;
}

Hierarchy (View Summary)

Properties

_poll? bookable? cache? capacity? email? features? fields? limit? module_id? offset? public? q? ref? signage? trigger_id? zone_id?

Properties

Optional_poll

_poll?: boolean

Whether the request is a API poll request

Optionalbookable

bookable?: boolean

Return only bookable or non-bookable rooms (returns both when not specified)

Optionalcache

cache?: number

Number of milliseconds to cache the query response

Optionalcapacity

capacity?: number

Return only rooms with capacity equal or greater than provided

Optionalemail

email?: string

Return only systems whose resource address matches one of the emails provided

Optionalfeatures

features?: string

Comma separated list of features. Return only rooms with all requested features

Optionalfields

fields?: string

Deprecated

Ignored by the server since PlaceOS moved search to PostgreSQL (PPT-2644)

Optionallimit

limit?: number

Number of results to return. Defaults to 20. Max 10000

Optionalmodule_id

module_id?: string

Return only systems which have this module ID

Optionaloffset

offset?: number

Offset of the results to return. Max 1000000

Optionalpublic

public?: boolean

Return systems which are public

Optionalq

q?: string

Free-text search filter. Words match as prefixes against the resource's searchable fields (PostgreSQL full-text search); all words must match.

Optionalref

ref?: string

Deprecated

Ignored by the server; pagination follows the Link header's offset

Optionalsignage

signage?: boolean

Only return systems that have signage capabilities

Optionaltrigger_id

trigger_id?: string

Return systems using this trigger ID

Optionalzone_id

zone_id?: string

Zone ID to filter the returned values on

Settings

Member Visibility

On This Page

Properties