Rettungssimulator / ReSi-Community

Repository mit Wiki zu APIs und Sockets, zum Melden von technischen Fehlern und anfragen von neuen technischen Features auf https://rettungssimulator.online
https://rettungssimulator.online
5 stars 0 forks source link

API: /buildings #3

Closed TheKeineAhnung closed 2 years ago

TheKeineAhnung commented 3 years ago

API Request

Endpunkt Name /api/buildings

Funktionsbeschreibung Rückgabe von Informationsdaten von Gebäuden

Nutzen des Endpunkts Nutzung der Daten in meinem Script zum Gebäude zählen. Würde mir das manuelle ergänzen von Gebäuden nach Update sparen. Generell auch mit den Informationen in anderen Scripten nutzbar.

Anfrage Parameter

Antwort Daten

1 -> buildingType des Gebäudes departmentName -> Name der im Shop angezeigt wird organizationName -> Name der Organisation der der Wache angehört organizationID -> Id der Organisation der die Wache angehört maxLevel -> Maximale Ausbaustufe defaultPersonal -> Standardmäßige Anzahl an Personal auf der Wache defaultMuenzen -> Standardkosten (Münzen) defaultMarken -> Standardkosten (Marken) description -> Beschreibung die im Shop angezeigt wird markerName -> Name des Markers der auf der Karte verwendet wird buildingCategory -> Kategorie des Gebäudes (school/department/controlCenter) generates -> Lässt das Gebäude Einsätze generieren?

Welche Daten erhälst du als Antwort?

{
  1: {
    "departmentName": "Feuerwache",
    "organizationName": "Feuerwehr",
    "organizationID": 1,
    "maxLevel": 10,
    "defaultPersonal": 12,
    "defaultMuenzen": 75000,
    "defaultMarken": 50,
    "description": "Stellplatz für Feuerwehrfahrzeuge",
    "markerName": "fireDepartment",
    "buildingCategory": "department",
    "generates": true
  }
}
LennardTFD commented 2 years ago
[
  {
    "buildingID"       : int,
    "buildingName"     : string,
    "buildingCategory" : string,
    "description"      : string,
    "organisationID"   : int,
    "organisationName" : string,
    "defaultPersonal"  : int,
    "defaultMuenzen"   : int,
    "defaultMarken"    : int,
    "maxLevel"         : int,
    "markerName"       : string,
    "canGenerate"      : bool
  }
]

Dies wird die zu erwartende Struktur sein. Ebenfalls wird es möglich sein bestimme BuildingIDs optional direkt anzusprechen /api/buildings/{buildingID}.