AthausDoku

REST-API: Länderprofile

Der Kern der API ist für jedes Land derselbe. Was je Land abweicht, steht in einem Profil. Deutschland ist das erste.

Zuletzt aktualisiert:

Die API hat einen Kern und ein Profil je Land. Der Kern ist überall derselbe: die Form eines Inserats, die Ids, die Fehler, das Blättern. Ein Länderprofil ergänzt, was das Recht oder der Markt dieses Landes braucht. Im Kern kommt kein Land vor.

Ein Profil trägt vier Dinge:

TeilDeutschland (de)
StandardwährungEUR
Einheit der FlächenSQUARE_METER
Angaben, die ein Inserat zur Veröffentlichung brauchtder Energieausweis oder die Aussage, dass keiner vorliegt oder nötig ist
Der Abschnitt countrySpecific, den es besitztde, mit den Energieausweisen unter data.energy.countrySpecific.de

Deutschland ist heute das einzige Profil. Weitere Länder kommen als weitere Profile, der Kern ändert sich dafür nicht. GET /v1/me nennt die Profile deines Büros unter profiles.

Ein Beispiel: der Energieausweis

Ein deutsches Wohninserat nennt seinen Energieausweis in data.energy.countrySpecific.de.energyCertificates. Das ist das Mitglied energy eines Inserats:

{
  "countrySpecific": {
    "de": {
      "energyCertificates": [
        {
          "certificateType": "ENEV2014",
          "certificateBasedOn": "CONSUMPTION",
          "efficiencyClass": "C",
          "validUntil": "2031-05-31",
          "yearOfConstructionBuilding": 1998,
          "primaryEnergySource": "GAS"
        }
      ]
    }
  }
}

Ein Entwurf darf ihn weglassen. Ein Inserat ohne ihn und ohne die Aussage NOT_AVAILABLE, NOT_NECESSARY oder AT_VISIT als certificateType lässt sich nicht veröffentlichen.

Was ein Profil bestimmt

  • Währung und Einheit. data.prices.currency hat als Vorgabe die Währung des Profils, und data.spaces.spaceMeasureUnit ist die Einheit des Profils. Beides sind Mitglieder des Standards, wer sie ausdrücklich schickt, hängt also nie vom Profil ab.
  • Pflichtangaben. Was ein veröffentlichtes Inserat nennen muss, ist eine Regel des Profils. Ein Entwurf wird davon nie aufgehalten.
  • Zusätzliche Daten. Der Standard hält seine Abschnitte countrySpecific für Mitglieder, die er nicht definiert, geschlossen. Athaus schickt die deutschen Zusätze in userDefined mit dem Präfix de.:
NameInhalt
de.livingSpaceStandarddie Berechnungsgrundlage der Wohnfläche: WOFLV, DIN_277 oder UNKNOWN
de.usableSpaceStandarddasselbe für die Nutzfläche
de.siteCoverageRatioder Anteil des Grundstücks, der überbaut werden darf
de.floorAreaRatiodie Geschossfläche je Grundstücksfläche
de.developmentStateder Entwicklungszustand eines Grundstücks, zum Beispiel BUILDING_READY

Ein Land ohne Profil

Eine Anfrage mit einem Abschnitt countrySpecific für ein Land, das kein Profil hat, wird mit 400 und dem Code profile_unsupported beantwortet. Es wird nichts geschrieben. Lass den Abschnitt weg oder frag nach dem Land.

Eine Anfrage trägt die deutsche Angabe zum Wohnberechtigungsschein in seeker.countrySpecific.de.hasSubsidizedHousingCertificate, auf dieselbe Weise.

Weiter lesen

Auf dieser Seite