vermietungBelegung.haAbrufen
Pulls the active HousingAnywhere source of an apartment fresh and takes over its occupancy; if the last pull was less than 60 seconds ago, it does not pull again but reports the stored state. Returns status (aktuell, zuletzt_gueltig, unbekannt, keine_quelle), letzterErfolg and fehler. 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 |
|---|---|---|---|
wohnungId | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
status | enum | yes | One of: aktuell, zuletzt_gueltig, unbekannt, keine_quelle |
letzterErfolg | string · nullable | yes | |
fehler | string · nullable | yes |
vermietungBelegung.haQuelleSetzen
Sets the HousingAnywhere calendar address of an apartment (url, exactly the form https://housinganywhere.com/api/v2/listing/<digits>/calendar/<secret>/<language>; anything else results in BAD_REQUEST) and pulls it immediately. The previous source is switched off (at most one stays active) and its upcoming imported stays are cancelled; url null only switches off. An address still active on another apartment results in CONFLICT. If the pull fails, the source stays saved and haAbruf names the error. Returns haAbruf. 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 |
|---|---|---|---|
wohnungId | string | yes | |
url | string · nullable | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
haAbruf | object | yes | |
haAbruf.status | enum | yes | One of: aktuell, zuletzt_gueltig, unbekannt, keine_quelle |
haAbruf.letzterErfolg | string · nullable | yes | |
haAbruf.fehler | string · nullable | yes |
vermietungBelegung.sperreEntfernen
Lifts the own blocks of an apartment from von to bis (both inclusive) and returns the number of nights released. Nights of tenancies and blocks with a different reason stay untouched. An apartment of another tenant results in NOT_FOUND. Owner of a rental tenant only. Deletes data. Mutation — changes data.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
wohnungId | string | yes | |
von | string | yes | |
bis | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
naechte | integer | yes |
vermietungBelegung.sperreSetzen
Blocks an apartment from von to bis (both inclusive, YYYY-MM-DD) with a reason (at most 120 characters, one line) and returns the number of blocked nights. If even one night is already occupied (tenancy, HousingAnywhere import or another block), the result is CONFLICT and nothing is blocked; von after bis results in BAD_REQUEST, as does a block longer than three years; 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 |
|---|---|---|---|
wohnungId | string | yes | |
von | string | yes | |
bis | string | yes | |
grund | string | yes |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
naechte | integer | yes |
vermietungBelegung.uebersicht
The occupancy of all apartments from today (Berlin) for 12 or 24 months (monate): per apartment wohnungId, kuerzel, titel and the occupancy as ranges from von to bisExklusiv (the day the apartment is free again) with the source: mietverhaeltnis, import (HousingAnywhere calendar, label = platform), sperre (own block, label = reason) or sonstige. Owner of a rental tenant only. Read-only query.
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
monate | literal | yes |
Output fields
Returns array of object. Fields of each element:
| Field | Type | Required | Notes |
|---|---|---|---|
wohnungId | string | yes | |
kuerzel | string | yes | |
titel | string | yes | |
belegung | array of object | yes | |
belegung.von | string | yes | |
belegung.bisExklusiv | string | yes | |
belegung.quelle | enum | yes | One of: mietverhaeltnis, import, sperre, sonstige |
belegung.etikett | string · nullable | yes |