Interface IMachineServiceContract

Namespace: Evatic.Common.Service.Contract

Assembly: Evatic.Common.dll

Syntax

[IncludeDocumentationInWsdl]
[ServiceContract(Namespace = "http://schema.evatic.com/2012/10/24", Name = "MachineService")]
public interface IMachineServiceContract

Methods

View Source

CheckMeterReadingValidation(List<CheckMeterReadingValidationRequestDataContract>)

To get the cosumables types that is registered for a machine

Declaration

[OperationContract]
List<CheckMeterReadingValidationResponseDataContract> CheckMeterReadingValidation(List<CheckMeterReadingValidationRequestDataContract> request)

Parameters

Type	Name	Description
System.Collections.Generic.List<Evatic.Common.Service.DataContract.CheckMeterReadingValidationRequestDataContract>	request

Returns

Type	Description
System.Collections.Generic.List<Evatic.Common.Service.DataContract.CheckMeterReadingValidationResponseDataContract>

View Source

CreateMachineModel(MachineModelDataContract, String)

Create a new model in %Evatic %Service

Declaration

[OperationContract]
TinyMachineModelDataContract CreateMachineModel(MachineModelDataContract machineModel, string company)

Parameters

Type	Name	Description
MachineModelDataContract	machineModel
System.String	company

Returns

Type	Description
TinyMachineModelDataContract	A instance of TinyMachineModelDataContract that holdes uniqe id for the MachineModel. --CreateModel--

View Source

CreateMachineNo(String)

Please see the setting COMPANY_XYZ\MACHINE\AUTO_NUMBER_ON and TP#11969

Declaration

string CreateMachineNo(string companyCode)

Parameters

Type	Name	Description
System.String	companyCode

Returns

Type	Description
System.String

View Source

GetConsumablesTypeBy(Guid)

To get the cosumables types that is registered for a machine

Declaration

[OperationContract]
List<string> GetConsumablesTypeBy(Guid machineGuid)

Parameters

Type	Name	Description
System.Guid	machineGuid

Returns

Type	Description
System.Collections.Generic.List<System.String>

View Source

GetContactForMachine(CustomerAndMachineGuidDataContract)

Declaration

[OperationContract]
List<ContactBaseDataContract> GetContactForMachine(CustomerAndMachineGuidDataContract request)

Parameters

Type	Name	Description
CustomerAndMachineGuidDataContract	request

Returns

Type	Description
System.Collections.Generic.List<ContactBaseDataContract>

View Source

GetGuid(MachineGuidRequestDataContract)

Declaration

[OperationContract]
Guid? GetGuid(MachineGuidRequestDataContract request)

Parameters

Type	Name	Description
MachineGuidRequestDataContract	request

Returns

Type	Description
System.Nullable<System.Guid>

View Source

GetInformation(Guid)

Declaration

[OperationContract]
MachineInformationDataContract GetInformation(Guid machineGuid)

Parameters

Type	Name	Description
System.Guid	machineGuid

Returns

Type	Description
MachineInformationDataContract	Detailed information in a macine.

View Source

GetMachinesConfiguredForConsumableOrder()

Get a list of machines that is registerd for Consumables readings.

Declaration

[OperationContract]
List<Guid> GetMachinesConfiguredForConsumableOrder()

Returns

Type	Description
System.Collections.Generic.List<System.Guid>

View Source

GetMeters()

Returns a list of meters guids with label and type that exsists in %Evatic %Service.

Declaration

[OperationContract]
List<TinyMeterDataContract> GetMeters()

Returns

Type	Description
System.Collections.Generic.List<TinyMeterDataContract>

View Source

GetModelMeterMap()

This will return a map of ModelGuid and MeterGuid.

Declaration

[OperationContract]
List<MachineModelMeterMapDataContract> GetModelMeterMap()

Returns

Type	Description
System.Collections.Generic.List<MachineModelMeterMapDataContract>

View Source

GetModels()

Get all models in %Evatic %Service.

Declaration

[OperationContract]
List<TinyMachineModelDataContract> GetModels()

Returns

Type	Description
System.Collections.Generic.List<TinyMachineModelDataContract>	A list of models with modelguid, modeltype and modeldescription.

View Source

Insert(MachineInsertRequestDataContract)

Create a new machine with the information provided in the MachineInsertRequestDataContract.

Declaration

[OperationContract]
MachineActionResponseDataContract Insert(MachineInsertRequestDataContract machine)

Parameters

Type	Name	Description
MachineInsertRequestDataContract	machine

Returns

Type	Description
MachineActionResponseDataContract	True if succeeded.

View Source

