Server

<back to all web services

GetCustomers

Requires Authentication
The following routes are available for this service:
GET/Customers
import 'package:servicestack/servicestack.dart';
import 'dart:typed_data';

// @DataContract
class CustomerAddress implements IConvertible
{
    // @DataMember(Name="AdresseGuid")
    String? AdresseGuid;

    // @DataMember(Name="IstPrimaer")
    bool? IstPrimaer;

    // @DataMember(Name="AdressTypBezeichnung")
    String? AdressTypBezeichnung;

    // @DataMember(Name="AdressTyp")
    String? AdressTyp;

    CustomerAddress({this.AdresseGuid,this.IstPrimaer,this.AdressTypBezeichnung,this.AdressTyp});
    CustomerAddress.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        AdresseGuid = json['addressGuid'];
        IstPrimaer = json['isPrimary'];
        AdressTypBezeichnung = json['addressKindLabel'];
        AdressTyp = json['addressKindTyp'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'adresseGuid': AdresseGuid,
        'istPrimaer': IstPrimaer,
        'adressTypBezeichnung': AdressTypBezeichnung,
        'adressTyp': AdressTyp
    };

    getTypeName() => "CustomerAddress";
    TypeContext? context = _ctx;
}

// @DataContract
class CustomerObjekt implements IConvertible
{
    // @DataMember(Name="Guid")
    String? Guid;

    // @DataMember(Name="ZeitraumVon")
    DateTime? ZeitraumVon;

    // @DataMember(Name="ZeitraumBis")
    DateTime? ZeitraumBis;

    // @DataMember(Name="IstKunde")
    bool? IstKunde;

    // @DataMember(Name="IstEigentümer")
    bool? IstEigent_mer;

    // @DataMember(Name="IstEigentümerPseudo")
    bool? IstEigent_merPseudo;

    // @DataMember(Name="ObjektGuid")
    String? ObjektGuid;

    // @DataMember(Name="KundeGuid")
    String? KundeGuid;

    CustomerObjekt({this.Guid,this.ZeitraumVon,this.ZeitraumBis,this.IstKunde,this.IstEigent_mer,this.IstEigent_merPseudo,this.ObjektGuid,this.KundeGuid});
    CustomerObjekt.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Guid = json['guid'];
        ZeitraumVon = JsonConverters.fromJson(json['rangeFrom'],'DateTime',context!);
        ZeitraumBis = JsonConverters.fromJson(json['rangeTo'],'DateTime',context!);
        IstKunde = json['isCustomer'];
        IstEigent_mer = json['isOwner'];
        IstEigent_merPseudo = json['isOwnerPseudo'];
        ObjektGuid = json['objektGuid'];
        KundeGuid = json['customerGuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': Guid,
        'zeitraumVon': JsonConverters.toJson(ZeitraumVon,'DateTime',context!),
        'zeitraumBis': JsonConverters.toJson(ZeitraumBis,'DateTime',context!),
        'istKunde': IstKunde,
        'istEigent_mer': IstEigent_mer,
        'istEigent_merPseudo': IstEigent_merPseudo,
        'objektGuid': ObjektGuid,
        'kundeGuid': KundeGuid
    };

    getTypeName() => "CustomerObjekt";
    TypeContext? context = _ctx;
}

// @DataContract
class Customer implements IConvertible
{
    // @DataMember(Name="Guid")
    String? Guid;

    // @DataMember(Name="Name1")
    String? Name1;

    // @DataMember(Name="Name2")
    String? Name2;

    // @DataMember(Name="Name3")
    String? Name3;

    // @DataMember(Name="Kundennummer")
    String? Kundennummer;

    // @DataMember(Name="Anrede")
    String? Anrede;

    // @DataMember(Name="KundenAdressen")
    List<CustomerAddress>? KundenAdressen;

    // @DataMember(Name="KundenObjekte")
    List<CustomerObjekt>? KundenObjekte;

