innoconnect / Helper

Übersicht

  • GET account/up/auth?username={username}&password={password}

    Parameters
    Name Beschreibung
    username
    String
    (query)
    password
    String
    (query)
    Response
    Name Beschreibung
    success
    Boolean

  • GET account/up/{token}

    Parameters
    Name Beschreibung
    token
    String
    (query)
    Response
    Name Beschreibung
    success
    Boolean

  • GET account/sm/auth?username={serial1}&password={serial2}

    Parameters
    Name Beschreibung
    serial1
    String
    (query)
    serial2
    String
    (query)
    Response
    Name Beschreibung
    success
    Boolean

  • GET account/sn/{token}

    Parameters
    Name Beschreibung
    token
    String
    (query)
    Response
    Name Beschreibung
    success
    Boolean

  • auskunft

    Das Objekt auskunft unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST auskunft Gibt Informationen eines Subjekts zurück.
    POST auskunft/{id}/document Erzeugt das Auskunfts-Dokument.

  • POST auskunft

    Gibt Informationen eines Subjekts zurück.

    Parameters
    Name Beschreibung
    ID_Auskunft
    Int32
    (body)     		Die ID_Auskunft für den Dokument-Bezug
    Bezahlt
    Int32
    (body)     		Gibt an, ob die Auskunft bezahlt wurde.
    Betrag
    Decimal
    (body)     		Der Betrag, der zu bezahlen ist.
    DokumentTemplate
    DokumentTemplate
    (body)     		Das Dokument zur Legitimierung für nicht registrierte Anfragesteller.
    EventPersonInformation
    eventPersonInformation
    (body)     		Identifiziert den Anfragesteller.
    ExterneReferenzNr
    String
    (body)     		Enthält die externe Referenz-Nummer des Auskunft. (Maximal 100 Zeichen).
    Response

    Die Auskunft.

    Name Beschreibung
    ID_Auskunft
    Int32
    nullable     		Die ID_Auskunft für den Dokument-Bezug.
    ID_Aktivitaet
    Int32
    nullable     		Die ID_Aktivitaet bei synchronser Verarbeitung.
    EventPersonInformationResponse
    eventPersonInformationResponse     		Die Auskunft.

  • POST auskunft/{id}/document

    Erzeugt das Auskunfts-Dokument.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID_Auskunft, für die das Dokument erstellt werden soll.
    Response

    Die Doukment-Daten.

    Name Beschreibung
    value
    Stream

  • ausweis

    Das Objekt ausweis unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST ausweis/{id}/document Erzeugt das Ausweis-Dokument.

  • POST ausweis/{id}/document

    Erzeugt das Ausweis-Dokument.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID_Ausweis, für welche das Dokument erstellt werden soll.
    Response

    Das Ausweis-Dokument.

    Name Beschreibung
    value
    Stream

  • citysofteinwohner

    Das Objekt citysofteinwohner unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET citysofteinwohner/{id} Gibt einen Einwohner mit allen relevanten Daten für das Umsystem Citysoft zurück. Die Attribute sind - wo möglich mit Bezeichnungen gemäss eCH-Standards.

  • GET citysofteinwohner/{id}

    Gibt einen Einwohner mit allen relevanten Daten für das Umsystem Citysoft zurück. Die Attribute sind - wo möglich mit Bezeichnungen gemäss eCH-Standards.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID_Subjekt des Einwohners.
    Response

    Einwohnerdaten gemäss Citysoft-Anforderungen. Wo möglich, werden die Rückgabewerte gemäss eCH-Standard geliefert.

    Name Beschreibung
    personId
    Int32
    dateOfBirth
    String
    sex
    String
    firstname
    String
    officialName
    String
    vn
    String
    meldeadresse
    CitysoftAdresse
    aufenthaltadresse
    CitysoftAdresse
    zustelladresse
    CitysoftAdresse
    wegzugsadresse
    CitysoftAdresse
    zemisNr
    String
    nationality
    String
    nationalityStatus
    String
    callName
    String
    originalName
    String
    originname
    String
    originnameCanton
    String
    residencePermit
    String
    residencePermitValidTill
    String
    residencePermitValidFrom
    String
    entryDate
    String
    maritalStatus
    String
    dateOfMaritalStatus
    String
    cancelationReason
    String
    separation
    String
    separationValidFrom
    String
    separationValidTill
    String
    deathDateFrom
    String
    religion
    String
    guardianTypeOfRelationship
    String
    dataLock
    String
    languageOfCorrespondance
    String
    aktiv
    String
    zuzug
    CitysoftDestination
    wegzug
    CitysoftDestination

  • datensicht

    Das Objekt datensicht unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET datensicht/{datensichtId}?referenzTyp={referenzTyp}&datensatzId={datensatzId} Gibt die Daten einer Datensicht zurück.

  • GET datensicht/{datensichtId}?referenzTyp={referenzTyp}&datensatzId={datensatzId}

    Gibt die Daten einer Datensicht zurück.

    Parameters
    Name Beschreibung
    datensichtId
    String
    (query)     		Die ID der Datensicht.
    referenzTyp
    String
    (query)     		Der Referenztyp des Datensatzes.
    datensatzId
    String
    (query)     		Die ID des Datensatzes.
    Response

    Die Daten der Datensicht.

    Name Beschreibung
    value
    Object

  • document

    Das Objekt document unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST document Speichert ein Dokument im DMS.
    GET document/{id}/{version}/data Gibt ein im DMS gespeichertes Dokument zurück.
    GET document/{id}/{version}/filename Gibt den Dateinamen eines im DMS gespeicherten Dokuments zurück.

  • POST document

    Speichert ein Dokument im DMS.

    Parameters
    Name Beschreibung
    Data
    Byte[]
    (body)
    SourceFileName
    String
    (body)
    Bezeichnung
    String
    (body)
    ReferenzTyp
    Int32
    (body)
    ReferenzNr
    Int32
    (body)
    Typ
    Int32
    (body)
    Speichermodus
    Int32
    (body)
    Standort
    Int32
    (body)
    Ablageart
    Int32
    (body)
    Sprache
    Int32
    (body)
    Erstelldatum
    DateTime
    (body)
    Notiz
    String
    (body)
    DocumentImportMode
    Int32
    (body)
    DocumentReferences
    Collection of DocumentReference
    (body)
    Response

    Die ID des gespeicherten Dokuments.

    Name Beschreibung
    value
    Int32

  • GET document/{id}/{version}/data

    Gibt ein im DMS gespeichertes Dokument zurück.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID des Dokuments.
    version
    String
    (query)     		Die Version des Dokuments.
    Response

    Der Datenstrom, der die Daten des Dokuments enthält.

    Name Beschreibung
    value
    Stream

  • GET document/{id}/{version}/filename

    Gibt den Dateinamen eines im DMS gespeicherten Dokuments zurück.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID des Dokuments.
    version
    String
    (query)     		Die Version des Dokuments.
    Response

    Den Dateinamen des Dokuments.

    Name Beschreibung
    value
    String

  • documentreferences

    Das Objekt documentreferences unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET documentreferences/{type}/{number}

  • GET documentreferences/{type}/{number}

    Parameters
    Name Beschreibung
    type
    String
    (query)     		Der ReferenzTyp.
    number
    String
    (query)     		Die ReferenzNummer.
    Response

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    ID_Dokument
    Int32
    Bezeichnung
    String
    FileName
    String
    AblageArt
    Int32
    LaufNr_Dokument
    Int32
    nullable

  • enablecrmmessages

    Das Objekt enablecrmmessages unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST enablecrmmessages Setzt das Flag "Empfängt Aktivitaetnachrichten" im entsprechenden Softwaresystem.

  • POST enablecrmmessages

    Setzt das Flag "Empfängt Aktivitaetnachrichten" im entsprechenden Softwaresystem.

    Parameters

    Dieser Endpunkt unterstützt keine Parameter.

    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • invoice

    Das Objekt invoice unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST invoice Nimmt eine Rechnung entgegen.
    GET invoice/{id}/document?isExternalIdRechnung={isExternalIdRechnung} Gibt das Rechnungsdokument zurück.
    POST invoice/overview Führt eine Datenbank-Abfrage für die Rechnungsübersicht durch und gibt das Resultat zurück.

  • POST invoice

    Nimmt eine Rechnung entgegen.

    Parameters
    Name Beschreibung
    TransactionId
    Int64
    (body)     		Die Transaktions-Id.
    Invoice
    Byte[]
    (body)     		Die binären Daten der Rechnung als base64 encodierten String.
    Mandant
    String
    (body)     		...
    Response

    true, falls die Rechnung entgegengenommen werden konnte, sonst false.

    Name Beschreibung
    value
    Boolean

  • GET invoice/{id}/document?isExternalIdRechnung={isExternalIdRechnung}

    Gibt das Rechnungsdokument zurück.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID der Rechnung.
    isExternalIdRechnung
    Boolean
    (query)     		Definiert, ob die übergebene ID_Rechnung eine ID_Rechnung_Extern ist.
    Response

    Der Datenstrom, der die Daten des Dokuments enthält.

    Name Beschreibung
    value
    Stream

  • POST invoice/overview

    Führt eine Datenbank-Abfrage für die Rechnungsübersicht durch und gibt das Resultat zurück.

    Parameters
    Name Beschreibung
    ID_RGUebersicht_Tabelle
    Int32
    (body)     		Die ID der gewünschten Tabelle
    ID_RGUebersicht_Config
    Int32
    (body)     		Die ID der Konfiguration (optional)
    ID_Subjekt
    Int32
    (body)     		Einschränkung nach einem Subjekt
    Zustell_ID_Subjekt
    Int32
    (body)     		Einschränkung nach dem Subjekt der Zustelladresse
    ID_Objekt
    Int32
    (body)     		Einschränkung nach einem Objekt
    ID_Sammelrechnung
    Int32
    (body)     		Einschränkung nach einer Sammelrechnung
    ID_Vertrag
    Int32
    (body)     		Einschränkung nach einem Vertrag
    TerminVon
    DateTime
    (body)     		Einschränkung ab Termin-Datum
    TerminBis
    DateTime
    (body)     		Einschränkung bis Termin-Datum
    Stichdatum
    DateTime
    (body)     		Steuert die Ermittlung des Subjekts, wenn die Subjekte zusammengefasst werden. (Standard: Tagesdatum)
    SubjekteZusammenfassen
    Int32
    (body)     		Definiert, ob die Daten mehrerer Subjekte auf ein Subjekt zusammengefasst werden sollen. (Standard: Nein)
    Response

    Das Resultat der Abfrage als Zeichenkette.

    Name Beschreibung
    value
    String

  • meterdata

    Das Objekt meterdata unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST meterdata/v1/reading/result
    POST meterdata/v1/function/result

  • POST meterdata/v1/reading/result

    Parameters
    Name Beschreibung
    ProcessId
    String
    (body)
    IsCompleted
    Boolean
    (body)
    Meterdata
    IEnumerable`1
    (body)
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • POST meterdata/v1/function/result

    Parameters
    Name Beschreibung
    ProcessId
    String
    (body)
    Result
    String
    (body)
    Value
    String
    (body)
    Unit
    String
    (body)
    Message
    String
    (body)
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • meterdataresult

    Das Objekt meterdataresult unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST meterdataresult/v1

  • POST meterdataresult/v1

    Parameters
    Name Beschreibung
    ProcessId
    String
    (body)
    IsCompleted
    Boolean
    (body)
    Meterdata
    IEnumerable`1
    (body)
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • onp

    Das Objekt onp unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET onp/customer-info/{msisdn} Gibt die Kunden-Informationen (Vertragsgültigkeit) für den Versand von SMS zurück.

  • GET onp/customer-info/{msisdn}

    Gibt die Kunden-Informationen (Vertragsgültigkeit) für den Versand von SMS zurück.

    Parameters
    Name Beschreibung
    msisdn
    String
    (query)     		Die Mobile-Nummer des Kunden.
    Response

    Die Kunden-Informationen, falls vorhanden.

    Name Beschreibung
    first_name
    String
    last_name
    String
    company_name
    String
    expiration_date
    String
    termination_fee
    Decimal
    nullable
    language
    String

  • ping

    Das Objekt ping unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET ping Diese Methode dient zur Überprüfung der Verfügbarkeit des Service.

  • GET ping

    Diese Methode dient zur Überprüfung der Verfügbarkeit des Service.

    Parameters

    Dieser Endpunkt unterstützt keine Parameter.

    Response

    Versions-Informationen über den installierten Release.

    Name Beschreibung
    value
    String

  • portalkunde

    Das Objekt portalkunde unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST portalkunde/{id}/register Registriert ein Subjekt als Portalkunde.
    POST portalkunde/{id}/deregister Deregistriert ein Subjekt als Portalkunde.

  • POST portalkunde/{id}/register

    Registriert ein Subjekt als Portalkunde.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID des Subjekts, das registriert werden soll.
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • POST portalkunde/{id}/deregister

    Deregistriert ein Subjekt als Portalkunde.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID des Subjekts, das deregistriert werden soll.
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • preisrechner

    Das Objekt preisrechner unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST preisrechner Berechnet die Preise von Produkten

  • POST preisrechner

    Berechnet die Preise von Produkten

    Parameters
    Name Beschreibung
    ID_PreisrechnerConfig
    Int32
    (body)     		Id der Preisrechnerkonfiguration
    TerminJahr
    Int32
    (body)     		Das Jahr des Termins, zu dem die Preise berechnet werden sollen. Wenn kein Jahr übergeben wird, wird der nächste Abrechnungstermin ab dem Standard-Stichdatum verwendet.
    ID_Subjekt
    Int32
    (body)     		Die Subjekt-Id des bestehenden Kunden.
    ID_Objekt
    Int32
    (body)     		Die Objekt-Id des bestehenden Kunden. Es darf entweder eine Objekt-Id oder eine Gegenstands-Id angegeben werden. Beides zusammen ist nicht möglich.
    ID_Gegenstand
    Int32
    (body)     		Die Gegenstands-Id des bestehenden Kunden. Es darf entweder eine Objekt-Id oder eine Gegenstands-Id angegeben werden. Beides zusammen ist nicht möglich.
    Sprache
    Int32
    (body)     		Die Sprache für die Übersetzung der Resultate. Wenn keine Sprache angegeben wird, wird die Systemsprache verwendet. Wertebereich: System.Sprache
    Products
    Collection of PriceCalculatorProduct
    (body)     		Liste der Produkte, für die die Preise berechnet werden sollen
    Parameters
    Collection of PriceCalculatorParameter
    (body)     		Liste der Parameter; Es müssen alle benötigten Parameter mitgegeben werden, ansonsten können bei der Berechnung Fehler auftreten.
    Response

    Resultat der Berechnung

    Name Beschreibung
    Result
    PriceCalculatorResult

  • projekt

    Das Objekt projekt unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET projekt/{id}/nextprojektaktivitaetvorlage Ermittelt die ausführbaren Aktivitätsvorlagen eines Projekts.
    POST projekt Es wird ein neues Projekt erstellt, wenn keine ID_Projekt übergeben wird. Bei einem bestehende Projekt können die Projekt-Nr., das BasisDatum und die Beschreibung geändert werden, wenn ID_Projekt übergeben wird. Ist die Projekt-Nr., das BasisDatum oder die Beschreibung leer wird der Eintrag auf dem Projekt gelöscht. Entspricht die übergebene Beschreibung nicht der Beschreibung des Projektes, so wird die Beschreibung geändert und verliert die Formatierung. Die ID_ProjektParam, die ID_AktivitaetsVorlage, die ID_AktivitaetAblauf und die ID_Workflowdefinition werden nicht berücksichtigt, wenn ID_Projekt übergeben wird.
    POST projekt/{id}/aktivitaet Erstellt eine neue Aktivtiät im Prozess.

  • GET projekt/{id}/nextprojektaktivitaetvorlage

    Ermittelt die ausführbaren Aktivitätsvorlagen eines Projekts.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID des gewünschten Projekts.
    Response

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    ID_AktivitaetVorlage
    Int32
    ID_ProjektParam
    Int32
    Thema
    Int32
    Aktion
    Int32
    ID_AktivitaetAblauf
    Int32
    nullable
    Bezeichnung
    String
    GueltigVon
    DateTime
    nullable
    GueltigBis
    DateTime
    nullable
    ID_Workflowdefinition
    Int32
    nullable

  • POST projekt

    Es wird ein neues Projekt erstellt, wenn keine ID_Projekt übergeben wird. Bei einem bestehende Projekt können die Projekt-Nr., das BasisDatum und die Beschreibung geändert werden, wenn ID_Projekt übergeben wird. Ist die Projekt-Nr., das BasisDatum oder die Beschreibung leer wird der Eintrag auf dem Projekt gelöscht. Entspricht die übergebene Beschreibung nicht der Beschreibung des Projektes, so wird die Beschreibung geändert und verliert die Formatierung. Die ID_ProjektParam, die ID_AktivitaetsVorlage, die ID_AktivitaetAblauf und die ID_Workflowdefinition werden nicht berücksichtigt, wenn ID_Projekt übergeben wird.

    Parameters
    Name Beschreibung
    ID_Projekt
    Int32
    (body)     		Die ID des Projektes. Ist dieser Parameter gefüllt, so wird der Datensatz geändert.
    ID_ProjektParam
    Int32
    (body)     		Die ID der Projekt (Einstellung).
    ExternID
    String
    (body)     		Die Projekt-Nr.
    Beschreibung
    String
    (body)     		Text im Feld Beschreibung.
    GueltigVon
    DateTime
    (body)     		Der Start des Projekes.
    BasisDatum
    DateTime
    (body)     		Das BasisDatum des Projekes.
    ID_AktivitaetsVorlage
    Int32
    (body)     		Die ID der Aktivitätsvorlage.Das Projekt startet mit dieser Aktivität. Alle Initialen Aktivitäten und Abläufe wer-den nicht beachtet. Wird ID_Aktivitaetsvorlage nicht mitgegeben wird das Projekt mit der initialen Aktivität eröffnet.
    ID_AktivitaetAblauf
    Int32
    (body)     		Die ID des Prozesses. In diesem Prozess wird die Aktivität erstellt. Aktivitätsvorlagen aus dem Workflow sind immer in einem Prozess enthalten. Aktivitätsvorlagen, die ohne ID_AktivitaetAblauf ermittelt wurden, können jedem Prozss aus der Projekt (Einstellung) zugewiesen werden.
    ID_Workflowdefinition
    Int32
    (body)     		Die ID des Workflows. Ermittelte Aktivitätsvorlage, bei denen dieser Wert gesetzt ist müssen auch mit der ID_Workflowdefinition erstellt werden.
    AusschlussKontrolltermin
    Int32
    (body)     		Einen Status vom Typ Ausschluss Kontrolltermin erstellen oder löschen. Mit Wert 1 wird der Status geschrieben. Ist dieser vorhanden wird das Gültig bis auf das Tagesdatum gesetzt, wenn das Gültig bis in der Zukunft liegt. Mit Wert 0 wird der Status gelöscht. Wird kein Wert mitgegeben, so wird der Status nicht geändert.
    Response

    Die ID des neuen Projektes.

    Name Beschreibung
    value
    Int32

  • POST projekt/{id}/aktivitaet

    Erstellt eine neue Aktivtiät im Prozess.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID des Projektes.
    id_aktivitaetsvorlage
    Int32
    (body)     		Die ID der Aktivitätvorlage, die erstellt wird.
    id_aktivitaetablauf
    Int32
    (body)     		In diesem Projektprozess wird die Aktivtät aufgelistet. Die Aktivitäten werden folgendermassen hinzugefügt: 1. Es ist keine offene Aktivität vorhanden. Aus der Aktivitätsvorlage wird die Aktivität neu erstellt. 2. Aktivität ist offen und ID_Aktvitätsvorlage ist eine Folgeaktivität. Offene Aktivität erledigen mit passendem Ergebnis, so dass Folge-Aktivität auch geschrieben werden kann.
    statusdatum
    DateTime
    (body)     		Das Statusdatum der neuen Aktivität. Wird kein Statusdatum mitgegeben, so wird das Tagedatum verwendet.
    referenzen
    String
    (body)     		...
    Response

    Die ID des mitgegebenen oder eines neuen Projektes.

    Name Beschreibung
    value
    Int32

  • projektparam

    Das Objekt projektparam unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET projektparam/{id}/projektaktivitaetvorlage Ermittelt alle Aktivitätsvorlagen einer Projekt-Einstellung.

  • GET projektparam/{id}/projektaktivitaetvorlage

    Ermittelt alle Aktivitätsvorlagen einer Projekt-Einstellung.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID der gewünschten Projekt (Einstellung).
    Response

    Liste von Aktivitätvorlagen.

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    ID_AktivitaetVorlage
    Int32
    ID_ProjektParam
    Int32
    Thema
    Int32
    Aktion
    Int32
    ID_AktivitaetAblauf
    Int32
    nullable
    Bezeichnung
    String
    GueltigVon
    DateTime
    nullable
    GueltigBis
    DateTime
    nullable
    ID_Workflowdefinition
    Int32
    nullable

  • range

    Das Objekt range unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET range/{source}/description/{hardcode} Gibt die Bezeichnung des Wertebereichs zurück.
    GET range/{source}/id/{description} Gibt den Hardcode des Wertebereichs zurück.
    GET range/{source} Gibt die Werte eines Wertebereichs als Array zurück.

  • GET range/{source}/description/{hardcode}

    Gibt die Bezeichnung des Wertebereichs zurück.

    Parameters
    Name Beschreibung
    source
    String
    (query)     		Die Herkunft des Wertebereichs (z.B. 'Subjekt.Beruf').
    hardcode
    String
    (query)     		Der Hardcode des Wertebereichs.
    Response

    Die Bezeichnung des Wertebereichs.

    Name Beschreibung
    value
    String

  • GET range/{source}/id/{description}

    Gibt den Hardcode des Wertebereichs zurück.

    Parameters
    Name Beschreibung
    source
    String
    (query)     		Die Herkunft des Wertebereichs (z.B. 'Subjekt.Beruf').
    description
    String
    (query)     		Die Bezeichnung des Wertebereichs.
    Response

    Der Hardcode des Wertebereichs.

    Name Beschreibung
    value
    Int32
    nullable

  • GET range/{source}

    Gibt die Werte eines Wertebereichs als Array zurück.

    Parameters
    Name Beschreibung
    source
    String
    (query)     		Die Herkunft des Wertebereichs (z.B. 'Subjekt.Beruf').
    Response

    Die Werte als Array.

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    Empty
    WertebereichItem
    Code
    Int32
    nullable
    Bezeichnung
    String
    Kurzbezeichnung
    String
    Param1
    String
    Param2
    String
    Param3
    String
    Param4
    String
    Param5
    String
    Param6
    String
    Param7
    String
    Param8
    String
    Param9
    String
    Param10
    String
    Param11
    String
    Param12
    String
    Param1Bezeichnung
    String
    Param2Bezeichnung
    String
    Param3Bezeichnung
    String
    Param4Bezeichnung
    String
    Param5Bezeichnung
    String
    Param6Bezeichnung
    String
    Param7Bezeichnung
    String
    Param8Bezeichnung
    String
    Param9Bezeichnung
    String
    Param10Bezeichnung
    String
    Param11Bezeichnung
    String
    Param12Bezeichnung
    String
    GueltigVon
    DateTime
    nullable
    GueltigBis
    DateTime
    nullable
    Ausblenden
    Int32
    IstGueltig
    Boolean
    SortierReihenfolge
    Int32
    nullable

  • report

    Das Objekt report unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST report Aufbereiten einer Auswertung (innogridreport oder innoreport).

  • POST report

    Aufbereiten einer Auswertung (innogridreport oder innoreport).

    Parameters
    Name Beschreibung
    ReportFileName
    String
    (body)     		Wird intern für Debuggingzwecke verwendet. Setzen von aussen hat keine Wirkung!
    ID_Report
    Int32
    (body)     		Die Id des Report, welcher gestartet werden soll. Übergabe zwingend!
    ID_Selection
    Int32
    (body)     		Die ID der Selektion. Wird ID_Selection mitgegeben, wird der Parameter auf "1 = Mehrere via Selektion" gestellt. Wird ID_Selection nicht mitgegeben, wird der Parameter auf "0 = Einzel mit Datensatz-Id" gestellt. In diesem Fall muss eine Id und ggf. eine LaufNr mitgegeben werden Wird die ID_Selection nicht angegeben wird keine Selektion ausgeführt (Die Selektion welche dem Report zugewiesen ist hat hier in keinem Fall Relevanz!)
    ID
    Int32
    (body)     		Ist zwingend, wenn keine ID_Selection mitgegeben wird. Wird eine ID_Selektion mitgegeben, kann die Entität geladen und allfällige Vorbelegungswerte für Selektionskriterien durch das System geschrieben werden.
    LaufNr
    Int32
    (body)     		In Verbindung mit ID die LaufNr
    SelDefValueList
    Collection of SelectionDefValue
    (body)     		Vorbelegungswerte für Selektionskriterien. Wert wird durch Vorbelegungsformel des Kriterium gelesen.
    Response
    Name Beschreibung
    value
    Stream

  • subjektwithdublettencheck

    Das Objekt subjektwithdublettencheck unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST subjektwithdublettencheck

  • POST subjektwithdublettencheck

    Parameters
    Name Beschreibung
    Entity
    SubjektTemplateDublettencheck
    (body)
    Adressen
    Collection of AdresseTemplateDublettencheck
    (body)
    Kommunikationen
    Collection of KommunikationTemplateDublettencheck
    (body)
    SkipDublettenCheck
    Int32
    (body)
    Response

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    ProzentsatzUebereinstimmung
    String     		Prozentsatzübereinstimmung von Dubletten.
    ProzentsatzUebereinstimmungDecimal
    Decimal
    nullable     		Prozentsatzübereinstimmung von Dubletten als Zahl zwischen 0 und 1.
    ID_Subjekt
    Int32
    Name
    String
    Vorname
    String
    Adresse
    String
    Geburtsdatum
    DateTime
    nullable
    Typ
    String     		Typ des Subjekts: Subjekt/Aktiv Subjekt/Inaktiv Einwohner/Aktiv Einwohner/Inaktiv Unternehmen/Aktiv Unternehmen/Inaktiv
    GeschlechtRechtsform
    Int32
    nullable     		Geschlecht bei natürlichen Subjekten, Rechtsform bei nicht natürlichen Subjekten
    Kuerzel
    String
    Zusatzname
    String
    Code
    Int32     		Siehe Administratorenhandbuch
    Message
    String     		Meldung die Zurückgegeben wird.
    AdditionalErrorMessages
    String     		Erweiterte Fehlermeldungen im Falle von Systemfehlern.

  • timeseries

    Das Objekt timeseries unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST timeseries/values
    POST timeseries/basedata

  • POST timeseries/values

    Parameters
    Name Beschreibung
    From
    DateTime
    (body)     		Zeitreihenwerte werden von diesem Datum her gelesen.
    Until
    DateTime
    (body)     		Zeitreihenwerte werden bis und mit diesem Datum gelesen.
    Meteringcode
    String
    (body)     		Messpunktbezeichnung
    Unit
    Int32
    (body)     		0 = Konfigurierte Einheit wie z.B. kWh, 1 = kW anstatt kWh
    Aggregation
    Int32
    (body)     		Zeitschritt Minutes 15 = 15, Hour = 60, Day = 1440, Week = 10080, Month = 43200
    UseCalendarWeek
    Boolean
    (body)     		1 = Die Unit Week (10080) wird als Kalenderwoche interpertiert (Mo-Fr). Per Standard ist dieser Wert 1.
    ForceTimeStep
    Boolean
    (body)     		True = bei 15 Minuten Schritt ist der erste Zeitstempel 00:15. Bei False ist der erste Zeitstempel 00:00.
    UseUtc
    Boolean
    (body)     		True (Default) = Es wird UTC Time verwendet, FALSE = Es wird die lokale Zeit verwendet (Default)
    ZeitreihenTypen
    Int32[]
    (body)     		Dieser Parameter ist optional. Zeitreihentypen deren Zeitreihenwerte gelesen werden sollen. Wenn keine Zeitreihentypen angegeben werden, werden alle Zeitreihen die bein Messpunkt vorhanden sind zurück geliefert. 1 = Wirk Lieferung, 2 = Wirk Rücklieferung, 3 = Blind +R, 4 = Blind -R, 5 = Blind Q1, 6 = Blind Q2, 7 = Blind Q3, 8 = Blind Q4
    Zeitreihen
    Int32[]
    (body)     		Dieser Parameter ist optional. Zeitreihen ID die gelesen werden sollen.
    Response
    Name Beschreibung
    Meteringcode
    String     		Messpunktbezeichnung.
    From
    DateTime     		Zeitreihenwerte sind von diesem Datum her enthalten.
    Until
    DateTime     		Zeitreihenwerte sind bis und mit diesem Datum enthalten.
    TimeSeriesValues
    TimeSeriesValueResponse     		Listen von Zeitreihen mit Werte und Statistik.

  • POST timeseries/basedata

    Parameters
    Name Beschreibung
    From
    DateTime
    (body)     		Zeitreihenwerte werden von diesem Datum her gelesen.
    Until
    DateTime
    (body)     		Zeitreihenwerte werden bis und mit diesem Datum gelesen.
    Meteringcode
    String
    (body)     		Messpunktbezeichnung
    ZeitreihenTypen
    Int32[]
    (body)     		Dieser Parameter ist optional. Zeitreihentypen deren Zeitreihenwerte gelesen werden sollen. Wenn keine Zeitreihentypen angegeben werden, werden alle Zeitreihen die bein Messpunkt vorhanden sind zurück geliefert. 1 = Wirk Lieferung, 2 = Wirk Rücklieferung, 3 = Blind +R, 4 = Blind -R, 5 = Blind Q1, 6 = Blind Q2, 7 = Blind Q3, 8 = Blind Q4
    Response

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    ID_TimeSeries
    Int32     		Die ID der Zeitreihe.
    ID_TimeSeriesTyp
    Int32     		Die ID des Zeitreihentyp.
    TimeSeriesDescription
    String     		Bezeichnung der Zeitreihe.
    Unit
    String     		Unit als Text.
    TimeStep
    Int32     		Zeitschritt Minutes 15 = 15, Hour = 60, Day = 1440, Week = 10080, Month = 43200
    ValuesFrom
    DateTime     		Zeitreihewerte vorhanden von diesem Datum
    ValuesTo
    DateTime     		Zeitreihewerte vorhanden bis zu diesem Datum

  • workflow

    Das Objekt workflow unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST workflow Startet einen Workflow.

  • POST workflow

    Startet einen Workflow.

    Parameters
    Name Beschreibung
    ID_Workflowdefinition
    Int32
    (body)     		Die ID der Workflowdefinition.
    ID_Command
    String
    (body)     		Die Identifikation des Aufrufs. Hilfreich bei einer Callback-Implementierung.
    WorkflowParameterValues
    Collection of WorkflowParameterValue
    (body)     		Eine Liste von Workflowparameter-Werten, die vor dem Start des Workflows gesetzt werden.
    EntityId
    Int32
    (body)     		Dieses Feld ist veraltet. Bitte verwenden Sie stattdessen WorkflowParameterValues.
    This Field is obsolete. Please use WorkflowParameterValues instead.
    EntityId2
    Int32
    (body)     		Dieses Feld ist veraltet. Bitte verwenden Sie stattdessen WorkflowParameterValues.
    This Field is obsolete. Please use WorkflowParameterValues instead.
    CallbackDetails
    WorkflowCallbackDetails
    (body)     		Falls der gestartete Workflow seinerseits einen WebService-Aufruf tätigen muss, sind dies die Verbindungs-Details zum WebService.
    SubjektTemplates
    Collection of SubjektTemplate
    (body)     		Die Templates des Typs 'Subjekt'.
    StandortTemplates
    Collection of StandortTemplate
    (body)     		Die Templates des Typs 'Standort'.
    KommunikationTemplates
    Collection of KommunikationTemplate
    (body)     		Die Templates des Typs 'Kommunikation'.
    LiegenschaftTemplates
    Collection of LiegenschaftTemplate
    (body)     		Die Templates des Typs 'Liegenschaft'.
    GebaeudeTemplates
    Collection of GebaeudeTemplate
    (body)     		Die Templates des Typs 'Gebäude'.
    WohnungTemplates
    Collection of WohnungTemplate
    (body)     		Die Templates des Typs 'Wohnung'.
    SubjektzuordTemplates
    Collection of SubjektzuordTemplate
    (body)     		Die Templates des Typs 'Subjektzuord'.
    AdresseTemplates
    Collection of AdresseTemplate
    (body)     		Die Templates des Typs 'Adresse'.
    DokumentTemplates
    Collection of DokumentTemplate
    (body)     		Die Templates des Typs 'Dokument'.
    SDATMeteringpointDataTemplates
    Collection of SDATMeteringpoint
    (body)     		Die Templates des Typs 'Wechselprozesse'.
    GruppenzuordTemplates
    Collection of GruppenzuordTemplate
    (body)     		Die Templates des Typs 'Gruppenzuord'.
    PublicVertragspartnerTemplates
    Collection of PublicVertragspartnerTemplate
    (body)     		Die Templates des Typs 'Vertragspartner'.
    QMCUmzugTemplates
    Collection of QMCUmzugTemplate
    (body)     		Die Templates des Typs 'QMCUmzugTemplate'
    PublicVertragspartnerwechselTemplates
    Collection of PublicVertragspartnerwechselTemplate
    (body)     		Die Templates des Typs 'Vertragspartnerwechsel'.
    PublicZustelladresseTemplates
    Collection of PublicZustelladresseTemplate
    (body)     		Die Templates des Typs 'Zustelladresse'.
    PublicAblesungAuftragTemplates
    Collection of PublicAblesungAuftragTemplate
    (body)     		Die Templates des Typs 'AblesungAuftrag'.
    PublicMesswertTemplates
    Collection of PublicMesswertTemplate
    (body)     		Die Templates des Typs 'Messwert'.
    PublicVertragspartnerErfassenTemplates
    Collection of PublicVertragspartnerErfassenTemplate
    (body)     		Die Templates des Typs 'VertragspartnerErfassen'.
    QMCNeukundeTemplates
    Collection of QMCNeukundeTemplate
    (body)     		Die Templates des Typs 'QMCNeukundeTemplate'
    PublicVertragspartnerFaktVarianteTemplates
    Collection of PublicVertragspartnerFaktVarianteTemplate
    (body)     		Die Templates des Typs 'VertragspartnerFaktVariante'.
    PublicGISAvisierungTemplates
    Collection of PublicGISAvisierungTemplate
    (body)     		Template für GIS-Avisierungskampangnen.
    AdditionalInformation
    String
    (body)     		Kann für die Übergabe einer speziellen Infomation verwendet werden.
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.

  • workflowdefinition

    Das Objekt workflowdefinition unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET workflowdefinition/{id}/topmost Prüft ob für die gewünschte Workflow-Definition eine kundenspezifische Version vorliegt und gibt diese zurück.

  • GET workflowdefinition/{id}/topmost

    Prüft ob für die gewünschte Workflow-Definition eine kundenspezifische Version vorliegt und gibt diese zurück.

    Parameters
    Name Beschreibung
    id
    String
    (query)     		Die ID der Workflow-Definition.
    Response

    Die ID der kundenspezifischen Workflow-Definition.

    Name Beschreibung
    value
    Int32

  • workflowresult

    Das Objekt workflowresult unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    POST workflowresult Startet einen Workflow und gibt die Liste an Feldern zurück.

  • POST workflowresult

    Startet einen Workflow und gibt die Liste an Feldern zurück.

    Parameters
    Name Beschreibung
    ResultFieldNames
    Collection of String
    (body)     		Die Namens-Liste der Felder, deren Wert zurückgegeben wird.
    ID_Workflowdefinition
    Int32
    (body)     		Die ID der Workflowdefinition.
    ID_Command
    String
    (body)     		Die Identifikation des Aufrufs. Hilfreich bei einer Callback-Implementierung.
    WorkflowParameterValues
    Collection of WorkflowParameterValue
    (body)     		Eine Liste von Workflowparameter-Werten, die vor dem Start des Workflows gesetzt werden.
    EntityId
    Int32
    (body)     		Dieses Feld ist veraltet. Bitte verwenden Sie stattdessen WorkflowParameterValues.
    This Field is obsolete. Please use WorkflowParameterValues instead.
    EntityId2
    Int32
    (body)     		Dieses Feld ist veraltet. Bitte verwenden Sie stattdessen WorkflowParameterValues.
    This Field is obsolete. Please use WorkflowParameterValues instead.
    CallbackDetails
    WorkflowCallbackDetails
    (body)     		Falls der gestartete Workflow seinerseits einen WebService-Aufruf tätigen muss, sind dies die Verbindungs-Details zum WebService.
    SubjektTemplates
    Collection of SubjektTemplate
    (body)     		Die Templates des Typs 'Subjekt'.
    StandortTemplates
    Collection of StandortTemplate
    (body)     		Die Templates des Typs 'Standort'.
    KommunikationTemplates
    Collection of KommunikationTemplate
    (body)     		Die Templates des Typs 'Kommunikation'.
    LiegenschaftTemplates
    Collection of LiegenschaftTemplate
    (body)     		Die Templates des Typs 'Liegenschaft'.
    GebaeudeTemplates
    Collection of GebaeudeTemplate
    (body)     		Die Templates des Typs 'Gebäude'.
    WohnungTemplates
    Collection of WohnungTemplate
    (body)     		Die Templates des Typs 'Wohnung'.
    SubjektzuordTemplates
    Collection of SubjektzuordTemplate
    (body)     		Die Templates des Typs 'Subjektzuord'.
    AdresseTemplates
    Collection of AdresseTemplate
    (body)     		Die Templates des Typs 'Adresse'.
    DokumentTemplates
    Collection of DokumentTemplate
    (body)     		Die Templates des Typs 'Dokument'.
    SDATMeteringpointDataTemplates
    Collection of SDATMeteringpoint
    (body)     		Die Templates des Typs 'Wechselprozesse'.
    GruppenzuordTemplates
    Collection of GruppenzuordTemplate
    (body)     		Die Templates des Typs 'Gruppenzuord'.
    PublicVertragspartnerTemplates
    Collection of PublicVertragspartnerTemplate
    (body)     		Die Templates des Typs 'Vertragspartner'.
    QMCUmzugTemplates
    Collection of QMCUmzugTemplate
    (body)     		Die Templates des Typs 'QMCUmzugTemplate'
    PublicVertragspartnerwechselTemplates
    Collection of PublicVertragspartnerwechselTemplate
    (body)     		Die Templates des Typs 'Vertragspartnerwechsel'.
    PublicZustelladresseTemplates
    Collection of PublicZustelladresseTemplate
    (body)     		Die Templates des Typs 'Zustelladresse'.
    PublicAblesungAuftragTemplates
    Collection of PublicAblesungAuftragTemplate
    (body)     		Die Templates des Typs 'AblesungAuftrag'.
    PublicMesswertTemplates
    Collection of PublicMesswertTemplate
    (body)     		Die Templates des Typs 'Messwert'.
    PublicVertragspartnerErfassenTemplates
    Collection of PublicVertragspartnerErfassenTemplate
    (body)     		Die Templates des Typs 'VertragspartnerErfassen'.
    QMCNeukundeTemplates
    Collection of QMCNeukundeTemplate
    (body)     		Die Templates des Typs 'QMCNeukundeTemplate'
    PublicVertragspartnerFaktVarianteTemplates
    Collection of PublicVertragspartnerFaktVarianteTemplate
    (body)     		Die Templates des Typs 'VertragspartnerFaktVariante'.
    PublicGISAvisierungTemplates
    Collection of PublicGISAvisierungTemplate
    (body)     		Template für GIS-Avisierungskampangnen.
    AdditionalInformation
    String
    (body)     		Kann für die Übergabe einer speziellen Infomation verwendet werden.
    Response

    Die Liste der Felder, deren Werte zurückgegeben werden.

    Das Ergebnis ist eine Liste von Elementen, die der folgenden Struktur entsprechen.

    Name Beschreibung
    FieldName
    String     		Der Name des Feldes, dessen Wert zurückgegeben wird.
    Value
    String     		Der Wert des Feldes.
    ErrorMessage
    String     		Die Fehlermeldung, falls bei der Auswertung des Wertes ein Fehler entstanden ist.

  • zusatz

    Das Objekt zusatz unterstützt die folgenden Endpunkte.

    Endpunkt Beschreibung
    GET zusatz/{referenzId}?attribut={attribut}&entitaet={entitaet}&schema={schema}&infoparamId={infoparamId}&art={art} Ermittelt den aktuellen Wert eines Zusatzfeldes
    POST zusatz Speichert den Wert eines Zusatzfeldes.

  • GET zusatz/{referenzId}?attribut={attribut}&entitaet={entitaet}&schema={schema}&infoparamId={infoparamId}&art={art}

    Ermittelt den aktuellen Wert eines Zusatzfeldes

    Parameters
    Name Beschreibung
    referenzId
    String
    (query)     		ID der Referenz
    art
    String
    (query)     		Art der Referenz (optional)
    entitaet
    String
    (query)     		Entität der Referenz (in Kombination mit Attribut, sonst optional)
    attribut
    String
    (query)     		Attribut / Name des Zusatzfeldes (in Kombination mit Entität, sonst optional)
    schema
    String
    (query)     		Schema der Referenz aus Wertebereich System.Datenbank (in Kombination mit InfoparamId, sonst optional)
    infoparamId
    String
    (query)     		ID vom Zusatzfeld (in Kombination mit Schema, sonst optional)
    Response
    Name Beschreibung
    Wert
    String     		Der Wert des Zusatzfeldes.
    Wert_Bezeichnung
    String     		Die Wert-Bezeichnung des Zusatzfeldes.

  • POST zusatz

    Speichert den Wert eines Zusatzfeldes.

    Parameters
    Name Beschreibung
    Wert
    String
    (body)     		Der Wert des Zusatzfeldes.
    Entitaet
    String
    (body)     		Die Entität des Zusatzfeldes (z.B. 'Subjekt').
    Attribut
    String
    (body)     		Das Attribut des Zusatzfeldes.
    Art
    Int32
    (body)     		Die Art des Zusatzfeldes.
    ReferenzId
    Int32
    (body)     		Die Id der Entität.
    Schema
    Int32
    (body)     		Schema (ehem. Datenbank) des Zusatzfeldes Gültige Werte aus dem Wertebereich "System.Datenbank"
    ID_Infoparam
    Int32
    (body)     		ID_Infoparam für direkte Abfrage
    Response

    Der Endpunkt liefert lediglich einen HTTP Status Code als Ergebnis.