ListContacts(CustomerAndMachineGuidDataContract)

Get contatct information for a machine.

Declaration

[OperationContract]
List<ContactBaseDataContract> ListContacts(CustomerAndMachineGuidDataContract request)

Parameters

Type	Name	Description
CustomerAndMachineGuidDataContract	request

Returns

Type	Description
System.Collections.Generic.List<ContactBaseDataContract>

View Source

ListPropertySearchInfo(String)

Gets a list of properties description.

Declaration

[OperationContract]
List<PropertySearchInfoDataContract> ListPropertySearchInfo(string company)

Parameters

Type	Name	Description
System.String	company

Returns

Type	Description
System.Collections.Generic.List<PropertySearchInfoDataContract>	Code and Description.

View Source

SaveConsumables(ConsumableReadyForTransferDataContract)

Save Consumable with meter reading

Declaration

[OperationContract]
void SaveConsumables(ConsumableReadyForTransferDataContract data)

Parameters

Type	Name	Description
ConsumableReadyForTransferDataContract	data

View Source

SaveMeterReadings(List<MeterReadingDataContract>)

This method will save meter readings as service meter or letter meters if a letter exsist

Declaration

[OperationContract]
void SaveMeterReadings(List<MeterReadingDataContract> data)

Parameters

Type	Name	Description
System.Collections.Generic.List<MeterReadingDataContract>	data

View Source

Search(MachineSearchRequestDataContract)

Search for machine with different filter values, see MachineSearchRequestDataContract.

Declaration

[OperationContract]
List<MachineSearchResponseDataContract> Search(MachineSearchRequestDataContract request)

Parameters

Type	Name	Description
MachineSearchRequestDataContract	request

Returns

Type	Description
System.Collections.Generic.List<MachineSearchResponseDataContract>	the machineguid and model type.

View Source

SearchByMachineCustomer(SearchMachineCustomerRequestDataConstract)

This is the search method for machine. The input can be a combination of cusotmer guid and or machine model, machine nummber or machine id.

Declaration

[OperationContract]
List<MachineCustomerSearchRespondDataContract> SearchByMachineCustomer(SearchMachineCustomerRequestDataConstract request)

Parameters

Type	Name	Description
SearchMachineCustomerRequestDataConstract	request

Returns

Type	Description
System.Collections.Generic.List<MachineCustomerSearchRespondDataContract>	A list of basic machine information and machine adress.

View Source

SearchLimitedByNumberOfRecords(MachineSearchLimitRequestDataContract)

Search for machine supplied with a filter for number of records in the result.

Declaration

[OperationContract]
List<MachineSearchResponseDataContract> SearchLimitedByNumberOfRecords(MachineSearchLimitRequestDataContract request)

Parameters

Type	Name	Description
MachineSearchLimitRequestDataContract	request

Returns

Type	Description
System.Collections.Generic.List<MachineSearchResponseDataContract>	the machineguid and model type.

View Source

SearchModel(MachineModelSearchDataContract)

Search for model provided with model type.

Declaration

[OperationContract]
List<TinyMachineModelDataContract> SearchModel(MachineModelSearchDataContract request)

Parameters

Type	Name	Description
MachineModelSearchDataContract	request

Returns

Type	Description
System.Collections.Generic.List<TinyMachineModelDataContract>	A list of models with modelguid, modeltype and modeldescription.

View Source

Update(MachineUpdateRequestDataContract)

Update machine information.

Declaration

[OperationContract]
MachineActionResponseDataContract Update(MachineUpdateRequestDataContract machine)

Parameters

Type	Name	Description
MachineUpdateRequestDataContract	machine

Returns

Type	Description
MachineActionResponseDataContract	True if succeeded.

View Source

UpdateMachineInformation(MachineUpdateInformationDataContract)

Declaration

[OperationContract]
bool UpdateMachineInformation(MachineUpdateInformationDataContract request)

Parameters

Type	Name	Description
MachineUpdateInformationDataContract	request

Returns

Type	Description
System.Boolean

View Source

UpdateMachineLocation(MachineUpdateLocationDataContract)

Declaration

[OperationContract]
bool UpdateMachineLocation(MachineUpdateLocationDataContract request)

Parameters

Type	Name	Description
MachineUpdateLocationDataContract	request

Returns

Type	Description
System.Boolean

View Source

ValidateMachineNo(String)

Validate a machine. Insert machine nummber and get the guid.

Declaration

[OperationContract]
Guid? ValidateMachineNo(string machineNo)

Parameters

Type	Name	Description
System.String	machineNo

Returns

Type	Description
System.Nullable<System.Guid>	Returns null if there is no match.