    Customer({this.Guid,this.Name1,this.Name2,this.Name3,this.Kundennummer,this.Anrede,this.KundenAdressen,this.KundenObjekte});
    Customer.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Guid = json['guid'];
        Name1 = json['name1'];
        Name2 = json['name2'];
        Name3 = json['name3'];
        Kundennummer = json['number'];
        Anrede = json['salutation'];
        KundenAdressen = JsonConverters.fromJson(json['customerAddresses'],'List<CustomerAddress>',context!);
        KundenObjekte = JsonConverters.fromJson(json['customerObjekte'],'List<CustomerObjekt>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'guid': Guid,
        'name1': Name1,
        'name2': Name2,
        'name3': Name3,
        'kundennummer': Kundennummer,
        'anrede': Anrede,
        'kundenAdressen': JsonConverters.toJson(KundenAdressen,'List<CustomerAddress>',context!),
        'kundenObjekte': JsonConverters.toJson(KundenObjekte,'List<CustomerObjekt>',context!)
    };

    getTypeName() => "Customer";
    TypeContext? context = _ctx;
}

class GetCustomersResponse implements IConvertible
{
    List<Customer>? customers;
    ResponseStatus? responseStatus;

    GetCustomersResponse({this.customers,this.responseStatus});
    GetCustomersResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        customers = JsonConverters.fromJson(json['customers'],'List<Customer>',context!);
        responseStatus = JsonConverters.fromJson(json['responseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'customers': JsonConverters.toJson(customers,'List<Customer>',context!),
        'responseStatus': JsonConverters.toJson(responseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "GetCustomersResponse";
    TypeContext? context = _ctx;
}

class GetCustomers implements IHasBearerToken, IConvertible
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    String? bearerToken;

    // @ApiMember(ParameterType="query")
    String? include;

    /**
    * Optional! Follow the format : /api/v1/Customers?filter[Number]=*
    */
    // @DataMember(Name="filter[Number]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/Customers?filter[Number]=*", ParameterType="query")
    String? filter_Number_;

    /**
    * Optional! Follow the format : /api/v1/Customers?filter[ObjektGuid]=*
    */
    // @DataMember(Name="filter[ObjektGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/Customers?filter[ObjektGuid]=*", ParameterType="query")
    String? filter_ObjektGuid_;

    GetCustomers({this.bearerToken,this.include,this.filter_Number_,this.filter_ObjektGuid_});
    GetCustomers.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        bearerToken = json['bearerToken'];
        include = json['include'];
        filter_Number_ = json['filterByNumber'];
        filter_ObjektGuid_ = json['filterObjektGuid'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'bearerToken': bearerToken,
        'include': include,
        'filter_Number_': filter_Number_,
        'filter_ObjektGuid_': filter_ObjektGuid_
    };

    getTypeName() => "GetCustomers";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'depolt_servdesk.eras_online.de', types: <String, TypeInfo> {
    'CustomerAddress': TypeInfo(TypeOf.Class, create:() => CustomerAddress()),
    'CustomerObjekt': TypeInfo(TypeOf.Class, create:() => CustomerObjekt()),
    'Customer': TypeInfo(TypeOf.Class, create:() => Customer()),
    'List<CustomerAddress>': TypeInfo(TypeOf.Class, create:() => <CustomerAddress>[]),
    'List<CustomerObjekt>': TypeInfo(TypeOf.Class, create:() => <CustomerObjekt>[]),
    'GetCustomersResponse': TypeInfo(TypeOf.Class, create:() => GetCustomersResponse()),
    'List<Customer>': TypeInfo(TypeOf.Class, create:() => <Customer>[]),
    'GetCustomers': TypeInfo(TypeOf.Class, create:() => GetCustomers()),
});

Dart GetCustomers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /Customers HTTP/1.1 
Host: depolt-servdesk.eras-online.de 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}