innoconnect / Basis
Übersicht
- Adresse
- Aktivitaet
- AktivitaetBeteiligte
- AktivitaetGenerieren
- AktivitaetNachricht
- AktivitaetProjekt
- AktivitaetVorlage
- Anfragesteller
- Anlage
- Anlagetrezuord
- AnlagetrezuordWS
- Anlagetyp
- Briefanrede
- DeleteAktivitaet
- Dokumentreferenz
- DublettenCheck
- Einmaladresse
- Gemeinde
- Gruppenzuord
- InsertAktivitaetFristverlaengerung
- Kommunikation
- Orgeinheit
- Ort
- Projekt
- Projektmanagement
- ProjektParam
- ProjektParamRolle
- ProjektRolle
- ProjektRollezuord
- Standort
- Strasse
- Subjekt
- SubjektAnschrift
- SubjektKontaktperson
- SubjektRolle
- Subjektzuord
- UebergeordneteSubjektzuord
- Versand
- Verwendungrolle
-
Adresse
Das Objekt Adresse unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/adresse Suchen nach Adresse Objekten. GET basis/adresse/{id} Gibt das Adresse Objekt mit dem entsprechenden Schlüssel zurück. POST basis/adresse Erstellt ein neues Adresse Objekt mit den übergebenen Werten. PUT basis/adresse/{id} Aktualisiert das Adresse Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/adresse
Suchen nach Adresse Objekten.
Parameters
Name Default Beschreibung ID_Subjekt *required
Int32
(query)ID_Subjekt. ID_Adresse
Int32
(query)ID_Adresse. ID_Objekt
Int32
(query)ID_Objekt. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung LaufNr_Adresse
Int16Adressart
Int32Adresse.AdressArt Adresse
String
nullableOrt
String
nullablePostfach
Int32
nullableAdresse.Postfachtext GueltigVon
DateTimeGueltigBis
DateTime
nullableNotiz
Int32AdressZusatz
String
nullableProvisorisch
Int32ID_Subjekt
Int32ID_Adresse
Int32StrasseZusatz
String
nullableAdressartBezeichnung
String
nullablePostleitzahlZusatzziffer
String
nullable -
GET basis/adresse/{id}
Gibt das Adresse Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Adresse. Response
Name Herkunft Beschreibung Adressart
Int32Adresse.Adressart Strasse
String
nullableAdressZusatz
String
nullableID_Objekt
Int32
nullableStrasseZusatz
String
nullablePostleitzahl
String
nullableID_Ort
Int32Ortsname
StringGueltigVon
DateTimeID_Subjekt
Int32Postfachtext
Int32
nullableAdresse.Postfachtext Postfach_StrasseAdressieren
Int32Postfach_Ortsname
String
nullablePostfach_ID_Ort
Int32
nullablePostfach_Postleitzahl
String
nullableStrassezusatzNachStrasse
Int32Notiz
String
nullablePostfach
Int32
nullableWohnungsNr
String
nullableHausNrZusatz
String
nullableHausNr
Int32
nullableGueltigBis
DateTime
nullableID_Adresse
Int32Provisorisch
Int32PostleitzahlZusatzziffer
String
nullableNation
String
nullableNation_ISOCode
String
nullablePostfach_Nation
String
nullablePostfach_Nation_ISOCode
String
nullable -
POST basis/adresse
Erstellt ein neues Adresse Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Adressart *required
Int32
(body)Strasse
String
(body)AdressZusatz
String
(body)ID_Objekt
Int32
(body)StrasseZusatz
String
(body)Postleitzahl
String
(body)ID_Ort *required
Int32
(body)Ortsname *required
String
(body)GueltigVon *required
DateTime
(body)ID_Subjekt *required
Int32
(body)Postfachtext
Int32
(body)Postfach_StrasseAdressieren *required
Int32
(body)Postfach_Ortsname
String
(body)Postfach_ID_Ort
Int32
(body)Postfach_Postleitzahl
String
(body)StrassezusatzNachStrasse *required
Int32
(body)Notiz
String
(body)Postfach
Int32
(body)WohnungsNr
String
(body)HausNrZusatz
String
(body)HausNr
Int32
(body)GueltigBis
DateTime
(body)Provisorisch *required
Int32
(body)PostleitzahlZusatzziffer
String
(body)Nation
String
(body)Nation_ISOCode
String
(body)Postfach_Nation
String
(body)Postfach_Nation_ISOCode
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung Adressart
Int32Adresse.Adressart Strasse
String
nullableAdressZusatz
String
nullableID_Objekt
Int32
nullableStrasseZusatz
String
nullablePostleitzahl
String
nullableID_Ort
Int32Ortsname
StringGueltigVon
DateTimeID_Subjekt
Int32Postfachtext
Int32
nullableAdresse.Postfachtext Postfach_StrasseAdressieren
Int32Postfach_Ortsname
String
nullablePostfach_ID_Ort
Int32
nullablePostfach_Postleitzahl
String
nullableStrassezusatzNachStrasse
Int32Notiz
String
nullablePostfach
Int32
nullableWohnungsNr
String
nullableHausNrZusatz
String
nullableHausNr
Int32
nullableGueltigBis
DateTime
nullableID_Adresse
Int32Provisorisch
Int32PostleitzahlZusatzziffer
String
nullableNation
String
nullableNation_ISOCode
String
nullablePostfach_Nation
String
nullablePostfach_Nation_ISOCode
String
nullable -
PUT basis/adresse/{id}
Aktualisiert das Adresse Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Adresse. Adressart *required
Int32
(body)Strasse
String
(body)AdressZusatz
String
(body)ID_Objekt
Int32
(body)StrasseZusatz
String
(body)Postleitzahl
String
(body)ID_Ort *required
Int32
(body)Ortsname *required
String
(body)GueltigVon *required
DateTime
(body)ID_Subjekt *required
Int32
(body)Postfachtext
Int32
(body)Postfach_StrasseAdressieren *required
Int32
(body)Postfach_Ortsname
String
(body)Postfach_ID_Ort
Int32
(body)Postfach_Postleitzahl
String
(body)StrassezusatzNachStrasse *required
Int32
(body)Notiz
String
(body)Postfach
Int32
(body)WohnungsNr
String
(body)HausNrZusatz
String
(body)HausNr
Int32
(body)GueltigBis
DateTime
(body)Provisorisch *required
Int32
(body)PostleitzahlZusatzziffer
String
(body)Nation
String
(body)Nation_ISOCode
String
(body)Postfach_Nation
String
(body)Postfach_Nation_ISOCode
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung Adressart
Int32Adresse.Adressart Strasse
String
nullableAdressZusatz
String
nullableID_Objekt
Int32
nullableStrasseZusatz
String
nullablePostleitzahl
String
nullableID_Ort
Int32Ortsname
StringGueltigVon
DateTimeID_Subjekt
Int32Postfachtext
Int32
nullableAdresse.Postfachtext Postfach_StrasseAdressieren
Int32Postfach_Ortsname
String
nullablePostfach_ID_Ort
Int32
nullablePostfach_Postleitzahl
String
nullableStrassezusatzNachStrasse
Int32Notiz
String
nullablePostfach
Int32
nullableWohnungsNr
String
nullableHausNrZusatz
String
nullableHausNr
Int32
nullableGueltigBis
DateTime
nullableID_Adresse
Int32Provisorisch
Int32PostleitzahlZusatzziffer
String
nullableNation
String
nullableNation_ISOCode
String
nullablePostfach_Nation
String
nullablePostfach_Nation_ISOCode
String
nullable
-
Aktivitaet
Das Objekt Aktivitaet unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/aktivitaet Suchen nach Aktivitaet Objekten. GET basis/aktivitaet/{id} Gibt das Aktivitaet Objekt mit dem entsprechenden Schlüssel zurück. POST basis/aktivitaet Erstellt ein neues Aktivitaet Objekt mit den übergebenen Werten. PUT basis/aktivitaet/{id} Aktualisiert das Aktivitaet Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/aktivitaet
Suchen nach Aktivitaet Objekten.
Parameters
Name Default Beschreibung Aktion
Int32
(query)Aktion. Enddatum
DateTime
(query)Enddatum. EnddatumOperator
String
(query)EnddatumOperator. Ergebnis
Int32
(query)Ergebnis. Erstell_ID_Orgeinheit
Int32
(query)Erstell_ID_Orgeinheit. Erstelldatum
DateTime
(query)Erstelldatum. ErstelldatumOperator
String
(query)ErstelldatumOperator. ID_Aktivitaet
Int32
(query)ID_Aktivitaet. KampagnedatenEinschliessen
Int32
(query)KampagnedatenEinschliessen. Kategorie
Int32
(query)Kategorie. Kommunikationsmittel
Int32
(query)Kommunikationsmittel. Nachricht
String
(query)Nachricht. Prioritaet
Int32
(query)Prioritaet. ReferenzNr
Int32
(query)ReferenzNr. Referenztyp
Int32
(query)Referenztyp. Startdatum
DateTime
(query)Startdatum. StartdatumOperator
String
(query)StartdatumOperator. StatusBearb
Int32
(query)StatusBearb. Statusdatum
DateTime
(query)Statusdatum. StatusErl
Int32
(query)StatusErl. StatusInfo
Int32
(query)StatusInfo. StatusOffen
Int32
(query)StatusOffen. StatusZugest
Int32
(query)StatusZugest. Thema
Int32
(query)Thema. Typ
Int32
(query)Typ. Verantwortlicher_ID_Orgeinheit
Int32
(query)Verantwortlicher_ID_Orgeinheit. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Aktivitaet
Int32Typ
Int32Aktivitaet.Typ Kommunikationsmittel
Int32
nullableAktivitaet.Kommunikationsmittel Richtung
Int32
nullableAktivitaet.Richtung Prioritaet
Int32
nullableAktivitaet.Prioritaet Verantwortlicher_ID_Orgeinheit
Int32
nullableVerantwortlicher
String
nullableReferenztyp
Int32
nullableAktivitaet.Referenztyp ReferenzNr
Int32
nullableReferenz
String
nullableThema
Int32
nullableAktivitaet.Thema Aktion
Int32
nullableAktivitaet.Aktion Ergebnis
Int32
nullableAktivitaet.KontaktErgebnis Status
Int32Aktivitaet.Status Statusdatum
DateTime
nullableErsteller
String
nullableStartzeit
DateTime
nullableEndzeit
DateTime
nullableErstelldatum
DateTimeKategorie
Int32
nullableAktivitaet.Kategorie Betreff
String
nullableID_Kampagne
Int32
nullableID_Kampagnenschritt
Int32
nullableKampagneBezeichnung
String
nullableKampagnenschrittbezeichnung
String
nullable -
GET basis/aktivitaet/{id}
Gibt das Aktivitaet Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Aktivitaet. Response
Name Herkunft Beschreibung ID_Aktivitaet
Int32Referenztyp
Int32
nullableAktivitaet.Referenztyp ReferenzNr
Int32
nullableTyp
Int32Aktivitaet.Typ Kommunikationsmittel
Int32
nullableAktivitaet.Kommunikationsmittel Thema
Int32
nullableAktivitaet.Thema Aktion
Int32
nullableAktivitaet.Aktion Ergebnis
Int32
nullableAktivitaet.KontaktErgebnis Prioritaet
Int32
nullableAktivitaet.Prioritaet Richtung
Int32
nullableAktivitaet.Richtung Status
Int32Aktivitaet.Status Betreff
String
nullableReferenzNr2
Int32
nullableErstelldatum
DateTimeKategorie
Int32
nullableAktivitaet.Kategorie Persoenlich
Int32Verantwortlicher_ID_Orgeinheit
Int32
nullableStartdatum
DateTime
nullableEnddatum
DateTime
nullableErstell_ID_Orgeinheit
Int32Statusdatum
DateTime
nullableReferenzTyp2
Int32
nullable -
POST basis/aktivitaet
Erstellt ein neues Aktivitaet Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Referenztyp
Int32
(body)ReferenzNr
Int32
(body)Typ *required
Int32
(body)Kommunikationsmittel
Int32
(body)Thema
Int32
(body)Aktion
Int32
(body)Ergebnis
Int32
(body)Prioritaet
Int32
(body)Richtung
Int32
(body)Status *required
Int32
(body)Betreff
String
(body)ReferenzNr2
Int32
(body)Erstelldatum *required
DateTime
(body)Kategorie
Int32
(body)Persoenlich *required
Int32
(body)Verantwortlicher_ID_Orgeinheit
Int32
(body)Startdatum
DateTime
(body)Enddatum
DateTime
(body)Erstell_ID_Orgeinheit *required
Int32
(body)Statusdatum
DateTime
(body)ReferenzTyp2
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Aktivitaet
Int32Referenztyp
Int32
nullableAktivitaet.Referenztyp ReferenzNr
Int32
nullableTyp
Int32Aktivitaet.Typ Kommunikationsmittel
Int32
nullableAktivitaet.Kommunikationsmittel Thema
Int32
nullableAktivitaet.Thema Aktion
Int32
nullableAktivitaet.Aktion Ergebnis
Int32
nullableAktivitaet.KontaktErgebnis Prioritaet
Int32
nullableAktivitaet.Prioritaet Richtung
Int32
nullableAktivitaet.Richtung Status
Int32Aktivitaet.Status Betreff
String
nullableReferenzNr2
Int32
nullableErstelldatum
DateTimeKategorie
Int32
nullableAktivitaet.Kategorie Persoenlich
Int32Verantwortlicher_ID_Orgeinheit
Int32
nullableStartdatum
DateTime
nullableEnddatum
DateTime
nullableErstell_ID_Orgeinheit
Int32Statusdatum
DateTime
nullableReferenzTyp2
Int32
nullable -
PUT basis/aktivitaet/{id}
Aktualisiert das Aktivitaet Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Aktivitaet. Referenztyp
Int32
(body)ReferenzNr
Int32
(body)Typ *required
Int32
(body)Kommunikationsmittel
Int32
(body)Thema
Int32
(body)Aktion
Int32
(body)Ergebnis
Int32
(body)Prioritaet
Int32
(body)Richtung
Int32
(body)Status *required
Int32
(body)Betreff
String
(body)ReferenzNr2
Int32
(body)Erstelldatum *required
DateTime
(body)Kategorie
Int32
(body)Persoenlich *required
Int32
(body)Verantwortlicher_ID_Orgeinheit
Int32
(body)Startdatum
DateTime
(body)Enddatum
DateTime
(body)Erstell_ID_Orgeinheit *required
Int32
(body)Statusdatum
DateTime
(body)ReferenzTyp2
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Aktivitaet
Int32Referenztyp
Int32
nullableAktivitaet.Referenztyp ReferenzNr
Int32
nullableTyp
Int32Aktivitaet.Typ Kommunikationsmittel
Int32
nullableAktivitaet.Kommunikationsmittel Thema
Int32
nullableAktivitaet.Thema Aktion
Int32
nullableAktivitaet.Aktion Ergebnis
Int32
nullableAktivitaet.KontaktErgebnis Prioritaet
Int32
nullableAktivitaet.Prioritaet Richtung
Int32
nullableAktivitaet.Richtung Status
Int32Aktivitaet.Status Betreff
String
nullableReferenzNr2
Int32
nullableErstelldatum
DateTimeKategorie
Int32
nullableAktivitaet.Kategorie Persoenlich
Int32Verantwortlicher_ID_Orgeinheit
Int32
nullableStartdatum
DateTime
nullableEnddatum
DateTime
nullableErstell_ID_Orgeinheit
Int32Statusdatum
DateTime
nullableReferenzTyp2
Int32
nullable
-
AktivitaetBeteiligte
Das Objekt AktivitaetBeteiligte unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/aktivitaetbeteiligte Suchen nach AktivitaetBeteiligte Objekten. GET basis/aktivitaetbeteiligte/{id} Gibt das AktivitaetBeteiligte Objekt mit dem entsprechenden Schlüssel zurück. POST basis/aktivitaetbeteiligte Erstellt ein neues AktivitaetBeteiligte Objekt mit den übergebenen Werten. PUT basis/aktivitaetbeteiligte/{id} Aktualisiert das AktivitaetBeteiligte Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/aktivitaetbeteiligte
Suchen nach AktivitaetBeteiligte Objekten.
Parameters
Name Default Beschreibung ID_Aktivitaet *required
Int32
(query)ID_Aktivitaet. ID_AktivitaetBeteiligte *required
Int32
(query)ID_AktivitaetBeteiligte. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_AktivitaetBeteiligte
Int32ID_Aktivitaet
Int32Typ
String
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullableKorrespondenzEmpfaenger
Int32Referenz
String
nullableReferenztyp
Int32
nullableSystemrolle.Referenztyp ReferenzId
Int32
nullable -
GET basis/aktivitaetbeteiligte/{id}
Gibt das AktivitaetBeteiligte Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_AktivitaetBeteiligte. Response
Name Herkunft Beschreibung ID_AktivitaetBeteiligte
Int32ID_Aktivitaet
Int32Referenztyp
Int32
nullableSystemrolle.Referenztyp Für Referenztyp 1 (Subjekt) muss ein Subjekt zurückgegeben werden, für Referenztyp 12 (Verbindung) muss eine Verbindung zurückgegeben werden, für Referenztyp 43 (Orgeinheit) muss eine Orgeinheit zurückgegeben werden ReferenzId
Int32
nullableKorrespondenzEmpfaenger
Int32
nullable -
POST basis/aktivitaetbeteiligte
Erstellt ein neues AktivitaetBeteiligte Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung ID_Aktivitaet *required
Int32
(body)Referenztyp
Int32
(body)Für Referenztyp 1 (Subjekt) muss ein Subjekt zurückgegeben werden, für Referenztyp 12 (Verbindung) muss eine Verbindung zurückgegeben werden, für Referenztyp 43 (Orgeinheit) muss eine Orgeinheit zurückgegeben werden ReferenzId
Int32
(body)KorrespondenzEmpfaenger
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_AktivitaetBeteiligte
Int32ID_Aktivitaet
Int32Referenztyp
Int32
nullableSystemrolle.Referenztyp Für Referenztyp 1 (Subjekt) muss ein Subjekt zurückgegeben werden, für Referenztyp 12 (Verbindung) muss eine Verbindung zurückgegeben werden, für Referenztyp 43 (Orgeinheit) muss eine Orgeinheit zurückgegeben werden ReferenzId
Int32
nullableKorrespondenzEmpfaenger
Int32
nullable -
PUT basis/aktivitaetbeteiligte/{id}
Aktualisiert das AktivitaetBeteiligte Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_AktivitaetBeteiligte. ID_Aktivitaet *required
Int32
(body)Referenztyp
Int32
(body)Für Referenztyp 1 (Subjekt) muss ein Subjekt zurückgegeben werden, für Referenztyp 12 (Verbindung) muss eine Verbindung zurückgegeben werden, für Referenztyp 43 (Orgeinheit) muss eine Orgeinheit zurückgegeben werden ReferenzId
Int32
(body)KorrespondenzEmpfaenger
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_AktivitaetBeteiligte
Int32ID_Aktivitaet
Int32Referenztyp
Int32
nullableSystemrolle.Referenztyp Für Referenztyp 1 (Subjekt) muss ein Subjekt zurückgegeben werden, für Referenztyp 12 (Verbindung) muss eine Verbindung zurückgegeben werden, für Referenztyp 43 (Orgeinheit) muss eine Orgeinheit zurückgegeben werden ReferenzId
Int32
nullableKorrespondenzEmpfaenger
Int32
nullable
-
AktivitaetGenerieren
Das Objekt AktivitaetGenerieren unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/aktivitaetgenerieren/execute Führt eine Aktion aus. -
POST basis/aktivitaetgenerieren/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ID_Aktivitaetvorlage
Int32
(body)Aktivität wird mit den Daten der Aktivitätsvorlage erstellt (ausser es werden hier weitere Daten übergeben) AusSP
Int32
(body)0 Typ
Int32
(body)Kommunikationsmittel
Int32
(body)Referenztyp
Int32
(body)ReferenzNr
Int32
(body)Prioritaet
Int32
(body)Persoenlich
Int32
(body)0 Richtung
Int32
(body)Kategorie
Int32
(body)Thema
Int32
(body)Aktion
Int32
(body)Ergebnis
Int32
(body)Verantwortlicher_ID_Orgeinheit
Int32
(body)Status
Int32
(body)Statusdatum
DateTime
(body)Startdatum
DateTime
(body)Enddatum
DateTime
(body)Betreff
String
(body)Empfaenger
String
(body)Id's der Organisationseinheiten mit Pipe getrennt übergeben, z.B. 15|23|45| LinkURL
String
(body)LinkBezeichnung
String
(body)Nachricht
String
(body)Erstell_ID_Orgeinheit
Int32
(body)Erstell_ID_SWSystem
Int32
(body)Response
Name Herkunft Beschreibung ID_Aktivitaet
Int32
nullable
-
AktivitaetNachricht
Das Objekt AktivitaetNachricht unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/aktivitaetnachricht Suchen nach AktivitaetNachricht Objekten. GET basis/aktivitaetnachricht/{id} Gibt das AktivitaetNachricht Objekt mit dem entsprechenden Schlüssel zurück. POST basis/aktivitaetnachricht Erstellt ein neues AktivitaetNachricht Objekt mit den übergebenen Werten. PUT basis/aktivitaetnachricht/{id} Aktualisiert das AktivitaetNachricht Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/aktivitaetnachricht
Suchen nach AktivitaetNachricht Objekten.
Parameters
Name Default Beschreibung ID_Aktivitaet *required
Int32
(query)ID_Aktivitaet. ID_SWSystem
Int32
(query)ID_SWSystem. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung Nachricht
StringErsteller
String
nullableErstell_ID_SWSystem
Int32
nullableErstelldatumFormatiert
String
nullableID_Nachricht
Int32ID_Aktivitaet
Int32Erstell_ID_Orgeinheit
Int32 -
GET basis/aktivitaetnachricht/{id}
Gibt das AktivitaetNachricht Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Nachricht. Response
Name Herkunft Beschreibung ID_Nachricht
Int32ID_Aktivitaet
Int32Nachricht
StringEmpfaenger
String
nullableOrgeinheit-Id mit "|" getrennt eintragen -
POST basis/aktivitaetnachricht
Erstellt ein neues AktivitaetNachricht Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung ID_Aktivitaet *required
Int32
(body)Nachricht *required
String
(body)Empfaenger
String
(body)Orgeinheit-Id mit "|" getrennt eintragen Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Nachricht
Int32ID_Aktivitaet
Int32Nachricht
StringEmpfaenger
String
nullableOrgeinheit-Id mit "|" getrennt eintragen -
PUT basis/aktivitaetnachricht/{id}
Aktualisiert das AktivitaetNachricht Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Nachricht. ID_Aktivitaet *required
Int32
(body)Nachricht *required
String
(body)Empfaenger
String
(body)Orgeinheit-Id mit "|" getrennt eintragen Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Nachricht
Int32ID_Aktivitaet
Int32Nachricht
StringEmpfaenger
String
nullableOrgeinheit-Id mit "|" getrennt eintragen
-
AktivitaetProjekt
Das Objekt AktivitaetProjekt unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/aktivitaetprojekt Suchen nach AktivitaetProjekt Objekten. -
GET basis/aktivitaetprojekt
Suchen nach AktivitaetProjekt Objekten.
Parameters
Name Default Beschreibung AlleProjektProzesse
Int32
(query)AlleProjektProzesse. ID_AktivitaetAblauf
Int32
(query)ID_AktivitaetAblauf. ReadTabAktivitaetAblaufInPPM
Int32
(query)ReadTabAktivitaetAblaufInPPM. ReferenzNr
Int32
(query)ReferenzNr. Referenztyp
Int32
(query)Referenztyp. Status
Int32
(query)Status. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Aktivitaet
Int32Typ
Int32Aktivitaet.Typ Betreff
String
nullableReferenztyp
Int32
nullable86 = Projekt ReferenzNr
Int32
nullableID_Projekt Referenz
String
nullableThema
Int32
nullableAktivitaet.Thema Aktion
Int32
nullableAktivitaet.Aktion Kategorie
Int32
nullableAktivitate.Kategorie Ergebnis
Int32
nullableAktivitaet.Kontaktergebnis Verantwortlicher_ID_Orgeinheit
Int32
nullableVerantwortlicher
String
nullablePrioritaet
Int32
nullableStatus
Int32Aktivitaet.Status Statusdatum
DateTime
nullableStartzeit
DateTime
nullableEndzeit
DateTime
nullableID_AktivitaetAblauf
Int32
nullableFristen_LetzteFrist
String
nullableNachrichten
String
nullable
-
AktivitaetVorlage
Das Objekt AktivitaetVorlage unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/aktivitaetvorlage Suchen nach AktivitaetVorlage Objekten. -
GET basis/aktivitaetvorlage
Suchen nach AktivitaetVorlage Objekten.
Parameters
Name Default Beschreibung Aktion
Int32
(query)Aktion. ID_Aktivitaetvorlage
Int32
(query)ID_Aktivitaetvorlage. Kategorie
Int32
(query)Kategorie. Referenztyp
Int32
(query)Referenztyp. Thema
Int32
(query)Thema. Typ
Int32
(query)Typ. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Aktivitaetvorlage
Int32Kommunikationsmittel
Int32
nullableAktivitaet.Kommunikationsmittel Ergebnis
Int32
nullableAktivitaet.Kontaktergebnis Aktion
Int32
nullableAktivitaet.Aktion Thema
Int32
nullableAktivitaet.Thema Kategorie
Int32
nullableAktivitaet.Kategorie Betreff
String
nullableTyp
Int32Aktivitaet.Typ Nachricht
String
nullableRichtungBezeichnung
String
nullableRichtung
Int32
nullableAktivitaet.Richtung KommunikationsmittelBezeichnung
String
nullableStatusBezeichnung
String
nullableStatus
Int32
nullableAktivitaet.Status PrioritaetBezeichnung
String
nullablePrioritaet
Int32
nullableAktivitaet.Prioritaet AktionBezeichnung
String
nullableThemaBezeichnung
String
nullableKategorieBezeichnung
String
nullableTypBezeichnung
String
nullableReferenztyp
Int32
nullableAktivitaet.Referenztyp ReferenztypBezeichnung
String
nullableErgebnisBezeichnung
String
nullable
-
Anfragesteller
Das Objekt Anfragesteller unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/anfragesteller/execute Führt eine Aktion aus. -
POST basis/anfragesteller/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ID_Subjekt *required
Int32
(body)Response
Name Herkunft Beschreibung Auskunftsberechtigt
Int32
nullableKostenbefreit
Int32
nullableSammelrechnung
Int32
nullable
-
Anlage
Das Objekt Anlage unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/anlage Suchen nach Anlage Objekten. GET basis/anlage/{id} Gibt das Anlage Objekt mit dem entsprechenden Schlüssel zurück. POST basis/anlage Erstellt ein neues Anlage Objekt mit den übergebenen Werten. PUT basis/anlage/{id} Aktualisiert das Anlage Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/anlage
Suchen nach Anlage Objekten.
Parameters
Name Default Beschreibung Anlageart
Int32
(query)Anlageart. Anschlussart
Int32
(query)Anschlussart. EnergieArt
Int32
(query)EnergieArt. GST_ID_Geraetestandort
Int32
(query)GST_ID_Geraetestandort. GST_Steuert
Int32
(query)GST_Steuert. ID_Anlage
Int32
(query)ID_Anlage. OBJ_HausNr
Int16
(query)OBJ_HausNr. OBJ_HausNrZusatz
String
(query)OBJ_HausNrZusatz. OBJ_ID_Objekt
Int32
(query)OBJ_ID_Objekt. OBJ_Ortsname
String
(query)OBJ_Ortsname. OBJ_Postleitzahl
String
(query)OBJ_Postleitzahl. OBJ_Strasse
String
(query)OBJ_Strasse. Objekthierarchie
Int32
(query)Objekthierarchie. OTO_ID
String
(query)OTO_ID. Typenbezeichnung
String
(query)Typenbezeichnung. Zusatzbezeichnung
String
(query)Zusatzbezeichnung. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Anlage
Int32ID_Objekt
Int32Anlageart
Int32Anlage.Art Wertebereich "Anlage.Art" EnergieArt
String
nullableKlartext der Energiearten Status
Int32
nullableAnlage.Status Wertebereich "Anlage.Status" LeistungBezug
Decimal
nullableLeistungProduktion
Decimal
nullableVolumen
Decimal
nullableGeschoss
Int32
nullableGebaeudedetail.Geschoss Wertebereich "Gebaeudeteil.Geschoss" Geschosszusatz
Int32
nullableGebaeudedetail.Geschosszusatz Wertebereich "Gebaeudeteil.Geschosszusatz" GueltigVon
DateTimeGueltigBis
DateTime
nullableNummer
String
nullableBaujahr
Int32
nullableTypenbezeichnung
String
nullableZusatzbezeichnung
String
nullableAnlagetyp
String
nullableKlartext zu Anlagetyp Objekt
String
nullableStandort
String
nullableGeraetestandort_gespiesen
String
nullableGeraetestandort_gesteuert
String
nullableID_Geraetestandort_gespiesen
Int32
nullableID_Geraetestandort_gesteuert
Int32
nullableAnschlussart
Int32
nullableWertebereich "Leistkatpos.Anschlussart" ID_MultimediaAnlage
Int32
nullableRueckkanaltauglichkeit
Int32
nullableWohnung_Aktiv
Int32
nullablePlombierungsart
Int32
nullableWohnungsverstaerker
Int32
nullableAnzahlDosen
Decimal
nullableWohnungsverstaerkerTyp
Int32
nullableVerstaerkerAusgangspegelInDB
Decimal
nullableOTO_ID
String
nullableOTOReady
Int32
nullableVerfuegbarkeitsdatum
DateTime
nullableExternalSystem_Order_ID
Int32
nullableOMDFRack
String
nullableOMDFSlot
Int32
nullableOMDFPort
Int32
nullable -
GET basis/anlage/{id}
Gibt das Anlage Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Anlage. Response
Name Herkunft Beschreibung ID_Anlage
Int32ID_Objekt
Int32ID_Anlagetyp
Int32EnergieArt
Int32
nullableWertebereich "Verrechnungstyp.Art" LeistungBezug
Decimal
nullableLeistungProduktion
Decimal
nullableGeschoss
Int32
nullableWertebereich "Gebaeudeteil.Geschoss" Geschosszusatz
Int32
nullableWertebereich "Gebaeudeteil.Geschosszusatz" GueltigVon
DateTimeGueltigBis
DateTime
nullableNummer
String
nullableBaujahr
Int32
nullableID_Waermeanlage
Int32
nullableID_Geraetestandort_gespiesen
Int32
nullableID_Geraetestandort_gesteuert
Int32
nullableVolumen
Decimal
nullableID_Subjekt
Int32
nullableKontaktperson Adressart
Int32
nullableWertebereich "Adresse.Adressart" ID_Kontaktperson
Int32
nullableZustell_ID_Subjekt
Int32
nullableNetzLastmanagement
Int32Wertebereich "System.JaNein" Ladeart
Int32
nullableWertebereich "Anlage.Ladeart". Ladeart bei einer Ladestation Nennleistung
Decimal
nullableAnschlussstromstaerke
Decimal
nullableAnzahlLadepunkte
Int32
nullableAnzahl Ladepunkte bei einer Ladestation -
POST basis/anlage
Erstellt ein neues Anlage Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung ID_Objekt *required
Int32
(body)ID_Anlagetyp *required
Int32
(body)EnergieArt
Int32
(body)Wertebereich "Verrechnungstyp.Art" LeistungBezug
Decimal
(body)LeistungProduktion
Decimal
(body)Geschoss
Int32
(body)Wertebereich "Gebaeudeteil.Geschoss" Geschosszusatz
Int32
(body)Wertebereich "Gebaeudeteil.Geschosszusatz" GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)Nummer
String
(body)Baujahr
Int32
(body)ID_Waermeanlage
Int32
(body)ID_Geraetestandort_gespiesen
Int32
(body)ID_Geraetestandort_gesteuert
Int32
(body)Volumen
Decimal
(body)ID_Subjekt
Int32
(body)Kontaktperson Adressart
Int32
(body)Wertebereich "Adresse.Adressart" ID_Kontaktperson
Int32
(body)Zustell_ID_Subjekt
Int32
(body)NetzLastmanagement *required
Int32
(body)Wertebereich "System.JaNein" Ladeart
Int32
(body)Wertebereich "Anlage.Ladeart". Ladeart bei einer Ladestation Nennleistung
Decimal
(body)Anschlussstromstaerke
Decimal
(body)AnzahlLadepunkte
Int32
(body)Anzahl Ladepunkte bei einer Ladestation Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Anlage
Int32ID_Objekt
Int32ID_Anlagetyp
Int32EnergieArt
Int32
nullableWertebereich "Verrechnungstyp.Art" LeistungBezug
Decimal
nullableLeistungProduktion
Decimal
nullableGeschoss
Int32
nullableWertebereich "Gebaeudeteil.Geschoss" Geschosszusatz
Int32
nullableWertebereich "Gebaeudeteil.Geschosszusatz" GueltigVon
DateTimeGueltigBis
DateTime
nullableNummer
String
nullableBaujahr
Int32
nullableID_Waermeanlage
Int32
nullableID_Geraetestandort_gespiesen
Int32
nullableID_Geraetestandort_gesteuert
Int32
nullableVolumen
Decimal
nullableID_Subjekt
Int32
nullableKontaktperson Adressart
Int32
nullableWertebereich "Adresse.Adressart" ID_Kontaktperson
Int32
nullableZustell_ID_Subjekt
Int32
nullableNetzLastmanagement
Int32Wertebereich "System.JaNein" Ladeart
Int32
nullableWertebereich "Anlage.Ladeart". Ladeart bei einer Ladestation Nennleistung
Decimal
nullableAnschlussstromstaerke
Decimal
nullableAnzahlLadepunkte
Int32
nullableAnzahl Ladepunkte bei einer Ladestation -
PUT basis/anlage/{id}
Aktualisiert das Anlage Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Anlage. ID_Objekt *required
Int32
(body)ID_Anlagetyp *required
Int32
(body)EnergieArt
Int32
(body)Wertebereich "Verrechnungstyp.Art" LeistungBezug
Decimal
(body)LeistungProduktion
Decimal
(body)Geschoss
Int32
(body)Wertebereich "Gebaeudeteil.Geschoss" Geschosszusatz
Int32
(body)Wertebereich "Gebaeudeteil.Geschosszusatz" GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)Nummer
String
(body)Baujahr
Int32
(body)ID_Waermeanlage
Int32
(body)ID_Geraetestandort_gespiesen
Int32
(body)ID_Geraetestandort_gesteuert
Int32
(body)Volumen
Decimal
(body)ID_Subjekt
Int32
(body)Kontaktperson Adressart
Int32
(body)Wertebereich "Adresse.Adressart" ID_Kontaktperson
Int32
(body)Zustell_ID_Subjekt
Int32
(body)NetzLastmanagement *required
Int32
(body)Wertebereich "System.JaNein" Ladeart
Int32
(body)Wertebereich "Anlage.Ladeart". Ladeart bei einer Ladestation Nennleistung
Decimal
(body)Anschlussstromstaerke
Decimal
(body)AnzahlLadepunkte
Int32
(body)Anzahl Ladepunkte bei einer Ladestation Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Anlage
Int32ID_Objekt
Int32ID_Anlagetyp
Int32EnergieArt
Int32
nullableWertebereich "Verrechnungstyp.Art" LeistungBezug
Decimal
nullableLeistungProduktion
Decimal
nullableGeschoss
Int32
nullableWertebereich "Gebaeudeteil.Geschoss" Geschosszusatz
Int32
nullableWertebereich "Gebaeudeteil.Geschosszusatz" GueltigVon
DateTimeGueltigBis
DateTime
nullableNummer
String
nullableBaujahr
Int32
nullableID_Waermeanlage
Int32
nullableID_Geraetestandort_gespiesen
Int32
nullableID_Geraetestandort_gesteuert
Int32
nullableVolumen
Decimal
nullableID_Subjekt
Int32
nullableKontaktperson Adressart
Int32
nullableWertebereich "Adresse.Adressart" ID_Kontaktperson
Int32
nullableZustell_ID_Subjekt
Int32
nullableNetzLastmanagement
Int32Wertebereich "System.JaNein" Ladeart
Int32
nullableWertebereich "Anlage.Ladeart". Ladeart bei einer Ladestation Nennleistung
Decimal
nullableAnschlussstromstaerke
Decimal
nullableAnzahlLadepunkte
Int32
nullableAnzahl Ladepunkte bei einer Ladestation
-
Anlagetrezuord
Das Objekt Anlagetrezuord unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/anlagetrezuord Suchen nach Anlagetrezuord Objekten. -
GET basis/anlagetrezuord
Suchen nach Anlagetrezuord Objekten.
Parameters
Name Default Beschreibung ID_Anlage *required
Int32
(query)ID_Anlage. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_TREKommando
Int32Schaltzustand
Int32Wertebereich "Trekommando.Schaltzustand" Beschreibung
String
nullableID_Anlage
Int32Reihenfolge
String
nullable
-
AnlagetrezuordWS
Das Objekt AnlagetrezuordWS unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/anlagetrezuordws/execute Führt eine Aktion aus. -
POST basis/anlagetrezuordws/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ID_TREKommando *required
Int32
(body)ID_Anlage *required
Int32
(body)MutArt *required
String
(body)Mutationsart, die folgenden Operationen werden unterstützt: I = Insert, D = Delete Response
Name Herkunft Beschreibung ID_Anlage
Int32
nullableID_TREKommando
Int32
nullable
-
Anlagetyp
Das Objekt Anlagetyp unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/anlagetyp Suchen nach Anlagetyp Objekten. -
GET basis/anlagetyp
Suchen nach Anlagetyp Objekten.
Parameters
Name Default Beschreibung Anlageart
Int32
(query)Anlageart. EnergieArt
Int32
(query)EnergieArt. Hersteller
String
(query)Hersteller. ID_Anlagetyp
Int32
(query)ID_Anlagetyp. Inaktiv
Int32
(query)Inaktiv. NurVerbraucher
Int32
(query)NurVerbraucher. Teil
Int32
(query)Teil. Typenbezeichnung
String
(query)Typenbezeichnung. Zusatzbezeichnung
String
(query)Zusatzbezeichnung. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Anlagetyp
Int32EnergieArt
Int32
nullableWertebereich "Verrechnungstyp.Art" Energieart2
Int32
nullableWertebereich "Verrechnungstyp.Art" Anlageart
Int32Wertebereich "Anlage.Art" Anschlussart
Int32
nullableWertebereich "Leistkatpos.Anschlussart" Teil
Int32
nullableWertebereich "Anlage.Teil" Hersteller
String
nullableKlartext zu Hersteller Typenbezeichnung
String
nullableZusatzbezeichnung
String
nullableTypennummer
String
nullableZulassungsnummer
String
nullableVerbrennungsluft
Int32
nullableWertebereich "Anlage.Verbrennungsluft" AnlagetypTeil
Int32
nullableID_AnlagetypTeil
Int32
nullableInaktiv
Int32
nullable
-
Briefanrede
Das Objekt Briefanrede unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/briefanrede/execute Führt eine Aktion aus. -
POST basis/briefanrede/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ID_Subjekt *required
Int32
(body)Response
Name Herkunft Beschreibung Zeile
String
-
DeleteAktivitaet
Das Objekt DeleteAktivitaet unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/deleteaktivitaet/execute Führt eine Aktion aus. -
POST basis/deleteaktivitaet/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ID_Aktivitaet *required
Int32
(body)Es dürfen nur Aktivitäten mit Status 'Offen' des entsprechenden Softwaresystem-Anbieters gelöscht werden! Response
Name Herkunft Beschreibung
-
Dokumentreferenz
Das Objekt Dokumentreferenz unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/dokumentreferenz Suchen nach Dokumentreferenz Objekten. -
GET basis/dokumentreferenz
Suchen nach Dokumentreferenz Objekten.
Parameters
Name Default Beschreibung ReferenzNr *required
Int32
(query)ReferenzNr. Referenztyp *required
Int32
(query)Referenztyp. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Dokument
Int32Bezeichnung
String
nullableFileName
StringAblageArt
Int32Dokument.AblageArt LaufNr_Dokument
Int32
nullable
-
DublettenCheck
Das Objekt DublettenCheck unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/dublettencheck/execute Führt eine Aktion aus. -
POST basis/dublettencheck/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ENNA_Name *required
String
(body)ENNA_LedigerName *required
String
(body)ENNA_Allianzname *required
String
(body)Geburtsdatum *required
DateTime
(body)GeschlRechtsf *required
Int32
(body)Subjekt.GeschlRechtsf Vornamen *required
String
(body)Rufname *required
String
(body)Subjektart *required
Int32
(body)Strasse *required
String
(body)HausNr *required
Int32
(body)HausNrZusatz *required
String
(body)ID_Ort *required
Int32
(body)ID_Objekt *required
Int32
(body)Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ProzentsatzUebereinstimmung
String
nullableProzentsatzUebereinstimmungDecimal
Decimal
nullableID_Subjekt
Int32Name
String
nullableVorname
String
nullableAdresse
String
nullableTyp
String
nullableSubjekt.Typ GeschlRechtsf
Int32
nullableSubjekt.GeschlRechtsf Kuerzel
String
nullableZusatzname
String
nullableGueltigVon
DateTime
nullableGueltiBis
DateTime
nullableGeburtsdatum
DateTime
nullable
-
Einmaladresse
Das Objekt Einmaladresse unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/einmaladresse/{id} Gibt das Einmaladresse Objekt mit dem entsprechenden Schlüssel zurück. -
GET basis/einmaladresse/{id}
Gibt das Einmaladresse Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Einmaladresse. Response
Name Herkunft Beschreibung Name
String
nullableVorname
String
nullableZusatzname
String
nullableAnrede
Int32
nullableSubjekt.Anrede Titel
String
nullableID_Einmaladresse
Int32
-
Gemeinde
Das Objekt Gemeinde unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/gemeinde/{id} Gibt das Gemeinde Objekt mit dem entsprechenden Schlüssel zurück. -
GET basis/gemeinde/{id}
Gibt das Gemeinde Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Gemeinde. Response
Name Herkunft Beschreibung ID_Gemeinde
Int32Gemeindename
StringTitel
String
nullableArt
Int321 = politische Gemeinde GemeindeNrBfS
Int32
nullableGemeindeNrKant
Int32
nullableGueltigBis
DateTime
nullableSitzID_Ort
Int32Hauptsitz
StringNachfolge_ID_Gemeinde
Int32
nullableNachfolge_Gemeindename
String
nullableID_Zivilstandskreis
Int32
nullableZivilstandskreis
String
nullableKanton
String
nullable
-
Gruppenzuord
Das Objekt Gruppenzuord unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/gruppenzuord Suchen nach Gruppenzuord Objekten. GET basis/gruppenzuord/{id} Gibt das Gruppenzuord Objekt mit dem entsprechenden Schlüssel zurück. POST basis/gruppenzuord Erstellt ein neues Gruppenzuord Objekt mit den übergebenen Werten. PUT basis/gruppenzuord/{id} Aktualisiert das Gruppenzuord Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/gruppenzuord
Suchen nach Gruppenzuord Objekten.
Parameters
Name Default Beschreibung ID_Subjekt *required
Int32
(query)ID_Subjekt. ID_Subjektzuord *required
Int32
(query)ID_Subjektzuord. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Gruppenzuord
Int32ID_Subjektgruppe
Int32SubjektgruppeBezeichnung
String
nullableFunktion
Int32
nullableFunktionBezeichnung
String
nullableNummer
String
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullableID_Subjektzuord
Int32
nullableID_Subjekt
Int32
nullableNotiz
String
nullable -
GET basis/gruppenzuord/{id}
Gibt das Gruppenzuord Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Gruppenzuord. Response
Name Herkunft Beschreibung ID_Subjektgruppe
Int32Funktion
Int32
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullableNotiz
String
nullableNummer
String
nullableID_Gruppenzuord
Int32ID_Subjekt
Int32
nullableID_Subjektzuord
Int32
nullable -
POST basis/gruppenzuord
Erstellt ein neues Gruppenzuord Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung ID_Subjektgruppe *required
Int32
(body)Funktion
Int32
(body)GueltigVon
DateTime
(body)GueltigBis
DateTime
(body)Notiz
String
(body)Nummer
String
(body)ID_Subjekt
Int32
(body)ID_Subjektzuord
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Subjektgruppe
Int32Funktion
Int32
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullableNotiz
String
nullableNummer
String
nullableID_Gruppenzuord
Int32ID_Subjekt
Int32
nullableID_Subjektzuord
Int32
nullable -
PUT basis/gruppenzuord/{id}
Aktualisiert das Gruppenzuord Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Gruppenzuord. ID_Subjektgruppe *required
Int32
(body)Funktion
Int32
(body)GueltigVon
DateTime
(body)GueltigBis
DateTime
(body)Notiz
String
(body)Nummer
String
(body)ID_Subjekt
Int32
(body)ID_Subjektzuord
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Subjektgruppe
Int32Funktion
Int32
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullableNotiz
String
nullableNummer
String
nullableID_Gruppenzuord
Int32ID_Subjekt
Int32
nullableID_Subjektzuord
Int32
nullable
-
InsertAktivitaetFristverlaengerung
Das Objekt InsertAktivitaetFristverlaengerung unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung POST basis/insertaktivitaetfristverlaengerung/execute Führt eine Aktion aus. -
POST basis/insertaktivitaetfristverlaengerung/execute
Führt eine Aktion aus.
Parameters
Name Default Beschreibung ID_Aktivitaet *required
Int32
(body)Fristtage *required
Int32
(body)Kosten
Decimal
(body)Notiz
String
(body)Response
Name Herkunft Beschreibung ID_AktivitaetFristverlaengerung
Int32
nullable
-
Kommunikation
Das Objekt Kommunikation unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/kommunikation Suchen nach Kommunikation Objekten. GET basis/kommunikation/{id} Gibt das Kommunikation Objekt mit dem entsprechenden Schlüssel zurück. POST basis/kommunikation Erstellt ein neues Kommunikation Objekt mit den übergebenen Werten. PUT basis/kommunikation/{id} Aktualisiert das Kommunikation Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/kommunikation
Suchen nach Kommunikation Objekten.
Parameters
Name Default Beschreibung ID_Subjekt *required
Int32
(query)ID_Subjekt. ID_Subjektzuord *required
Int32
(query)ID_Subjektzuord. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Kommunikation
Int32Nummer
StringLokation
Int32
nullableKommunikation.Lokation Art
Int32Kommunikation.Art Kategorie
Int32Kommunikation.Kategorie Notiz
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjekt
Int32
nullableID_Subjektzuord
Int32
nullable -
GET basis/kommunikation/{id}
Gibt das Kommunikation Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Kommunikation. Response
Name Herkunft Beschreibung ID_Kommunikation
Int32Nummer
StringLokation
Int32
nullableKommunikation.Lokation Art
Int32Kommunikation.Art Kategorie
Int32Kommunikation.Kategorie Notiz
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjekt
Int32
nullableKeineWerbung
Int32 -
POST basis/kommunikation
Erstellt ein neues Kommunikation Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Nummer *required
String
(body)Lokation
Int32
(body)Art *required
Int32
(body)Kategorie *required
Int32
(body)Notiz
String
(body)GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)ID_Subjekt
Int32
(body)KeineWerbung *required
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Kommunikation
Int32Nummer
StringLokation
Int32
nullableKommunikation.Lokation Art
Int32Kommunikation.Art Kategorie
Int32Kommunikation.Kategorie Notiz
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjekt
Int32
nullableKeineWerbung
Int32 -
PUT basis/kommunikation/{id}
Aktualisiert das Kommunikation Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Kommunikation. Nummer *required
String
(body)Lokation
Int32
(body)Art *required
Int32
(body)Kategorie *required
Int32
(body)Notiz
String
(body)GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)ID_Subjekt
Int32
(body)KeineWerbung *required
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Kommunikation
Int32Nummer
StringLokation
Int32
nullableKommunikation.Lokation Art
Int32Kommunikation.Art Kategorie
Int32Kommunikation.Kategorie Notiz
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjekt
Int32
nullableKeineWerbung
Int32
-
Orgeinheit
Das Objekt Orgeinheit unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/orgeinheit Suchen nach Orgeinheit Objekten. -
GET basis/orgeinheit
Suchen nach Orgeinheit Objekten.
Parameters
Name Default Beschreibung ID_Orgeinheit
Int32
(query)ID_Orgeinheit. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Orgeinheit
Int32Typ
Int32Orgeinheit.Typ Name
String
nullableID_Subjekt
Int32
nullableSubadresse
String
nullableFunktion
Int32
nullableOrgeinheit.Funktion
-
Ort
Das Objekt Ort unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/ort Suchen nach Ort Objekten. GET basis/ort/{id} Gibt das Ort Objekt mit dem entsprechenden Schlüssel zurück. POST basis/ort Erstellt ein neues Ort Objekt mit den übergebenen Werten. PUT basis/ort/{id} Aktualisiert das Ort Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/ort
Suchen nach Ort Objekten.
Parameters
Name Default Beschreibung Nation *required
Int32
(query)Nation. Postleitzahl *required
String
(query)Postleitzahl. Gemeindename
String
(query)Gemeindename. Ortsname
String
(query)Ortsname. RegionWeiler
String
(query)RegionWeiler. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Ort
Int32Postleitzahl
String
nullableOrtsname
StringRegionWeiler
String
nullableGemeindename
String
nullableGueltigBis
DateTime
nullableKanton
String
nullableID_Gemeinde
Int32
nullablePostleitzahlZusatzziffer
String
nullable -
GET basis/ort/{id}
Gibt das Ort Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Ort. Response
Name Herkunft Beschreibung ID_Ort
Int32Ortsname
StringPostleitzahl
String
nullableRegionWeiler
String
nullableGemeindename
String
nullableGueltigBis
DateTime
nullableKanton
String
nullableID_Gemeinde
Int32
nullableLaufNr
Int16
nullableGemeinde
String
nullableNation
Int32SYSTEM.Nation PostleitzahlZusatzziffer
String
nullable -
POST basis/ort
Erstellt ein neues Ort Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Ortsname *required
String
(body)Postleitzahl
String
(body)RegionWeiler
String
(body)Gemeindename
String
(body)GueltigBis
DateTime
(body)Kanton
String
(body)ID_Gemeinde
Int32
(body)LaufNr
Int16
(body)Gemeinde
String
(body)Nation *required
Int32
(body)PostleitzahlZusatzziffer
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Ort
Int32Ortsname
StringPostleitzahl
String
nullableRegionWeiler
String
nullableGemeindename
String
nullableGueltigBis
DateTime
nullableKanton
String
nullableID_Gemeinde
Int32
nullableLaufNr
Int16
nullableGemeinde
String
nullableNation
Int32SYSTEM.Nation PostleitzahlZusatzziffer
String
nullable -
PUT basis/ort/{id}
Aktualisiert das Ort Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Ort. Ortsname *required
String
(body)Postleitzahl
String
(body)RegionWeiler
String
(body)Gemeindename
String
(body)GueltigBis
DateTime
(body)Kanton
String
(body)ID_Gemeinde
Int32
(body)LaufNr
Int16
(body)Gemeinde
String
(body)Nation *required
Int32
(body)PostleitzahlZusatzziffer
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Ort
Int32Ortsname
StringPostleitzahl
String
nullableRegionWeiler
String
nullableGemeindename
String
nullableGueltigBis
DateTime
nullableKanton
String
nullableID_Gemeinde
Int32
nullableLaufNr
Int16
nullableGemeinde
String
nullableNation
Int32SYSTEM.Nation PostleitzahlZusatzziffer
String
nullable
-
Projekt
Das Objekt Projekt unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/projekt Suchen nach Projekt Objekten. -
GET basis/projekt
Suchen nach Projekt Objekten.
Parameters
Name Default Beschreibung AKT_Aktion
Int32
(query)AKT_Aktion. AKT_Ergebnis
Int32
(query)AKT_Ergebnis. AKT_ID_Aktivitaet
Int32
(query)AKT_ID_Aktivitaet. AKT_Referenztyp
Int32
(query)AKT_Referenztyp. AKT_Thema
Int32
(query)AKT_Thema. AKT_Typ
Int32
(query)AKT_Typ. Bezeichnung
Int32
(query)Bezeichnung. ErfasstAm
DateTime
(query)ErfasstAm. Ersteller
Int32
(query)Ersteller. FaelligBis
DateTime
(query)FaelligBis. FaelligVon
DateTime
(query)FaelligVon. ID_Extern
String
(query)ID_Extern. ID_Projekt
Int32
(query)ID_Projekt. ID_Projekt_Bis
Int32
(query)ID_Projekt_Bis. ID_Projekt_Von
Int32
(query)ID_Projekt_Von. Kategorie
Int32
(query)Kategorie. MI_Art
Int32
(query)MI_Art. MI_Baujahr
Int32
(query)MI_Baujahr. MI_Beschreibung
String
(query)MI_Beschreibung. MI_FabrikNr
String
(query)MI_FabrikNr. MI_Installationsbez
Int32
(query)MI_Installationsbez. MI_Spannungsebene
Int32
(query)MI_Spannungsebene. MI_Typ
String
(query)MI_Typ. MI_WerkFabrikNrExakt
Int32
(query)MI_WerkFabrikNrExakt. MI_WerkNr
String
(query)MI_WerkNr. MI_Zusatzbez
Int32
(query)MI_Zusatzbez. MI_Zustand
Int32
(query)MI_Zustand. PER_Aktuelle
Int32
(query)PER_Aktuelle. PER_Andere
Int32
(query)PER_Andere. PER_BeteiligteAnzeigen
Int32
(query)PER_BeteiligteAnzeigen. PER_HausNr
Int32
(query)PER_HausNr. PER_HausNrZusatz
String
(query)PER_HausNrZusatz. PER_ID_Subjekt
Int32
(query)PER_ID_Subjekt. PER_KontaktName
String
(query)PER_KontaktName. PER_KontaktVorname
String
(query)PER_KontaktVorname. PER_Name
String
(query)PER_Name. PER_Ort
String
(query)PER_Ort. PER_PLZ
String
(query)PER_PLZ. PER_Rolle
Int32
(query)PER_Rolle. PER_Strasse
String
(query)PER_Strasse. PER_Vergangene
Int32
(query)PER_Vergangene. PER_Vertragsgeber
Int32
(query)PER_Vertragsgeber. PER_Vertragsnehmer
Int32
(query)PER_Vertragsnehmer. PER_Vorname
String
(query)PER_Vorname. PER_Zukuenftige
Int32
(query)PER_Zukuenftige. PER_ZusatzName
String
(query)PER_ZusatzName. Persoenlich
Int32
(query)Persoenlich. ProjektNrExakt
Int32
(query)ProjektNrExakt. ProjektText
String
(query)ProjektText. ProjektTextTyp
Int32
(query)ProjektTextTyp. REF_Aktuelle
Int32
(query)REF_Aktuelle. REF_Bezeichnung
String
(query)REF_Bezeichnung. REF_Gebiet_Bezeichnung
String
(query)REF_Gebiet_Bezeichnung. REF_Gebiet_Kuerzel
String
(query)REF_Gebiet_Kuerzel. REF_Gebiettyp
Int32
(query)REF_Gebiettyp. REF_Geschoss
Int32
(query)REF_Geschoss. REF_GeschossZusatz
Int32
(query)REF_GeschossZusatz. REF_Gewerbeart
Int32
(query)REF_Gewerbeart. REF_HausNr
Int32
(query)REF_HausNr. REF_HausNrZusatz
String
(query)REF_HausNrZusatz. REF_ID_Gebiet
Int32
(query)REF_ID_Gebiet. REF_ID_Objekt
Int32
(query)REF_ID_Objekt. REF_Lage
String
(query)REF_Lage. REF_Objekt_Aktuelle
Int32
(query)REF_Objekt_Aktuelle. REF_Objekt_Vergangene
Int32
(query)REF_Objekt_Vergangene. REF_Objekt_Zukuenftige
Int32
(query)REF_Objekt_Zukuenftige. REF_ObjektHierarchie
Int32
(query)REF_ObjektHierarchie. REF_ObjektTyp
Int32
(query)REF_ObjektTyp. REF_Ortsname
String
(query)REF_Ortsname. REF_PLZ
String
(query)REF_PLZ. REF_Raumart
Int32
(query)REF_Raumart. REF_Rolle
Int32
(query)REF_Rolle. REF_Strasse
String
(query)REF_Strasse. REF_Vergangene
Int32
(query)REF_Vergangene. REF_Zukuenftige
Int32
(query)REF_Zukuenftige. Referenztyp
Int32
(query)86 Referenztyp. Status
Int32
(query)Status. Unterkategorie
Int32
(query)Unterkategorie. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Projekt
Int32Referenztyp
Int32Kategorie
Int32Projekt.Kategorie Unterkategorie
Int32
nullableProjekt.Unterkategorie Status
Int32
nullableProjektStatus.Status Referenzen
String
nullableBeteiligte
String
nullableKontrollobjekte
String
nullableAnzeigenKopf
String
nullableFaelligkeitsdatum
DateTime
nullableTurnusbezeichnung
String
nullableExternId
String
nullableBezeichnung
Int32
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullablePersoenlich
Int32LetzteAktivitaet_ID_Aktivitaet
Int32
nullableErsteller
String
nullableID_ProjektParam
Int32ReferenzenProjektNr
String
nullableBeschreibung
String
nullableLetzteAktivitaet_Beschreibung
String
nullableLetzteAktivitaet_Status
Int32
nullableLetzteAktivitaet_StatusDatum
DateTime
nullableLetzteAktivitaet_Startzeit
DateTime
nullableLetzteAktivitaet_Endzeit
DateTime
nullableLetzteAktivitaet_Fristen
String
nullableErstelldatum
DateTime
nullableAusschlussKontrollTermin
Int32Gibt zurück, ob der Status «AusschlussKontrolltermin» beim Projekt vorhanden ist. 0 = nicht vorhanden 1 = Status «Aus-schlussKontrolltermin» vorhanden. BasisDatum
DateTime
nullableAusschlussKontrollterminVerwalten
Int32
nullableGibt zurück, ob die Möglichkeit besteht beim Projekt den Status «AusschlussKontrolltermin» zu schreiben. 0 = Der Status «AusschlussKontrolltermin» kann nicht geschrieben werden, weil der Status bei der Projektparametrieung für dieses Projekt nicht definiert ist. 1 = Der Status «AusschlussKontrolltermin» kann bei diesem Projekt geschrieben werden. LetzteAktivitaet_ID_AktivitaetVorlage
Int32
nullable
-
Projektmanagement
Das Objekt Projektmanagement unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/projektmanagement Suchen nach Projektmanagement Objekten. -
GET basis/projektmanagement
Suchen nach Projektmanagement Objekten.
Parameters
Name Default Beschreibung AKT_Aktion
Int32
(query)AKT_Aktion. AKT_Ergebnis
Int32
(query)AKT_Ergebnis. AKT_ID_Aktivitaet
Int32
(query)AKT_ID_Aktivitaet. AKT_Referenztyp
Int32
(query)AKT_Referenztyp. AKT_Thema
Int32
(query)AKT_Thema. AKT_Typ
Int32
(query)AKT_Typ. Bezeichnung
Int32
(query)Bezeichnung. ErfasstAm
DateTime
(query)ErfasstAm. Ersteller
Int32
(query)Ersteller. FaelligBis
DateTime
(query)FaelligBis. FaelligVon
DateTime
(query)FaelligVon. ID_Extern
String
(query)ID_Extern. ID_Projekt
Int32
(query)ID_Projekt. ID_Projekt_Bis
Int32
(query)ID_Projekt_Bis. ID_Projekt_Von
Int32
(query)ID_Projekt_Von. Kategorie
Int32
(query)Kategorie. MI_Art
Int32
(query)MI_Art. MI_Baujahr
Int32
(query)MI_Baujahr. MI_Beschreibung
String
(query)MI_Beschreibung. MI_FabrikNr
String
(query)MI_FabrikNr. MI_Installationsbez
Int32
(query)MI_Installationsbez. MI_Spannungsebene
Int32
(query)MI_Spannungsebene. MI_Typ
String
(query)MI_Typ. MI_WerkFabrikNrExakt
Int32
(query)MI_WerkFabrikNrExakt. MI_WerkNr
String
(query)MI_WerkNr. MI_Zusatzbez
Int32
(query)MI_Zusatzbez. MI_Zustand
Int32
(query)MI_Zustand. PER_Aktuelle
Int32
(query)PER_Aktuelle. PER_Andere
Int32
(query)PER_Andere. PER_BeteiligteAnzeigen
Int32
(query)PER_BeteiligteAnzeigen. PER_HausNr
Int32
(query)PER_HausNr. PER_HausNrZusatz
String
(query)PER_HausNrZusatz. PER_ID_Subjekt
Int32
(query)PER_ID_Subjekt. PER_KontaktName
String
(query)PER_KontaktName. PER_KontaktVorname
String
(query)PER_KontaktVorname. PER_Name
String
(query)PER_Name. PER_Ort
String
(query)PER_Ort. PER_PLZ
String
(query)PER_PLZ. PER_Rolle
Int32
(query)PER_Rolle. PER_Strasse
String
(query)PER_Strasse. PER_Vergangene
Int32
(query)PER_Vergangene. PER_Vertragsgeber
Int32
(query)PER_Vertragsgeber. PER_Vertragsnehmer
Int32
(query)PER_Vertragsnehmer. PER_Vorname
String
(query)PER_Vorname. PER_Zukuenftige
Int32
(query)PER_Zukuenftige. PER_ZusatzName
String
(query)PER_ZusatzName. Persoenlich
Int32
(query)Persoenlich. ProjektNrExakt
Int32
(query)ProjektNrExakt. ProjektText
String
(query)ProjektText. ProjektTextTyp
Int32
(query)ProjektTextTyp. REF_Aktuelle
Int32
(query)REF_Aktuelle. REF_Bezeichnung
String
(query)REF_Bezeichnung. REF_Gebiet_Bezeichnung
String
(query)REF_Gebiet_Bezeichnung. REF_Gebiet_Kuerzel
String
(query)REF_Gebiet_Kuerzel. REF_Gebiettyp
Int32
(query)REF_Gebiettyp. REF_Geschoss
Int32
(query)REF_Geschoss. REF_GeschossZusatz
Int32
(query)REF_GeschossZusatz. REF_Gewerbeart
Int32
(query)REF_Gewerbeart. REF_HausNr
Int32
(query)REF_HausNr. REF_HausNrZusatz
String
(query)REF_HausNrZusatz. REF_ID_Gebiet
Int32
(query)REF_ID_Gebiet. REF_ID_Objekt
Int32
(query)REF_ID_Objekt. REF_Lage
String
(query)REF_Lage. REF_Objekt_Aktuelle
Int32
(query)REF_Objekt_Aktuelle. REF_Objekt_Vergangene
Int32
(query)REF_Objekt_Vergangene. REF_Objekt_Zukuenftige
Int32
(query)REF_Objekt_Zukuenftige. REF_ObjektHierarchie
Int32
(query)REF_ObjektHierarchie. REF_ObjektTyp
Int32
(query)REF_ObjektTyp. REF_Ortsname
String
(query)REF_Ortsname. REF_PLZ
String
(query)REF_PLZ. REF_Raumart
Int32
(query)REF_Raumart. REF_Rolle
Int32
(query)REF_Rolle. REF_Strasse
String
(query)REF_Strasse. REF_Vergangene
Int32
(query)REF_Vergangene. REF_Zukuenftige
Int32
(query)REF_Zukuenftige. Referenztyp
Int32
(query)86 Referenztyp. Status
Int32
(query)Status. Unterkategorie
Int32
(query)Unterkategorie. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Projekt
Int32Referenztyp
Int32Kategorie
Int32Projekt.Kategorie Unterkategorie
Int32
nullableProjekt.Unterkategorie Status
Int32
nullableProjektStatus.Status Referenzen
String
nullableBeteiligte
String
nullableKontrollobjekte
String
nullableAnzeigenKopf
String
nullableFaelligkeitsdatum
DateTime
nullableTurnusbezeichnung
String
nullableExternId
String
nullableBezeichnung
Int32
nullableGueltigVon
DateTime
nullableGueltigBis
DateTime
nullablePersoenlich
Int32LetzteAktivitaet_ID_Aktivitaet
Int32
nullableErsteller
String
nullableReferenzenProjektNr
String
nullableBeschreibung
String
nullableErstelldatum
DateTime
nullableLetzteAktivitaet_Beschreibung
String
nullableLetzteAktivitaet_Status
Int32
nullableLetzteAktivitaet_StatusDatum
DateTime
nullableLetzteAktivitaet_Startzeit
DateTime
nullableLetzteAktivitaet_Endzeit
DateTime
nullableLetzteAktivitaet_Fristen
String
nullableID_ProjektParam
Int32AusschlussKontrollTermin
Int32Gibt zurück, ob der Status «AusschlussKontrolltermin» beim Projekt vorhanden ist. 0 = nicht vorhanden 1 = Status «Aus-schlussKontrolltermin» vorhanden. AusschlussKontrollterminVerwalten
Int32
nullableGibt zurück, ob die Möglichkeit besteht beim Projekt den Status «AusschlussKontrolltermin» zu schreiben. 0 = Der Status «AusschlussKontrolltermin» kann nicht geschrieben werden, weil der Status bei der Projektparametrieung für dieses Projekt nicht definiert ist. 1 = Der Status «AusschlussKontrolltermin» kann bei diesem Projekt geschrieben werden. BasisDatum
DateTime
nullableLetzteAktivitaet_ID_AktivitaetVorlage
Int32
nullable
-
ProjektParam
Das Objekt ProjektParam unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/projektparam Suchen nach ProjektParam Objekten. -
GET basis/projektparam
Suchen nach ProjektParam Objekten.
Parameters
Name Default Beschreibung Referenztyp
Int32
(query)Referenztyp. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_ProjektParam
Int32Kategorie
Int32Projekt.Kategorie Unterkategorie
Int32
nullableProjekt.Unterkategorie
-
ProjektParamRolle
Das Objekt ProjektParamRolle unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/projektparamrolle Suchen nach ProjektParamRolle Objekten. -
GET basis/projektparamrolle
Suchen nach ProjektParamRolle Objekten.
Parameters
Name Default Beschreibung ID_ProjektParam
Int32
(query)ID_ProjektParam. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_ProjektParamRolle
Int32Rolle
Int32ProjektRolle.Rolle Referenztypen
String
nullableBeziehung
Int32
nullableProjektParamRolle.Beziehung Bindung
Int32
-
ProjektRolle
Das Objekt ProjektRolle unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/projektrolle Suchen nach ProjektRolle Objekten. GET basis/projektrolle/{id} Gibt das ProjektRolle Objekt mit dem entsprechenden Schlüssel zurück. POST basis/projektrolle Erstellt ein neues ProjektRolle Objekt mit den übergebenen Werten. PUT basis/projektrolle/{id} Aktualisiert das ProjektRolle Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/projektrolle
Suchen nach ProjektRolle Objekten.
Parameters
Name Default Beschreibung Bindung
Int32
(query)Bindung. ID_Projekt
Int32
(query)ID_Projekt. Person
Int32
(query)Person. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_ProjektRolle
Int32Die automatisch ermittelten Rollen besitzen keine ID (z.B. Eigentümer, Objektpersonen etc.) ReferenzID_Zuord
Int32
nullableID_Projekt ReferenzTyp_Zuord
Int32
nullable86 = Projekt Rolle
Int32Projektrolle.Rolle Referenztyp
Int321 = Subjekt, 12 = Organisationseinheit, 43 = Verbindungen ReferenzId
Int32ID gemäss Referenztyp z.B Refernztyp = 1 dann ID_Subjekt ReferenzBezeichnung
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableAutoSelekt
Int321 = Automatisch selektiert bzw. die Rolle wurde nicht manuell zugewiesen Ansprechpartner
Int32
nullablez.B. Ansprechpartner Eigentümer ReferenzzuordBezeichnung
String
nullableBezeichnung der Referenzzuordnung z.B. Projekt-Nr. ID_Objekt_Gebaeude
Int32
nullableID_Objekt vom übergeordneten Gebäude ID_Objekt_Gebaeudeteil
Int32
nullableID_Objekt vom übergeordneten Gebäudeteil -
GET basis/projektrolle/{id}
Gibt das ProjektRolle Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_ProjektRolle. Response
Name Herkunft Beschreibung ReferenzID_Zuord
Int32ReferenzTyp_Zuord
Int32ID_ProjektRolle
Int32Referenztyp
Int32ReferenzId
Int32Rolle
Int32GueltigVon
DateTimeGueltigBis
DateTime
nullableTyp
Int32
nullableBezeichnung
String
nullable -
POST basis/projektrolle
Erstellt ein neues ProjektRolle Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung ReferenzID_Zuord *required
Int32
(body)ReferenzTyp_Zuord *required
Int32
(body)Referenztyp *required
Int32
(body)ReferenzId *required
Int32
(body)Rolle *required
Int32
(body)GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)Typ
Int32
(body)Bezeichnung
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ReferenzID_Zuord
Int32ReferenzTyp_Zuord
Int32ID_ProjektRolle
Int32Referenztyp
Int32ReferenzId
Int32Rolle
Int32GueltigVon
DateTimeGueltigBis
DateTime
nullableTyp
Int32
nullableBezeichnung
String
nullable -
PUT basis/projektrolle/{id}
Aktualisiert das ProjektRolle Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_ProjektRolle. ReferenzID_Zuord *required
Int32
(body)ReferenzTyp_Zuord *required
Int32
(body)Referenztyp *required
Int32
(body)ReferenzId *required
Int32
(body)Rolle *required
Int32
(body)GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)Typ
Int32
(body)Bezeichnung
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ReferenzID_Zuord
Int32ReferenzTyp_Zuord
Int32ID_ProjektRolle
Int32Referenztyp
Int32ReferenzId
Int32Rolle
Int32GueltigVon
DateTimeGueltigBis
DateTime
nullableTyp
Int32
nullableBezeichnung
String
nullable
-
ProjektRollezuord
Das Objekt ProjektRollezuord unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/projektrollezuord Suchen nach ProjektRollezuord Objekten. -
GET basis/projektrollezuord
Suchen nach ProjektRollezuord Objekten.
Parameters
Name Default Beschreibung Bindung
Int32
(query)Bindung. ReferenzID_Zuord
Int32
(query)ReferenzID_Zuord. ReferenzTyp_Zuord
Int32
(query)ReferenzTyp_Zuord. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_ProjektRolle
Int32ReferenzTyp_Zuord
Int3286 = Projekt ReferenzID_Zuord
Int32ID_Projekt Referenztyp
Int32Systemrolle.Referenztyp 2 = Objekt, 110 = Anlage (Messung/Installation), 112 = Anlage, 115 = Anlage (LRV) ReferenzId
Int32ID gemäss Referenztyp z.B. Referenztyp = 2 dann ID_Objekt ReferenzBezeichnung
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableID_ProjektRollezuord
Int32
-
Standort
Das Objekt Standort unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/standort Suchen nach Standort Objekten. GET basis/standort/{id} Gibt das Standort Objekt mit dem entsprechenden Schlüssel zurück. -
GET basis/standort
Suchen nach Standort Objekten.
Parameters
Name Default Beschreibung GebietBezeichnung *required
String
(query)GebietBezeichnung. HausNrZusatz *required
String
(query)HausNrZusatz. HausNr
Int32
(query)HausNr. Ortsname
String
(query)Ortsname. Postleitzahl
String
(query)Postleitzahl. StrasseLage
String
(query)StrasseLage. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung StrasseLage
String
nullableHausNr
Int16
nullableID_Standort
Int32HausNrZusatz
String
nullableHausNrZusatzSort
String
nullableHausNrSort
Int16
nullableRegionWeiler
String
nullablePLZ_Ort
String
nullableGemeindename
String
nullableGueltigBis
DateTime
nullableLage
String
nullablePostleitzahlZusatzziffer
String
nullableHausNrIndex
String
nullable -
GET basis/standort/{id}
Gibt das Standort Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Standort. Response
Name Herkunft Beschreibung Strassenname
String
nullableID_Standort
Int32ID_Strasse
Int32
nullableStrassennameAlt
String
nullableHausNr
Int16
nullableHausNrAlt
Int16
nullableHausNrZusatz
String
nullableHausNrZusatzAlt
String
nullableRegionWeiler
String
nullablePostleitzahl
String
nullableOrtsname
StringID_Ort
Int32HausNrZusatzSort
String
nullableHausNrSort
Int16
nullableLage
String
nullableBotenbezirk
Int32
nullableID_Gemeinde
Int32
nullableGemeindename
String
nullableLageAdressieren
Int32GueltigBis
DateTime
nullableStrasse
Object
nullableOrt
Object
nullablePostleitzahlZusatzziffer
String
nullableHausNrIndex
String
nullable
-
Strasse
Das Objekt Strasse unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/strasse Suchen nach Strasse Objekten. GET basis/strasse/{id} Gibt das Strasse Objekt mit dem entsprechenden Schlüssel zurück. -
GET basis/strasse
Suchen nach Strasse Objekten.
Parameters
Name Default Beschreibung Strassenname *required
String
(query)Strassenname. Ortsname
String
(query)Ortsname. Postleitzahl
String
(query)Postleitzahl. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung Strassenname
StringID_Strasse
Int32PlzOrt
StringGemeindename
String
nullableID_Gemeinde
Int32
nullableID_Ort
Int32RegionWeiler
String
nullableStrassennameAlt
String
nullableEidgStrassenId
Int32
nullable -
GET basis/strasse/{id}
Gibt das Strasse Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Strasse. Response
Name Herkunft Beschreibung Strassenname
StringStrassennameAlt
String
nullableRegionWeiler
String
nullableNation
String
nullableSYSTEM.Nation ID_Ort
Int32PlzOrt
StringGemeindename
String
nullableStrasseNr
Int64
nullableGueltigBis
DateTime
nullableEidgStrassenId
Int32
nullable
-
Subjekt
Das Objekt Subjekt unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/subjekt Suchen nach Subjekt Objekten. GET basis/subjekt/{id} Gibt das Subjekt Objekt mit dem entsprechenden Schlüssel zurück. POST basis/subjekt Erstellt ein neues Subjekt Objekt mit den übergebenen Werten. PUT basis/subjekt/{id} Aktualisiert das Subjekt Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/subjekt
Suchen nach Subjekt Objekten.
Parameters
Name Default Beschreibung AI
Int32
(query)AI. AufrufAus
Int16
(query)99 AufrufAus. Funktion
Int32
(query)Funktion. Geburtsdatum
String
(query)Geburtsdatum. GeschlRechtsf
Int32
(query)GeschlRechtsf. GruppeAktuell
Int32
(query)GruppeAktuell. GruppeVergangene
Int32
(query)GruppeVergangene. GruppeZukuenftige
Int32
(query)GruppeZukuenftige. HausNr
Int32
(query)HausNr. HausNrZusatz
String
(query)HausNrZusatz. ID_Subjekt
Int32
(query)ID_Subjekt. ID_Subjektgruppe
Int32
(query)ID_Subjektgruppe. KomArt
Int32
(query)KomArt. KomNummer
String
(query)KomNummer. Name
String
(query)Name. Namensfrgm
Int32
(query)Namensfrgm. Nummer
String
(query)Nummer. Ortsname
String
(query)Ortsname. Postleitzahl
String
(query)Postleitzahl. Strasse
String
(query)Strasse. Subjektart
Int32
(query)Subjektart. Typ
Int32
(query)Typ. UnternehmensID
String
(query)UnternehmensID. VerbAktuell
Int32
(query)VerbAktuell. VerbFunktion
Int32
(query)VerbFunktion. VerbindungAnzeigen
Int32
(query)0 VerbindungAnzeigen. VerbindungEinschliessen
Int32
(query)VerbindungEinschliessen. VerbZuordTyp
Int32
(query)VerbZuordTyp. VersichertenNr
String
(query)VersichertenNr. Vorname
String
(query)Vorname. WohnungsNr
String
(query)WohnungsNr. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Subjekt
Int32Anrede
String
nullableName
String
nullableZusatzname
String
nullableVorname
String
nullableGeschlRechtsform
Int32
nullableSubjekt.GeschlRechtsf Status
Int32System.AktivInaktiv Adresse
String
nullableProvisorisch
Int32
nullableNULL = reines Subjekt, 0 = nicht provisorischer Einwohner, 1 = provisorischer Einwohner Geburtsdatum
String
nullableSterbedatum
DateTime
nullableTypStatus
String
nullableSubjektTyp
String
nullableSubjekt.Typ Einwohnerstatus
Int32
nullableEinwohner.Status ID_Adresse
Int32
nullableStrasse
StringHausNr
Int32
nullableHausNrZusatz
StringPostleitzahl
StringOrtsname
StringVerbindung
StringVerbindungTyp
Int32
nullableSubjektzuord.ZuordnungTyp ID_Subjektzuord
Int32
nullable -
GET basis/subjekt/{id}
Gibt das Subjekt Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Subjekt. IncludeAdressen
Boolean
(query)IncludeKommunikation
Boolean
(query)Response
Name Herkunft Beschreibung Name
String
nullableVorname
String
nullableAnrede
Int32
nullableSubjekt.Anrede Zusatzname
String
nullableKorrsprache
Int32
nullableSystem.Sprache Subjektart
Int32Subjekt.SubjektArt Kuerzel
String
nullableInaktivDatum
DateTime
nullableSterbedatum
DateTime
nullableWeggezogen
Int32
nullableGeschlRechtsf
Int32
nullableSubjekt.GeschlRechtsf Konfession
Int32
nullableSubjekt.Konfession Zivilstand
Int32
nullableSubjekt.Zivilstand Zivilstanddatum
DateTime
nullableZivilstanddatumUnb
Int32
nullableNationalitaet
Int32
nullableSystem.Nation Titel
String
nullableBeruf
Int32
nullableSubjekt.Beruf Erwerbsart
Int32
nullableSubjekt.Erwerbsart Geburtsdatum
DateTime
nullableGeburtsdatumUnb
Int32
nullableSystem.DatumUnbekannt Branche
Int32
nullableSubjekt.Branche ID_Subjekt
Int32VersichertenNr
String
nullableUnternehmensID_Kategorie
String
nullableUnternehmensID
String
nullableSubjektTyp
String
nullableSubjekt.Typ Titelstellung
Int32
nullableSubjekt.TitelStellung VernetzteUnternehmensID_Kategorie
String
nullableVernetzteUnternehmensID
String
nullable -
POST basis/subjekt
Erstellt ein neues Subjekt Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Name
String
(body)Vorname
String
(body)Anrede
Int32
(body)Zusatzname
String
(body)Korrsprache
Int32
(body)Subjektart *required
Int32
(body)Kuerzel
String
(body)InaktivDatum
DateTime
(body)Sterbedatum
DateTime
(body)Weggezogen
Int32
(body)GeschlRechtsf
Int32
(body)Konfession
Int32
(body)Zivilstand
Int32
(body)Zivilstanddatum
DateTime
(body)ZivilstanddatumUnb
Int32
(body)Nationalitaet
Int32
(body)Titel
String
(body)Beruf
Int32
(body)Erwerbsart
Int32
(body)Geburtsdatum
DateTime
(body)GeburtsdatumUnb
Int32
(body)Branche
Int32
(body)VersichertenNr
String
(body)UnternehmensID_Kategorie
String
(body)UnternehmensID
String
(body)SubjektTyp
String
(body)Titelstellung
Int32
(body)VernetzteUnternehmensID_Kategorie
String
(body)VernetzteUnternehmensID
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung Name
String
nullableVorname
String
nullableAnrede
Int32
nullableSubjekt.Anrede Zusatzname
String
nullableKorrsprache
Int32
nullableSystem.Sprache Subjektart
Int32Subjekt.SubjektArt Kuerzel
String
nullableInaktivDatum
DateTime
nullableSterbedatum
DateTime
nullableWeggezogen
Int32
nullableGeschlRechtsf
Int32
nullableSubjekt.GeschlRechtsf Konfession
Int32
nullableSubjekt.Konfession Zivilstand
Int32
nullableSubjekt.Zivilstand Zivilstanddatum
DateTime
nullableZivilstanddatumUnb
Int32
nullableNationalitaet
Int32
nullableSystem.Nation Titel
String
nullableBeruf
Int32
nullableSubjekt.Beruf Erwerbsart
Int32
nullableSubjekt.Erwerbsart Geburtsdatum
DateTime
nullableGeburtsdatumUnb
Int32
nullableSystem.DatumUnbekannt Branche
Int32
nullableSubjekt.Branche ID_Subjekt
Int32VersichertenNr
String
nullableUnternehmensID_Kategorie
String
nullableUnternehmensID
String
nullableSubjektTyp
String
nullableSubjekt.Typ Titelstellung
Int32
nullableSubjekt.TitelStellung VernetzteUnternehmensID_Kategorie
String
nullableVernetzteUnternehmensID
String
nullable -
PUT basis/subjekt/{id}
Aktualisiert das Subjekt Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Subjekt. Name
String
(body)Vorname
String
(body)Anrede
Int32
(body)Zusatzname
String
(body)Korrsprache
Int32
(body)Subjektart *required
Int32
(body)Kuerzel
String
(body)InaktivDatum
DateTime
(body)Sterbedatum
DateTime
(body)Weggezogen
Int32
(body)GeschlRechtsf
Int32
(body)Konfession
Int32
(body)Zivilstand
Int32
(body)Zivilstanddatum
DateTime
(body)ZivilstanddatumUnb
Int32
(body)Nationalitaet
Int32
(body)Titel
String
(body)Beruf
Int32
(body)Erwerbsart
Int32
(body)Geburtsdatum
DateTime
(body)GeburtsdatumUnb
Int32
(body)Branche
Int32
(body)VersichertenNr
String
(body)UnternehmensID_Kategorie
String
(body)UnternehmensID
String
(body)SubjektTyp
String
(body)Titelstellung
Int32
(body)VernetzteUnternehmensID_Kategorie
String
(body)VernetzteUnternehmensID
String
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung Name
String
nullableVorname
String
nullableAnrede
Int32
nullableSubjekt.Anrede Zusatzname
String
nullableKorrsprache
Int32
nullableSystem.Sprache Subjektart
Int32Subjekt.SubjektArt Kuerzel
String
nullableInaktivDatum
DateTime
nullableSterbedatum
DateTime
nullableWeggezogen
Int32
nullableGeschlRechtsf
Int32
nullableSubjekt.GeschlRechtsf Konfession
Int32
nullableSubjekt.Konfession Zivilstand
Int32
nullableSubjekt.Zivilstand Zivilstanddatum
DateTime
nullableZivilstanddatumUnb
Int32
nullableNationalitaet
Int32
nullableSystem.Nation Titel
String
nullableBeruf
Int32
nullableSubjekt.Beruf Erwerbsart
Int32
nullableSubjekt.Erwerbsart Geburtsdatum
DateTime
nullableGeburtsdatumUnb
Int32
nullableSystem.DatumUnbekannt Branche
Int32
nullableSubjekt.Branche ID_Subjekt
Int32VersichertenNr
String
nullableUnternehmensID_Kategorie
String
nullableUnternehmensID
String
nullableSubjektTyp
String
nullableSubjekt.Typ Titelstellung
Int32
nullableSubjekt.TitelStellung VernetzteUnternehmensID_Kategorie
String
nullableVernetzteUnternehmensID
String
nullable
-
SubjektAnschrift
Das Objekt SubjektAnschrift unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/subjektanschrift/{id} Gibt das SubjektAnschrift Objekt mit dem entsprechenden Schlüssel zurück. -
GET basis/subjektanschrift/{id}
Gibt das SubjektAnschrift Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id
Int32
(query)Doppeladressierung. Response
Name Herkunft Beschreibung Briefanschrift
StringBriefanrede
String
-
SubjektKontaktperson
Das Objekt SubjektKontaktperson unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/subjektkontaktperson Suchen nach SubjektKontaktperson Objekten. -
GET basis/subjektkontaktperson
Suchen nach SubjektKontaktperson Objekten.
Parameters
Name Default Beschreibung AktivInaktiv *required
Int32
(query)AktivInaktiv. AlleAdressarten *required
Int32
(query)AlleAdressarten. Geburtsdatum *required
DateTime
(query)Geburtsdatum. ID_Subjekt *required
Int32
(query)ID_Subjekt. Name *required
String
(query)Name. Ortsname *required
String
(query)Ortsname. PLZ *required
String
(query)PLZ. StrasseHaus *required
String
(query)StrasseHaus. Vorname *required
String
(query)Vorname. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung AnzeigeName
String
nullableID_Subjekt
Int32Firmenname
String
nullableName
String
nullableZusatzname
String
nullableVorname
String
nullableAnrede
String
nullableTitel
String
nullableTelefon
String
nullableTelefax
String
nullableMobil
String
nullableEmail
String
nullableAdressZusatz
String
nullableStrasseHaus
String
nullableStrasseZusatz
String
nullablePLZ
String
nullableOrt
String
nullablePlzOrt
String
nullableNation
String
nullableSystem.Nation Geburtsdatum
DateTime
nullablePostleitzahlZusatzziffer
String
nullableBriefanschrift
String
nullableBriefanrede
String
nullableAdressart
String
nullableSubjektart_Cd
Int32Subjekt.SubjektArt ID_Subjektzuord
Int32
nullableAktivInaktiv_Cd
StringAktivInaktiv
StringPostfachtext_Cd
Int32
nullableAdresse.Postfachtext Postfachtext
String
nullablePostfach
Int32
nullablePostfach_PLZ
String
nullablePostfach_Ort
String
nullable
-
SubjektRolle
Das Objekt SubjektRolle unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/subjektrolle Suchen nach SubjektRolle Objekten. -
GET basis/subjektrolle
Suchen nach SubjektRolle Objekten.
Parameters
Name Default Beschreibung ID_Subjekt *required
Int32
(query)ID_Subjekt. IgnoreVerwendungen
Int32
(query)IgnoreVerwendungen. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung RolleVertragspartner
Int32
nullable0 = False / 1 = True RolleZustelladresse
Int32
nullable0 = False / 1 = True RolleVermieter
Int32
nullable0 = False / 1 = True
-
Subjektzuord
Das Objekt Subjektzuord unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/subjektzuord Suchen nach Subjektzuord Objekten. GET basis/subjektzuord/{id} Gibt das Subjektzuord Objekt mit dem entsprechenden Schlüssel zurück. POST basis/subjektzuord Erstellt ein neues Subjektzuord Objekt mit den übergebenen Werten. PUT basis/subjektzuord/{id} Aktualisiert das Subjektzuord Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/subjektzuord
Suchen nach Subjektzuord Objekten.
Parameters
Name Default Beschreibung Ueber_ID_Subjekt *required
Int32
(query)Ueber_ID_Subjekt. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Subjektzuord
Int32Zuordnungtyp
Int32Subjektzuord.ZuordnungTyp Funktion
Int32
nullableSubjektzuord.Funktion Unter_ID_Subjekt
Int32
nullableSubjekt
String
nullableGueltigVon
DateTimeGueltigBis
DateTime
nullableAktiv
Int32
nullableID_Einmaladresse
Int32
nullable -
GET basis/subjektzuord/{id}
Gibt das Subjektzuord Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Subjektzuord. Response
Name Herkunft Beschreibung Ueber_ID_Subjekt
Int32Unter_ID_Subjekt
Int32
nullableZuordnungtyp
Int32Subjektzuord.ZuordnungTyp Funktion
Int32
nullableSubjektzuord.Funktion GueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjektzuord
Int32Notiz
String
nullableID_Einmaladresse
Int32
nullable -
POST basis/subjektzuord
Erstellt ein neues Subjektzuord Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Ueber_ID_Subjekt *required
Int32
(body)Unter_ID_Subjekt
Int32
(body)Zuordnungtyp *required
Int32
(body)Funktion
Int32
(body)GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)Notiz
String
(body)ID_Einmaladresse
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung Ueber_ID_Subjekt
Int32Unter_ID_Subjekt
Int32
nullableZuordnungtyp
Int32Subjektzuord.ZuordnungTyp Funktion
Int32
nullableSubjektzuord.Funktion GueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjektzuord
Int32Notiz
String
nullableID_Einmaladresse
Int32
nullable -
PUT basis/subjektzuord/{id}
Aktualisiert das Subjektzuord Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Subjektzuord. Ueber_ID_Subjekt *required
Int32
(body)Unter_ID_Subjekt
Int32
(body)Zuordnungtyp *required
Int32
(body)Funktion
Int32
(body)GueltigVon *required
DateTime
(body)GueltigBis
DateTime
(body)Notiz
String
(body)ID_Einmaladresse
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung Ueber_ID_Subjekt
Int32Unter_ID_Subjekt
Int32
nullableZuordnungtyp
Int32Subjektzuord.ZuordnungTyp Funktion
Int32
nullableSubjektzuord.Funktion GueltigVon
DateTimeGueltigBis
DateTime
nullableID_Subjektzuord
Int32Notiz
String
nullableID_Einmaladresse
Int32
nullable
-
UebergeordneteSubjektzuord
Das Objekt UebergeordneteSubjektzuord unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/uebergeordnetesubjektzuord Suchen nach UebergeordneteSubjektzuord Objekten. -
GET basis/uebergeordnetesubjektzuord
Suchen nach UebergeordneteSubjektzuord Objekten.
Parameters
Name Default Beschreibung Unter_ID_Subjekt *required
Int32
(query)Unter_ID_Subjekt. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung Ueber_ID_Subjekt
Int32Funktion
Int32
nullableSubjektzuord.Funktion Zuordnungtyp
Int32Subjektzuord.ZuordnungTyp ID_Subjektzuord
Int32GueltigVon
DateTimeSubjekt
String
nullableGueltigBis
DateTime
nullableAktiv
Int32
nullable
-
Versand
Das Objekt Versand unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/versand Suchen nach Versand Objekten. -
GET basis/versand
Suchen nach Versand Objekten.
Parameters
Name Default Beschreibung ReferenzId *required
Int32
(query)ReferenzId. Referenztyp *required
Int32
(query)Referenztyp. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung Bereich
String
nullableBereichstyp
String
nullableVersandart
Int32ID_Versand
Int32ID_Systemrolle
Int32
nullableSystemrolleBezeichnung
String
nullableEmpfaenger_ID
String
nullableVermerk
String
nullableStatus
String
nullableVersandartBezeichnung
String
nullableStatusBemerkung
String
nullable
-
Verwendungrolle
Das Objekt Verwendungrolle unterstützt die folgenden Endpunkte.
Endpunkt Beschreibung GET basis/verwendungrolle Suchen nach Verwendungrolle Objekten. GET basis/verwendungrolle/{id} Gibt das Verwendungrolle Objekt mit dem entsprechenden Schlüssel zurück. POST basis/verwendungrolle Erstellt ein neues Verwendungrolle Objekt mit den übergebenen Werten. PUT basis/verwendungrolle/{id} Aktualisiert das Verwendungrolle Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten. -
GET basis/verwendungrolle
Suchen nach Verwendungrolle Objekten.
Parameters
Name Default Beschreibung ID *required
Int32
(query)ID. Referenztyp *required
Int32
(query)Referenztyp. Response
Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.
Name Herkunft Beschreibung ID_Verwendung
Int32SWSystem
StringTeilanwendungAnwendobjekt
StringBezeichnung
StringID_Verwendungrolle
Int32GueltigVon
DateTime
nullableGueltigBis
DateTime
nullableID
String
nullableID2
String
nullableID_Systemrolle
Int32
nullableMandant
String
nullableRolle
String -
GET basis/verwendungrolle/{id}
Gibt das Verwendungrolle Objekt mit dem entsprechenden Schlüssel zurück.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Verwendungrolle. Response
Name Herkunft Beschreibung ID_Verwendungrolle
Int32Verwendungrolle_ID
String
nullableVerwendungrolle_ID2
String
nullableVerwendungrolle_GueltigVon
DateTime
nullableVerwendungrolle_GueltigBis
DateTime
nullableVerwendungrolle_Bezeichnung
String
nullableVerwendungrolle_Mandant
String
nullableVerwendungrolle_ID_Systemrolle
Int32Systemrolle_Referenztyp
Int32
nullableVW_ReferenzID
Int32VW_Referenztyp
Int32Verwendungrolle_Rolle
Int32
nullable -
POST basis/verwendungrolle
Erstellt ein neues Verwendungrolle Objekt mit den übergebenen Werten.
Parameters
Name Default Beschreibung Verwendungrolle_ID
String
(body)Verwendungrolle_ID2
String
(body)Verwendungrolle_GueltigVon
DateTime
(body)Verwendungrolle_GueltigBis
DateTime
(body)Verwendungrolle_Bezeichnung
String
(body)Verwendungrolle_Mandant
String
(body)Verwendungrolle_ID_Systemrolle *required
Int32
(body)Systemrolle_Referenztyp
Int32
(body)VW_ReferenzID *required
Int32
(body)VW_Referenztyp *required
Int32
(body)Verwendungrolle_Rolle
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Verwendungrolle
Int32Verwendungrolle_ID
String
nullableVerwendungrolle_ID2
String
nullableVerwendungrolle_GueltigVon
DateTime
nullableVerwendungrolle_GueltigBis
DateTime
nullableVerwendungrolle_Bezeichnung
String
nullableVerwendungrolle_Mandant
String
nullableVerwendungrolle_ID_Systemrolle
Int32Systemrolle_Referenztyp
Int32
nullableVW_ReferenzID
Int32VW_Referenztyp
Int32Verwendungrolle_Rolle
Int32
nullable -
PUT basis/verwendungrolle/{id}
Aktualisiert das Verwendungrolle Objekt mit dem entsprechenden Schlüssel mit den übergebenen Werten.
Parameters
Name Default Beschreibung id *required
Int32
(query)ID_Verwendungrolle. Verwendungrolle_ID
String
(body)Verwendungrolle_ID2
String
(body)Verwendungrolle_GueltigVon
DateTime
(body)Verwendungrolle_GueltigBis
DateTime
(body)Verwendungrolle_Bezeichnung
String
(body)Verwendungrolle_Mandant
String
(body)Verwendungrolle_ID_Systemrolle *required
Int32
(body)Systemrolle_Referenztyp
Int32
(body)VW_ReferenzID *required
Int32
(body)VW_Referenztyp *required
Int32
(body)Verwendungrolle_Rolle
Int32
(body)Response
Das Ergebnis enthält die Felder SuccessfullyCompleted (bool), ErrorMessage (string) und Entity.
Mit dem Feld SuccessfullyCompleted wird kommuniziert ob die Anfrage erfolgreich ausgeführt wurde (true), oder fehlgeschlagen ist (false). Falls die Anfrage fehlgeschlagen ist enhtält das Feld ErrorMessage die Fehlerursache. Wenn die Anfrage erfolgreich war, werden die effektiven Daten der Entität nach dem Speichern im Feld Entity zurückgegeben.Name Herkunft Beschreibung ID_Verwendungrolle
Int32Verwendungrolle_ID
String
nullableVerwendungrolle_ID2
String
nullableVerwendungrolle_GueltigVon
DateTime
nullableVerwendungrolle_GueltigBis
DateTime
nullableVerwendungrolle_Bezeichnung
String
nullableVerwendungrolle_Mandant
String
nullableVerwendungrolle_ID_Systemrolle
Int32Systemrolle_Referenztyp
Int32
nullableVW_ReferenzID
Int32VW_Referenztyp
Int32Verwendungrolle_Rolle
Int32
nullable