Projekt Anlegen - Schnittstelle

Diese Funktion ist im Beta Stadium und kann mit Hilfe des Support über Chat eingerichtet werden.

Einleitung
In diesem Artikel wird erklärt, wie du über eine externe Schnittstelle ein Projekt anlegen kannst, zum Beispiel von deiner Webseite.

Hauptteil

Definition: Die externe Schnittstelle ermöglicht es, nach Angabe von von Daten zum Gebäude und Kunden, ein Projekt in der Grundsteine Software anzulegen.
Kontext: Die Software muss nicht geöffnet werden, um dieses Projekt anzulegen.

Lösungsschritte

POST Request

Um ein Projekt anzulegen, muss ein POST request an einen Endpunkt geschickt werden.

Den Endpunkt und den Token erhältst du vom Support.

POST https://eba-api.azurewebsites.net/ENDPUNKT?token=MEIN_TOKEN
content-type: application/json

{
  "data": {
    "reference": "PROJEKTNUMMER",
    "note": "PROJEKTNOTIZ"
    "state": "ACTIVE"
   "templateId": "ID_DER_VORLAGE"
    "building": {
      "yearOfCompletion": "1983",
      "numberOfPartiesInBuilding": "4",
      "numberOfFloors": "3",
      "address": {
        "zip": "12045",
        "city": "Berlin",
        "street": "Fuldastraße",
        "houseNumber": "13"
      }
    },
    "client": {
      "email": "muster@mensch.de",
      "firstName": "Marin",
      "lastName": "Mensch",
      "phone": "0176555444",
      "type": "WEG",
      "companyName":"Fuldastraße 13 Berlin",
      "representedBy": "HV Muster",
      "type": "WEG",
      "salutation": "",
      "title": "",
      "address": {
        "zip": "11111",
        "city": "CITY",
        "street": "STREET",
        "houseNumber": "1"
      }
    }
  }
}

Weitere Informationen:

Folgende Werte sind für state möglich:
ACTIVE - aktiv
ARCHIVED - archiviert
CANCELED - abgebrochen

Folgende Werte sind für client.type möglich:
PERSON - Person
COMPANY - Firma
WEG - Wohnungseigentümergemeinschaft

lastName muss immer gesetzt sein.

Die ID_DER_VORLAGE findest du in der Adressezeile des Browsers, wenn du die Vorlage öffnest:
https://grundstein.app/projects/ 5095bb11-481c-497b-abc9-44116e020e34 /overview

Aktualisiert am: 18/11/2024