WCF Funktionen
Übersicht und
Funktionsbeschreibungen
Allgemeines
WCF Services können in den unterschiedlichsten Programmiersprachen konsumiert werden.
Rückgabetypen
| string | Zeichenfolge |
| ItemInfo | Informationen zu einem spezifischen Objekt |
| int | Ganzzahl |
| DateTime | Zeit- oder Datums-Objekt |
| DR | Datensatz (Wert, Status, Zeitstempel) |
| MP | Zählpunkts-Objekt |
| ItemInfo [] | Array mit Informationen zu spezifischen Objekten |
| MP [] | Array mit Zählpunkts-Objekten |
| AssignmentInfo [] | Array mit Zuordnungs-Informationen einer Kostenstelle oder Energienutzen |
| CostCenter [] | Array mit Kostenstellen-Objekten |
| EnergyBenefit [] | Array mit Energienutzen-Objekten |
| UserMedium [] | Array mit Projekt-Medien |
| MeteringPointDetail [] | Array mit Zählpunkt-Informationen |
| SystemMeteringPoint [] | Array mit Systemzählpunkts-Objekten |
| ObisCodeProxy [] | Array OBIS - Informationen (Name, Bezeichnung, Einheit, Periodendauer, ...) |
Funktionen
| Rückgabetyp | Funktion( Parameter ) | Beschreibung |
|---|---|---|
| ItemInfo [] | GetProjectInfos (string token) | Returns all project informations for defined user |
| ItemInfo [] | GetLocationInfos (string token, string projectId) | Returns all locations for defined user |
| ItemInfo [] | GetDistributionPlanInfos (string token, string locationId) | Returns distribution plans (DE: Verteilungsstruktur) for defined user |
| ItemInfo [] | GetDistributingPlantInfos (string token, string planId) | Returns distributing plant information (DE: Verteilung) for defined user |
| MP [] | GetMeteringPoints (string token, string plantId) | Returns all meteringpoint of distributing plant More... |
| MP [] | GetAllMeteringPoints (string token) | Returns all meteringpoint with rights for defined user |
| AssignmentInfo [] | GetAllCostCenterAssignments (string token) | Returns all assignments meteringpoint => cost centers of all project with rights for defined user |
| AssignmentInfo [] | GetAllEnergyBenefitAssignments (string token) | Returns all assignments meteringpoint => energy benefit of all project with rights for defined user More... |
| DR | CalculateSum (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns number of records for a given timespan More... |
| DR | CalculateMin (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns minimum of values for a given timespan |
| DR | CalculateMax (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns maximum of values for a given timespan |
| DR | CalculateAvg (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns average of values for a given timespan |
| DR | CalculateBaseValue (string token, string id, string code, DateTime day, int interval, int baseFunction, int intervalFunction) | Returns the base value of a defined OBIS-Code for a given day and metering point. |
| MP | GetMeteringPoint (string token, string id) | Returns the information of a metering point |
| AssignmentInfo [] | GetCostCenterAssignments (string token, string projectId) | Return all assignments cost center => metering point for a project |
| AssignmentInfo [] | GetEnergyBenefitAssignments (string token, string projectId) | Return all assignments energy benefit => metering point for a project |
| string | GetAssemblyVersion () | Returns the assembly version of visual energy 4 web |
| string | GetAssemblyFileVersion () | Returns the file version of visual energy 4 web |
| DR [] | GetData (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns values for a metering point and a defined OBIS-Code in a defined timespan |
| MP [] | GetUnassignedMeteringPoints (string token, string planId) | Returns all meterings points of a distribution plan, that are not associated AND with state "Standard" |
| ItemInfo | GetItemInfo (string token, string id, string objectType) | Returns object information |
| MP [] | GetAllUnassignedMeteringPoints (string token, string planId) | Returns all metering points of a medium that are not associated with a distribution plan AND with state "Standard" OR "Control" |
| string | CalculateStatus (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns the state of values of a meteringpoint and OBIS-Code |
| int | GetRowCount (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Returns the number of records for a metering point and OBIS-Code |
| int | GetMeteringPointsCount (string token, string plantId) | Returns the number of meterings points of a distributing plant |
| int | GetAllMeteringPointsCount (string token) | Returns the number of meterings points of project with user rights |
| int | GetUnassignedMeteringPointsCount (string token, string planId) | Returns the number of meterings points of distribution plan |
| int | GetAllUnassignedMeteringPointsCount (string token, string planId) | Returns the number of meterings points of distribution plan that are not associated to a distributing plant AND with state "Standard" OR "Control" |
| MP [] | GetLocationMeteringPoints (string token, string locationId) | Returns the number of meterings points of distribution plan that are associated to a distributing plant AND with state "Standard" |
| int | GetLocationMeteringPointsCount (string token, string locationId) | Returns the number of meterings points of a location |
| MP [] | GetProjectMeteringPoints (string token, string projectid) | Returns all metering points of a project |
| int | GetProjectMeteringPointsCount (string token, string projectid) | Returns the number of metering points in project |
| DateTime | ReadTimeStampOfValue (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement, double value) | Returns time of first record in timespan with the defined value |
| DR | CalculateTariffValue (string token, string id, string code, DateTime startOfMeasurement, DateTime endOfMeasurement, DateTime startDate, int durationInHours, int baseFunction, int intervalFunction) | Returns den tariff value for a given day and metering point. |
| CostCenter [] | GetCostCenters (string token, string projectId) | Returns all cost centers of a project |
| UserMedium [] | GetUserMediums (string token, string projectId) | Returns all user defined mediums of a project |
| MeteringPointDetail [] | GetMeteringPointsOfDistributionPlan (string token, string planId) | Returns all metering point details of a distribution plan |
| SystemMeteringPoint [] | GetSystemMeteringPointsOfDistributionPlan (string token, string planId) | Returns all system metering points of a distribution plan |
| MeteringPointDetail | FindFirstMeteringPoint (string token, string projectId, string namePattern, bool getSystemMeteringPoints) | Returns the first metering point that equals [namePattern] By setting parameter [getSystemMeteringPoints] it is possible to define, if also system meteringpoints will be included. |
| MeteringPointDetail | GetMeteringPointDetail (string token, string id) | Returns details of metering point |
| ObisCodeProxy [] | GetObisCodesOfMeteringPoint (string token, string meteringPointId, string culture) | Returns all OBIS-Codes for a metering point |
| ObisCodeProxy [] | GetObisCodes (string token, string[] codes, string culture) | Returns all defined OBIS-Codes |
| ObisCodeProxy [] | FindObisCodesByGroupA (string token, ObisGroupA obisGroupA, string culture, int maxItems, ObisCodeType obisCodeType) | Returns the first n [Parameter 'maxItems'] OBIS-Codes of medium |
| EnergyBenefit [] | GetEnergyBenefits (string token, string projectId) | Returns all energy benefits |
| ReadProfileManager.HierarchicalDataRow [] | CalculateCostCenterSum (string token, string userMediumId, string costCenterId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Calculates sum for a specified cost center |
| ReadProfileManager.HierarchicalDataRow [] | CalculateEnergyBenefitSum (string token, string userMediumId, string energyBenefitId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Calculates sum for a specified energy benefit |
| WorkingDay [] | GetDayInfo (string token, string locationId, int year) | Returns information for a day at the defined location |
| AssignmentInfo [] | GetCostCenterAssignmentsOfUserMedium (string token, string userMediumId) | Returns all assigments cost center => metering point for as user defined medium |
| AssignmentInfo [] | GetEnergyBenefitAssignmentsOfUserMedium (string token, string userMediumId) | Returns all assigments energy benefit => metering point for as user defined medium |
| UserMedium [] | GetConfiguredUserMediums (string token, string projectId, ObjectType objectType) | Liefert alle in der entsprechenden Konfiguration (Kostenstellen/Energienutzen) verwendeten benutzerdef. Medien (also die, für die OBIS-Kennzeichen konfiguriert sind) |
| ObisCodeProxy [] | GetConfiguredObisCodesOfUserMedium (string token, string userMediumId, ObjectType objectType, string culture) | Liefert alle in der entsprechenden Konfiguration (Kostenstellen/Energienutzen) konfigurierten OBIS-Kennzeichen deren OBIS-GroupA der OBIS-GroupA des benutzerdef. Mediums enstprechen |
| ReadProfileManager.CalculatedSeries [] | CalculateCostCenterLoadProfile (string token, string userMediumId, string costCenterId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Berechnet die Lastgänge für die ang. Kostenstelle (ID) und die ang. Verteilungsstruktur für das ang. OBIS-Kennzeichen und den ang. Zeitraum |
| ReadProfileManager.CalculatedSeries [] | CalculateEnergyBenefitLoadProfile (string token, string userMediumId, string energyBenefitId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement) | Berechnet die Lastgänge für den ang. Energienutzen (ID) und die ang. Verteilungsstruktur für das ang. OBIS-Kennzeichen und den ang. Zeitraum |
| TimeSpan | CountWhen (string token, string meteringPointId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement, double lowerLimit, double upperLimit) | Liefert die Gesamtzeit der Perioden für alle Datensätze des ang. Zählpunkts (ID) und des ang. OBIS-Kennzeichens im ang. Zeitraum zurück, deren Werte innerhalb des Werte-Bereichs liegen |
| EbusMasterWcfDPValue [] | GetLiveValues (string token, EbusMasterOnlineDataSource[] dataPoints) | Liest die angegebenen Datenpunkte aus den multisys-BM und gibt diese zurück |
| DR [] | GetAggregateData (string token, string meteringPointId, string code, AggregateFunction aggregateFunction, string interval, DateTime startOfMeasurement, DateTime endOfMeasurement, bool getUtcTimestamps) | Ermittelt aggregierte Daten für einen Zählpunkt und ein OBIS-Kennzeichen |
| EbusMasterWcfDPValue [] | GetLiveValuesOfSession (string token, string sessionID, EbusMasterOnlineDataSource[] dataPoints) | Liest die Datenpunkte der Session mit der angegebenen ID aus den multisys-BM und gibt diese zurück |
| DR [] | CalculateCostCenterAggregateValues (string token, string userMediumId, string costCenterId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement, AggregateFunction aggregateFunction, AggregationInterval aggregationInterval) | Berechnet aggregierte Werte für die ang. Kostenstelle (ID) und die ang. Verteilungsstruktur für das ang. OBIS-Kennzeichen im ang. Zeitraum |
| DR [] | CalculateEnergyBenefitAggregateValues (string token, string userMediumId, string energyBenefitId, string code, DateTime startOfMeasurement, DateTime endOfMeasurement, AggregateFunction aggregateFunction, AggregationInterval aggregationInterval) | Berechnet aggregierte Werte für den ang. Energienutzen (ID) und die ang. Verteilungsstruktur für das ang. OBIS-Kennzeichen im ang. Zeitraum |
| ObisCodeProxy | GetObisCode (string token, string code) | Ermittelt das OBIS-Kennzeichen mit dem angegebenen Code |
| string | ValidateToken (string token) | Prüft, ob das Token validert werden kann |
| ProjectFolders [] | GetFolders (string token, string projectId, bool editAccessRequired) | Ermittelt alle Ordner des Projekts, für die der Anwender mit dem ang. Namen Lese bzw. Schreib-Rechte besitzt |
| ProjectFolderItems [] | GetFolderItems (string token, string parentId) | Ermittelt alle Dateien im Ordner |
| ProjectFolderItems | UpdateFolderItem (string token, ProjectFolderItems document) | Aktualisiert das Dokument |
| string [] | GetObisRulesForStructuralCalculation (string token, string userMediumId) | Ermittelt über die OBIS-Regeln des angegebenen benutzerdefinierten Mediums alle OBIS-Codes, für die die Strukturdatenberechnung aktiviert wurde. |
| string [] | GetObisRulesForCostCenters (string token, string userMediumId) | Ermittelt über die OBIS-Regeln des angegebenen benutzerdefinierten Mediums alle OBIS-Codes, für die die Kostenstellen-Auswertung aktiviert wurde. |
| string [] | GetObisRulesForEnergyBenefits (string token, string userMediumId) | Ermittelt über die OBIS-Regeln des angegebenen benutzerdefinierten Mediums alle OBIS-Codes, für die die Energienutzen-Auswertung aktiviert wurde. |