FoyerDevelopers

Generated · Live registry

vermietungWohnungen tools

7 tools in this domain, generated from the running registry.

All tool domains

vermietungWohnungen.aendern

writes

Changes the fields sent for an apartment (id, plus any fields as in `anlegen`; null clears optional texts). It never changes the room or the export token. maxMonate below minMonate results in BAD_REQUEST, a duplicate kuerzel in CONFLICT, an apartment or house of another tenant in NOT_FOUND. Owner of a rental tenant only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes
hausIdstringno
kuerzelstringno
titelDestringno
titelEnstringno
beschreibungDestring · nullableno
beschreibungEnstring · nullableno
flaecheQmnumber · nullableno
maxPersonenintegerno
monatsmieteCentsintegerno
minMonateintegerno
maxMonateinteger · nullableno
kautionCentsintegerno
endreinigungCentsintegerno
nebenkostenobjectno
anmeldungMoeglichbooleanno
nachweisearray of enumno
ausstattungarray of stringno
hausregelnstring · nullableno
stornoregelenumnoOne of: strikt, flexibel
aktivbooleanno

Output fields

FieldTypeRequiredNotes
idstringyes

vermietungWohnungen.anlegen

writes

Creates an apartment: hausId, kuerzel (a-z, 0-9, hyphen), roomName (room name, at most 32 characters), titelDe, titelEn and monatsmieteCents are required, everything else has defaults. Creates the room and the apartment with a secret export token in one step. A duplicate kuerzel or room name results in CONFLICT (nothing is left behind), a house of another tenant in NOT_FOUND. Returns the id. Owner of a rental tenant only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
hausIdstringyes
roomNamestringyes
kuerzelstringyes
titelDestringyes
titelEnstringyes
monatsmieteCentsintegeryes
beschreibungDestring · nullableno
beschreibungEnstring · nullableno
flaecheQmnumber · nullableno
maxPersonenintegerno
minMonateintegerno
maxMonateinteger · nullableno
kautionCentsintegerno
endreinigungCentsintegerno
nebenkostenobjectno
anmeldungMoeglichbooleanno
nachweisearray of enumno
ausstattungarray of stringno
hausregelnstring · nullableno
stornoregelenumnoOne of: strikt, flexibel
aktivbooleanno

Output fields

FieldTypeRequiredNotes
idstringyes

vermietungWohnungen.bildEntfernen

writes

Removes an image of an apartment (bildId from `holen`) together with its file. An image of another tenant results in NOT_FOUND. Owner of a rental tenant only. Deletes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
bildIdstringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

vermietungWohnungen.bildReihenfolge

writes

Reorders the images of an apartment: bildIds in the desired order, first image first; images not listed follow in their previous order. Every bildId must belong to this apartment, otherwise NOT_FOUND and nothing changes; duplicate bildIds result in BAD_REQUEST. Owner of a rental tenant only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
wohnungIdstringyes
bildIdsarray of stringyes

Output fields

FieldTypeRequiredNotes
okliteralyesOne of: true

vermietungWohnungen.exportTokenErneuern

writes

Generates a new secret token for the iCal export of an apartment and returns the new address. The old address returns nothing afterwards; HousingAnywhere must be given the new one. An apartment of another tenant results in NOT_FOUND. Owner of a rental tenant only. Changes data. Mutation — changes data.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
exportAdressestringyes

vermietungWohnungen.holen

read-only

Returns one apartment with all fields, its room name (roomName), the iCal export address (exportAdresse), the HousingAnywhere source (haQuelle: url, last success, last error, or null) and its images in order. An apartment of another tenant results in NOT_FOUND. Owner of a rental tenant only. Read-only query.

Input parameters

FieldTypeRequiredNotes
idstringyes

Output fields

FieldTypeRequiredNotes
idstringyes
hausIdstringyes
roomIdstringyes
roomNamestringyes
kuerzelstringyes
titelDestringyes
titelEnstringyes
beschreibungDestring · nullableyes
beschreibungEnstring · nullableyes
flaecheQmnumber · nullableyes
maxPersonenintegeryes
monatsmieteCentsintegeryes
minMonateintegeryes
maxMonateinteger · nullableyes
kautionCentsintegeryes
endreinigungCentsintegeryes
nebenkostenobjectyes
nebenkosten.stromenum | objectno
nebenkosten.wasserenum | objectno
nebenkosten.heizungenum | objectno
nebenkosten.internetenum | objectno
anmeldungMoeglichbooleanyes
nachweisearray of enumyes
ausstattungarray of stringyes
hausregelnstring · nullableyes
stornoregelenumyesOne of: strikt, flexibel
aktivbooleanyes
createdAtstringyes
updatedAtstringyes
exportAdressestringyes
haQuelleobject · nullableyes
haQuelle.urlstringyes
haQuelle.letzterErfolgstring · nullableyes
haQuelle.letzterFehlerstring · nullableyes
bilderarray of objectyes
bilder.idstringyes
bilder.srcstringyes
bilder.reihenfolgeintegeryes

vermietungWohnungen.liste

read-only

Lists all apartments of the rental business (short code, title, house, monthly rent in cents, active) with `freiAb`: the first day from which the apartment's minimum rental duration is free without a break (YYYY-MM-DD, today in Berlin at the earliest), or null for switched-off apartments and when nothing is free in the next 24 months. Owner of a rental tenant only. Read-only query.

Input parameters

Returns object.

Output fields

Returns array of object. Fields of each element:

FieldTypeRequiredNotes
idstringyes
kuerzelstringyes
titelstringyes
hausNamestringyes
monatsmieteCentsintegeryes
aktivbooleanyes
freiAbstring · nullableyes