| GET | /Customers |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerAddress:
address_guid: Optional[str] = None
is_primary: bool = False
address_kind_label: Optional[str] = None
address_kind_typ: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CustomerObjekt:
guid: Optional[str] = None
range_from: datetime.datetime = datetime.datetime(1, 1, 1)
range_to: Optional[datetime.datetime] = None
is_customer: bool = False
is_owner: bool = False
is_owner_pseudo: bool = False
objekt_guid: Optional[str] = None
customer_guid: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer:
guid: Optional[str] = None
name1: Optional[str] = None
name2: Optional[str] = None
name3: Optional[str] = None
number: Optional[str] = None
salutation: Optional[str] = None
customer_addresses: Optional[List[CustomerAddress]] = None
customer_objekte: Optional[List[CustomerObjekt]] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomersResponse:
customers: Optional[List[Customer]] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GetCustomers(IHasBearerToken):
# @ApiMember(IsRequired=true, ParameterType="query")
bearer_token: Optional[str] = None
# @ApiMember(ParameterType="query")
include: Optional[str] = None
# @ApiMember(Description="Optional! Follow the format : /api/v1/Customers?filter[Number]=*", ParameterType="query")
filter_by_number: Optional[str] = None
"""
Optional! Follow the format : /api/v1/Customers?filter[Number]=*
"""
# @ApiMember(Description="Optional! Follow the format : /api/v1/Customers?filter[ObjektGuid]=*", ParameterType="query")
filter_objekt_guid: Optional[str] = None
"""
Optional! Follow the format : /api/v1/Customers?filter[ObjektGuid]=*
"""
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /Customers HTTP/1.1 Host: brendle-schneider-servdesk.eras-online.de Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"kunden":[{"Guid":"String","Name1":"String","Name2":"String","Name3":"String","Kundennummer":"String","Anrede":"String","KundenAdressen":[{"AdresseGuid":"String","IstPrimaer":false,"AdressTypBezeichnung":"String","AdressTyp":"String"}],"KundenObjekte":[{"Guid":"String","ZeitraumVon":"0001-01-01T00:00:00.0000000Z","ZeitraumBis":"0001-01-01T00:00:00.0000000Z","IstKunde":false,"IstEigentümer":false,"IstEigentümerPseudo":false,"ObjektGuid":"String","KundeGuid":"String"}]}],"objekte":[{"Guid":"String","Objektnummer":"String","IstAbgeschlossen":"String","Uvi":"String","IsUviDisabled":"String","AbgeschlossenDatum":"0001-01-01T00:00:00.0000000Z","AdressGuid":"String","AnmerkungKundenportal":"String","KundenportalMarkedDone":false,"MarkedDoneAt":"0001-01-01T00:00:00.0000000Z"}],"addressen":[{"Guid":"String","Straße":"String","Straße2":"String","Hausnummer":"String","Postleitzahl":"String","Ort":"String","Postfach":"String","Adresszusatz":"String"}],"nutzer":[{"Guid":"String","Name1":"String","Name2":"String","Name3":"String","Name4":"String","NutzerType":"String","NutzeinheitNummerExtern":"String","NutzerInNutzeinheitReihenfolge":0,"ZeitraumVon":"0001-01-01T00:00:00.0000000Z","ZeitraumBis":"0001-01-01T00:00:00.0000000Z","IstGeloescht":false,"IstErzeugtVonApp":false,"Uvi":"String","EigentuemerBewohnt":"String","Email":"String","Mobil":"String","Titel":"String","Anrede":"String","NutzeinheitGuid":"String"}],"nutzerCoownership":[{"Guid":"String","ShareValue":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","NutzerGuid":"String","IsCreatedByApp":false,"IsDeleted":false}],"nutzerPersonen":[{"Guid":"String","Personen":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","NutzerGuid":"String","IsCreatedByApp":false,"IsDeleted":false}],"nutzerQuadratmeter":[{"Guid":"String","Quadratmeter_Hzg":0,"Quadratmeter_Ww":0,"Quadratmeter_Nk":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","NutzerGuid":"String","IsCreatedByApp":false,"IsDeleted":false}],"eigentuemerNutzeinheit":[{"Guid":"String","Name1":"String","Name2":"String","Name3":"String","Name4":"String","ZeitraumVon":"0001-01-01T00:00:00.0000000Z","ZeitraumBis":"0001-01-01T00:00:00.0000000Z","Titel":"String","Anrede":"String","AdressGuid":"String","NutzeinheitGuid":"String"}],"nutzeinheiten":[{"Guid":"String","Nummer":"String","Lage":"String","ObjektGuid":"String","AdressGuid":"String"}],"direktkosten":[{"Guid":"String","Bezeichnung":"String","Datum":"0001-01-01T00:00:00.0000000Z","Brutto":0,"Mwst":0,"Menge":0,"Typ":"String","IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","NutzerGuid":"String","BillingInformationGuid":"String"}],"prepayments":[{"Guid":"String","Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","VZ Nebenkosten":0,"VZ Heizkosten":0,"VZ Warmwasser":0,"IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","NutzerGuid":"String","BillingInformationGuid":"String"}],"energieVerwerter":[{"Guid":"String","Bezeichnung":"String","Wirkungsgrad":0,"Einbau":"0001-01-01T00:00:00.0000000Z","Ausbau":"0001-01-01T00:00:00.0000000Z","Baujahr":0,"Temperatur":0,"EigenstGewerbLieferung":false,"Brennwert":false,"ObjektGuid":"String","BrennstoffMediumGuid":"String"}],"brennstofflieferungen":[{"Guid":"String","Lieferdatum":"0001-01-01T00:00:00.0000000Z","Mwst":0,"Emissionsangabe":0,"Steuern":0,"Zolle":0,"SonstigeAngaben":0,"C02Preis":0,"C02Tonnen":0,"Menge":0,"Betrag":0,"Anfangsstand":0,"Endstand":0,"Heizwert":0,"Brennwert":false,"IstGeloescht":false,"IstErzeugtVonApp":false,"EnergieEntlastungsbetragBezeichnung":"String","EnergieEntlastungsbetrag":0,"StromEntlastungsbetragBezeichnung":"String","StromEntlastungsbetrag":0,"CO2Emissionsfaktor":0,"CO2Text":"String","CO2Aktiv":false,"CO2PreisKnd":false,"CO2PreisVermieter":0,"CO2PreisMieter":0,"CO2Flaeche":0,"GewerblicheNutzung":false,"Sanierungsauflagen":false,"AuflagenHeizungsverbesserung":false,"CO2KWH":0,"EnthalteneMwst":0,"CO2KostenBrutto":0,"CO2GesamtKg":0,"KeinGesamtabzugC02Kosten":false,"EnergieVerwerterGuid":"String","BrennstoffMediumGuid":"String","BillingInformationGuid":"String"}],"nebenkosten":[{"Guid":"String","Kostennummer":0,"Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","UmlageZiel":"String","UmlageZielIn":"String","NebenkostenArt":"String","Kostenart":"String","Brutto":0,"BruttoLetztesJahr":0,"Mwst":0,"HaushaltsnahediensteLabel":"String","HaushaltsnahediensteBrutto":0,"EinheitDerKostenart":"String","Reduzierungsart":"String","Kommentar":"String","IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","BillingInformationGuid":"String","NebenkostenNutzeinheiten":[{"Anteil":0,"IstGeloescht":false,"IstErzeugtVonApp":false,"NutzeinheitGuid":"String"}],"NebenkostenNutzer":[{"Anteil":0,"IstGeloescht":false,"IstErzeugtVonApp":false,"NutzerGuid":"String"}]}],"heizbetriebskosten":[{"Guid":"String","Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","Mwst":0,"HaushatlsnahediensteBrutto":0,"Brutto":0,"HaushatlsnahediensteLabel":"String","Anmerkung":"String","IstGeloescht":false,"IstErzeugtVonApp":false,"ObjektGuid":"String","BillingInformationGuid":"String"}],"nutzeinheitDevices":[{"Guid":"String","ZuordnungVon":"0001-01-01T00:00:00.0000000Z","ZuordnungBis":"0001-01-01T00:00:00.0000000Z","Raum":"String","LaufendeNummer":"String","gemietet":false,"gewartet":false,"DeviceGuid":"String","NutzeinheitGuid":"String"}],"devices":[{"Guid":"String","Geraetenummer":"String","Bezeichnung":"String","Beschreibung":"String","Einbaudatum":"0001-01-01T00:00:00.0000000Z","Ausbaudatum":"0001-01-01T00:00:00.0000000Z","Eichdatum":"0001-01-01T00:00:00.0000000Z","Einheit":"String","Memo":"String","DeviceCatalogGuid":"String"}],"deviceConsumptions":[{"Guid":"String","Ablesung":0,"Ablesedatum":"0001-01-01T00:00:00.0000000Z","Ableseart":"String","Aenderungsdatum":"0001-01-01T00:00:00.0000000Z","Anmerkung":"String","Ampullenfarbe":"String","DeviceGuid":"String"}],"billingInformation":[{"Guid":"String","Von":"0001-01-01T00:00:00.0000000Z","Bis":"0001-01-01T00:00:00.0000000Z","IstAbgeschlossen":false,"HatNebenkosten":false,"ObjektGuid":"String","AnmerkungKundenportal":"String","KundenportalMarkedDone":false,"MarkedDoneAt":"0001-01-01T00:00:00.0000000Z","KundenportalMarkedClosed":false,"MarkedClosedAt":"0001-01-01T00:00:00.0000000Z"}],"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}