Interface IM2MServiceContract

Namespace: Evatic.Common.Service.Contract
Assembly: Evatic.Common.dll
Syntax
[IncludeDocumentationInWsdl]
[ServiceContract(Name = "M2MServiceContract")]
public interface IM2MServiceContract

Methods

View Source

AddExternalMeterLabel(MeterLabelDataContract)

Save a new meter label.

Declaration
[OperationContract]
bool AddExternalMeterLabel(MeterLabelDataContract meterMap)
Parameters
Type Name Description
MeterLabelDataContract meterMap
Returns
Type Description
System.Boolean

True if the name dose not exist, false if not.
View Source

CheckMachineNoForCompanyExist(String, Guid)

Validate a machine. Check if exist machine number for company.

Declaration
[OperationContract]
bool CheckMachineNoForCompanyExist(string machineNo, Guid externalSystemGuid)
Parameters
Type Name Description
System.String machineNo
System.Guid externalSystemGuid
Returns
Type Description
System.Boolean

Returns false if there is no match.
View Source

CreateLinkBetweenDeviceAndEvaticServiceMachine(LinkDeviceToEvaticServiceMachineDataContract)

Crate the link between external deivce with internal device.

Declaration
[OperationContract]
void CreateLinkBetweenDeviceAndEvaticServiceMachine(LinkDeviceToEvaticServiceMachineDataContract link)
Parameters
Type Name Description
LinkDeviceToEvaticServiceMachineDataContract link
View Source

CreateMachineModel(MachineModelDataContract, Int32)

Declaration
[OperationContract]
TinyMachineModelDataContract CreateMachineModel(MachineModelDataContract machineModel, int externalSystemId)
Parameters
Type Name Description
MachineModelDataContract machineModel
System.Int32 externalSystemId
Returns
Type Description
TinyMachineModelDataContract
View Source

DeleteEvaticDBConnection(Int32)

delete existing connection if there is no integrations that use it

Declaration
[OperationContract]
void DeleteEvaticDBConnection(int connectionId)
Parameters
Type Name Description
System.Int32 connectionId
View Source

DeleteExternalSystem(Int32)

Deletes all the information about external system

