vermietungWohnungen.aendern
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
hausId | string | no | |
kuerzel | string | no | |
titelDe | string | no | |
titelEn | string | no | |
beschreibungDe | string · nullable | no | |
beschreibungEn | string · nullable | no | |
flaecheQm | number · nullable | no | |
maxPersonen | integer | no | |
monatsmieteCents | integer | no | |
minMonate | integer | no | |
maxMonate | integer · nullable | no | |
kautionCents | integer | no | |
endreinigungCents | integer | no | |
nebenkosten | object | no | |
anmeldungMoeglich | boolean | no | |
nachweise | array of enum | no | |
ausstattung | array of string | no | |
hausregeln | string · nullable | no | |
stornoregel | enum | no | One of: strikt, flexibel |
aktiv | boolean | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
vermietungWohnungen.anlegen
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
| Field | Type | Required | Notes |
|---|---|---|---|
hausId | string | yes | |
roomName | string | yes | |
kuerzel | string | yes | |
titelDe | string | yes | |
titelEn | string | yes | |
monatsmieteCents | integer | yes | |
beschreibungDe | string · nullable | no | |
beschreibungEn | string · nullable | no | |
flaecheQm | number · nullable | no | |
maxPersonen | integer | no | |
minMonate | integer | no | |
maxMonate | integer · nullable | no | |
kautionCents | integer | no | |
endreinigungCents | integer | no | |
nebenkosten | object | no | |
anmeldungMoeglich | boolean | no | |
nachweise | array of enum | no | |
ausstattung | array of string | no | |
hausregeln | string · nullable | no | |
stornoregel | enum | no | One of: strikt, flexibel |
aktiv | boolean | no |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
vermietungWohnungen.bildEntfernen
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
| Field | Type | Required | Notes |
|---|---|---|---|
bildId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
vermietungWohnungen.bildReihenfolge
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
| Field | Type | Required | Notes |
|---|---|---|---|
wohnungId | string | yes | |
bildIds | array of string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
ok | literal | yes | One of: true |
vermietungWohnungen.exportTokenErneuern
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
exportAdresse | string | yes |
vermietungWohnungen.holen
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
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
hausId | string | yes | |
roomId | string | yes | |
roomName | string | yes | |
kuerzel | string | yes | |
titelDe | string | yes | |
titelEn | string | yes | |
beschreibungDe | string · nullable | yes | |
beschreibungEn | string · nullable | yes | |
flaecheQm | number · nullable | yes | |
maxPersonen | integer | yes | |
monatsmieteCents | integer | yes | |
minMonate | integer | yes | |
maxMonate | integer · nullable | yes | |
kautionCents | integer | yes | |
endreinigungCents | integer | yes | |
nebenkosten | object | yes | |
nebenkosten.strom | enum | object | no | |
nebenkosten.wasser | enum | object | no | |
nebenkosten.heizung | enum | object | no | |
nebenkosten.internet | enum | object | no | |
anmeldungMoeglich | boolean | yes | |
nachweise | array of enum | yes | |
ausstattung | array of string | yes | |
hausregeln | string · nullable | yes | |
stornoregel | enum | yes | One of: strikt, flexibel |
aktiv | boolean | yes | |
createdAt | string | yes | |
updatedAt | string | yes | |
exportAdresse | string | yes | |
haQuelle | object · nullable | yes | |
haQuelle.url | string | yes | |
haQuelle.letzterErfolg | string · nullable | yes | |
haQuelle.letzterFehler | string · nullable | yes | |
bilder | array of object | yes | |
bilder.id | string | yes | |
bilder.src | string | yes | |
bilder.reihenfolge | integer | yes |
vermietungWohnungen.liste
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:
| Field | Type | Required | Notes |
|---|---|---|---|
id | string | yes | |
kuerzel | string | yes | |
titel | string | yes | |
hausName | string | yes | |
monatsmieteCents | integer | yes | |
aktiv | boolean | yes | |
freiAb | string · nullable | yes |