Declaration
[OperationContract]
void DeleteExternalSystem(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
View Source

Echo(String)

Declaration
[OperationContract]
string Echo(string textToEcho)
Parameters
Type Name Description
System.String textToEcho
Returns
Type Description
System.String
View Source

ExecuteDeviceMatchingRules(Int32)

Execute all enabled rules to map devices in the staging databse.

Declaration
[OperationContract]
int ExecuteDeviceMatchingRules(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Int32

The number of devices the where mapped
View Source

ExecuteModuleFunction(ExternalSystemDataContract, String, String)

This will run a function by name functionName on the Execute method in the integration module given by the externalSystem.

Declaration
[OperationContract]
string ExecuteModuleFunction(ExternalSystemDataContract externalSystem, string functionName, string jsonData = null)
Parameters
Type Name Description
ExternalSystemDataContract externalSystem
System.String functionName
System.String jsonData
Returns
Type Description
System.String
View Source

FindMatchedDevice(Int32, String)

Declaration
[OperationContract]
int FindMatchedDevice(int externalSystemId, string machineNo)
Parameters
Type Name Description
System.Int32 externalSystemId
System.String machineNo
Returns
Type Description
System.Int32
View Source

GetConsumableInfogroupsFromEvaticService(Int32)

Retrives the consumables code and description used in mapping for this external system.

Declaration
[OperationContract]
List<ConsumableInfoGroupDataContract> GetConsumableInfogroupsFromEvaticService(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<ConsumableInfoGroupDataContract>
View Source

GetConsumableReadingFromEvaticService(Int32)

Declaration
[OperationContract]
List<ConsumableValueDataContract> GetConsumableReadingFromEvaticService(int deviceId)
Parameters
Type Name Description
System.Int32 deviceId
Returns
Type Description
System.Collections.Generic.List<ConsumableValueDataContract>
View Source

GetConsumableReadingFromExternalSystem(Int32)

Declaration
[OperationContract]
List<BasicConsumableReadingWithMapDataContract> GetConsumableReadingFromExternalSystem(int deviceId)
Parameters
Type Name Description
System.Int32 deviceId
Returns
Type Description
System.Collections.Generic.List<BasicConsumableReadingWithMapDataContract>
View Source

GetCosumableMappings(Int32)

Declaration
[OperationContract]
List<ConsumableMappingDataContract> GetCosumableMappings(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<ConsumableMappingDataContract>
View Source

GetDeviceDuplicates(Int32)

Return a list of duplicated devices.

Declaration
[OperationContract]
DeviceDuplicatesDataContract GetDeviceDuplicates(int deviceId)
Parameters
Type Name Description
System.Int32 deviceId
Returns
Type Description
DeviceDuplicatesDataContract
View Source

GetDeviceMatchingRules(Int32)

Return a list of the matching rules used in staging database.

Declaration
[OperationContract]
List<DeviceMatchingRuleDataContract> GetDeviceMatchingRules(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<DeviceMatchingRuleDataContract>
View Source

GetDeviceModelMappingsForExternalSystem(Int32)

Declaration
[OperationContract]
DeviceModelMappingsForExternalSystemDataContract GetDeviceModelMappingsForExternalSystem(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
DeviceModelMappingsForExternalSystemDataContract
View Source

GetDeviceModelName(Int32)

Declaration
[OperationContract]
List<string> GetDeviceModelName(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<System.String>
View Source

GetDevicesByStatus(GetDevicesByStatusRequestDataContract)

Return a list of devices that are ignored, mapped or unmapped.

Declaration
[OperationContract]
PagedDevicesDataContract GetDevicesByStatus(GetDevicesByStatusRequestDataContract request)
Parameters
Type Name Description
GetDevicesByStatusRequestDataContract request
Returns
Type Description
PagedDevicesDataContract
View Source

GetDeviceStatistics(Int32)

Declaration
[OperationContract]
M2MDeviceStatisticsDataContract GetDeviceStatistics(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
M2MDeviceStatisticsDataContract
View Source

GetEvaticDBConnections()

Declaration
[OperationContract]
List<EvaticConnectionDataContract> GetEvaticDBConnections()
Returns
Type Description
System.Collections.Generic.List<EvaticConnectionDataContract>
View Source

GetEvaticMachine(Int32, Guid)

Return info about machine from %Evatic %Service databse

Declaration
[OperationContract]
MachineInformationDataContract GetEvaticMachine(int externalSystemId, Guid machineGuid)
Parameters
Type Name Description
System.Int32 externalSystemId
System.Guid machineGuid
Returns
Type Description
MachineInformationDataContract
View Source

GetEvaticServiceCompanies(Int32)

Declaration
[OperationContract]
List<CompanyDataContract> GetEvaticServiceCompanies(int evaticConnectionStringId)
Parameters
Type Name Description
System.Int32 evaticConnectionStringId
Returns
Type Description
System.Collections.Generic.List<CompanyDataContract>
View Source

GetEvaticServiceDeviceModels(Int32)

Return device models from %Evatic %Service databse and saves them to the m2m staging databse. This will be used for mapping.

Declaration
[OperationContract]
List<TinyMachineModelDataContract> GetEvaticServiceDeviceModels(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<TinyMachineModelDataContract>
View Source

GetExternalMeterLables(Int32)

Declaration
[OperationContract]
List<MeterMappingDataContract> GetExternalMeterLables(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<MeterMappingDataContract>
View Source

GetExternalSystems()

Declaration
[OperationContract]
List<ExternalSystemDataContract> GetExternalSystems()
Returns
Type Description
System.Collections.Generic.List<ExternalSystemDataContract>
View Source

GetExternalSystemsTypes()

Declaration
[OperationContract]
List<ExternalSystemTypesDataContract> GetExternalSystemsTypes()
Returns
Type Description
System.Collections.Generic.List<ExternalSystemTypesDataContract>
View Source

GetIgnoredDevices(Int32)

Return a list of device that has been ignored.

Declaration
[OperationContract]
List<M2MDeviceDataContract> GetIgnoredDevices(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<M2MDeviceDataContract>
View Source

GetMappingForConsumable(String)

Declaration
[OperationContract]
List<ConsumableMappingDataContract> GetMappingForConsumable(string consumableName)
Parameters
Type Name Description
System.String consumableName
Returns
Type Description
System.Collections.Generic.List<ConsumableMappingDataContract>
View Source

GetMeterLableMappings(MeterLabelMappigRequestDataContract)

Declaration
[OperationContract]
List<MeterMappingDataContract> GetMeterLableMappings(MeterLabelMappigRequestDataContract request)
Parameters
Type Name Description
MeterLabelMappigRequestDataContract request
Returns
Type Description
System.Collections.Generic.List<MeterMappingDataContract>
View Source

GetMeterMappings(Int32)

Return a list of the maping between external label and EvaticServiceMeterGuid.

Declaration
[OperationContract]
List<MeterMappingDataContract> GetMeterMappings(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<MeterMappingDataContract>
View Source

GetMeterReadingsFromEvaticService(Int32)

Declaration
[OperationContract]
List<SimpleMeterReadingDataContract> GetMeterReadingsFromEvaticService(int deviceId)
Parameters
Type Name Description
System.Int32 deviceId
Returns
Type Description
System.Collections.Generic.List<SimpleMeterReadingDataContract>
View Source

GetMeterReadingsFromExternalSystem(Int32)

Will try to get meter readings direct from PrintFeet or FmAduit systems. For third party types integration will get the last saved readings.

Declaration
[OperationContract]
List<BasicMeterReadingWithMeterMapDataContract> GetMeterReadingsFromExternalSystem(int deviceId)
Parameters
Type Name Description
System.Int32 deviceId
Returns
Type Description
System.Collections.Generic.List<BasicMeterReadingWithMeterMapDataContract>
View Source

GetMetersFromEvaticService(Int32)

Return a list of avaliable meters in %Evatic %Service

Declaration
[OperationContract]
List<TinyMeterDataContract> GetMetersFromEvaticService(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<TinyMeterDataContract>
View Source

GetMetersFromEvaticServiceThatNeedsToBeMapped(Int32)

Get a list of meter guid that has not been mapped.

Declaration
[OperationContract]
List<Guid> GetMetersFromEvaticServiceThatNeedsToBeMapped(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<System.Guid>
View Source

GetPrintFleetGroups(ExternalSystemDataContract)

This will get the Group structure from the Printfleet system.

Declaration
[OperationContract]
string GetPrintFleetGroups(ExternalSystemDataContract externalSystem)
Parameters
Type Name Description
ExternalSystemDataContract externalSystem
Returns
Type Description
System.String
View Source

GetPropertySearchInfo(Int32)

Declaration
[OperationContract]
List<PropertySearchInfoDataContract> GetPropertySearchInfo(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<PropertySearchInfoDataContract>
View Source

GetUnmappedDevices(Int32)

Return a list of devices that is not mapped.

Declaration
[MaxItemsInObjectGraphDataContractSerializer(900000)]
[OperationContract]
List<M2MDeviceDataContract> GetUnmappedDevices(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
Returns
Type Description
System.Collections.Generic.List<M2MDeviceDataContract>
View Source

ImportEvaticServiceMachineModels(Int32)

Extract the Machine models from %Evatic %Service database and saves them to the %M2M database for matching criterion.

Declaration
[OperationContract]
void ImportEvaticServiceMachineModels(int externalSystemId)
Parameters
Type Name Description
System.Int32 externalSystemId
View Source

PreprocessLevelDryRun(ConsumableLevelPreprocessorDataContract)

Declaration
[OperationContract]
ConsumablePreprocessorResultDataContract PreprocessLevelDryRun(ConsumableLevelPreprocessorDataContract input)
Parameters
Type Name Description
ConsumableLevelPreprocessorDataContract input
Returns
Type Description
ConsumablePreprocessorResultDataContract
View Source

RemoveConsumableMapping(ConsumableMappingDataContract)

Declaration
[OperationContract]
ConsumableMappingResponseDataContract RemoveConsumableMapping(ConsumableMappingDataContract mapping)
Parameters
Type Name Description
ConsumableMappingDataContract mapping
Returns
Type Description
ConsumableMappingResponseDataContract
View Source

RemoveMeterMapping(MeterMappingDataContract)

Maps EvaticServiceMeterGuid with External meter lable. Remove mapping.

Declaration
[OperationContract]
MeterMappingResponseDataContract RemoveMeterMapping(MeterMappingDataContract meterMapping)
Parameters
Type Name Description
MeterMappingDataContract meterMapping
Returns
Type Description
MeterMappingResponseDataContract
View Source

SaveConsumableMapping(ConsumableMappingDataContract)

Declaration
[OperationContract]
ConsumableMappingResponseDataContract SaveConsumableMapping(ConsumableMappingDataContract mapping)
Parameters
Type Name Description
ConsumableMappingDataContract mapping
Returns
Type Description
ConsumableMappingResponseDataContract
View Source

SaveDeviceAlerts(SaveDeviceServiceAlertRequestDataContract)

Save Service Alert for device that are matched.

Declaration
[OperationContract]
SaveDeviceServiceAlertResponseDataContract SaveDeviceAlerts(SaveDeviceServiceAlertRequestDataContract deviceAlerts)
Parameters
Type Name Description
SaveDeviceServiceAlertRequestDataContract deviceAlerts
Returns
Type Description
SaveDeviceServiceAlertResponseDataContract

List of Service Alert Event id that was saved.
View Source

SaveDeviceMatchingRules(List<DeviceMatchingRuleDataContract>)

Save a list of matchin rules used for mapping devices in the staging database.

Declaration
[OperationContract]
void SaveDeviceMatchingRules(List<DeviceMatchingRuleDataContract> deviceMatchingRules)
Parameters
Type Name Description
System.Collections.Generic.List<DeviceMatchingRuleDataContract> deviceMatchingRules
View Source

SaveDeviceModelMapping(SaveDeviceModelMappingDataContract)

This wil save a map between %Evatic %Service uniq model id with Existing system id.

Declaration
[OperationContract]
void SaveDeviceModelMapping(SaveDeviceModelMappingDataContract model)
Parameters
Type Name Description
SaveDeviceModelMappingDataContract model
View Source

SaveDevicesWithMinimumData(DevicesWithMinimumDataDataContract)

Save devices from an external system.

Declaration
[OperationContract]
void SaveDevicesWithMinimumData(DevicesWithMinimumDataDataContract devices)
Parameters
Type Name Description
DevicesWithMinimumDataDataContract devices
View Source

SaveEvaticDBConnection(EvaticConnectionDataContract)

insert new or update existing db connection

Declaration
[OperationContract]
bool SaveEvaticDBConnection(EvaticConnectionDataContract connection)
Parameters
Type Name Description
EvaticConnectionDataContract connection
Returns
Type Description
System.Boolean
View Source

SaveExternalSystem(ExternalSystemDataContract)

Register the external system details. Look at the ExternalSystemDataContract for the information needed.

Declaration
[OperationContract]
ExternalSystemDataContract SaveExternalSystem(ExternalSystemDataContract model)
Parameters
Type Name Description
ExternalSystemDataContract model
Returns
Type Description
ExternalSystemDataContract
View Source

SaveMeterAndConsumablesReadings(DeviceConsumablesReadingDataContract)

Save multiple meter and consumable values for devices from a external system.

Declaration
[OperationContract]
void SaveMeterAndConsumablesReadings(DeviceConsumablesReadingDataContract devices)
Parameters
Type Name Description
DeviceConsumablesReadingDataContract devices
View Source

SaveMeterMapping(MeterMappingDataContract)

Maps EvaticServiceMeterGuid with External meter lable. If Meter Lable do not exist, it will create one.

Declaration
[OperationContract]
MeterMappingResponseDataContract SaveMeterMapping(MeterMappingDataContract meterMapping)
Parameters
Type Name Description
MeterMappingDataContract meterMapping
Returns
Type Description
MeterMappingResponseDataContract
View Source

ShrinkExternalSystemData(ShrinkDataDataContract)

Shrinks external system data

Declaration
[OperationContract]
void ShrinkExternalSystemData(ShrinkDataDataContract model)
Parameters
Type Name Description
ShrinkDataDataContract model
View Source

TestConnection(ExternalSystemDataContract)

If the integration is set up with a service url, this will test the connection.

Declaration
[OperationContract]
TestConnectionResultDataContract TestConnection(ExternalSystemDataContract externalSystem)
Parameters
Type Name Description
ExternalSystemDataContract externalSystem
Returns
Type Description
TestConnectionResultDataContract

True if the connection is a success, false if not
View Source

TestEvaticConnection(EvaticConnectionDataContract)

est connection to evatic db

Declaration
[OperationContract]
bool TestEvaticConnection(EvaticConnectionDataContract connectionParams)
Parameters
Type Name Description
EvaticConnectionDataContract connectionParams
Returns
Type Description
System.Boolean

True if the connection is a success, false if not
View Source

ToggleIgnoredStatus(Int32)

Toggle the device ingored status.

Declaration
[OperationContract]
bool ToggleIgnoredStatus(int deviceId)
Parameters
Type Name Description
System.Int32 deviceId
Returns
Type Description
System.Boolean

True if the machine is set to ignore staus, false if not.
View Source

ValidateMachineNo(Int32, String)

Declaration
[OperationContract]
Guid? ValidateMachineNo(int externalSystemId, string machineNo)
Parameters
Type Name Description
System.Int32 externalSystemId
System.String machineNo
Returns
Type Description
System.Nullable<System.Guid>