Server

<back to all web services

GetDeviceConsumptionList

Deviceconsumptions
Requires Authentication
The following routes are available for this service:
GET/api/v1/deviceconsumptions
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;

public class dtos
{

    public static class GetDeviceConsumptionList implements IHasBearerToken
    {
        @ApiMember(IsRequired=true, ParameterType="query")
        public String bearerToken = null;

        /**
        * Optional! Follow the format : /api/v1/deviceconsumptions?filter[DeviceGuid]=*
        */
        @DataMember(Name="filter[DeviceGuid]")
        @SerializedName("filter[DeviceGuid]")
        @ApiMember(Description="Optional! Follow the format : /api/v1/deviceconsumptions?filter[DeviceGuid]=*", ParameterType="query")
        public String filterByDeviceGuid = null;
        
        public String getBearerToken() { return bearerToken; }
        public GetDeviceConsumptionList setBearerToken(String value) { this.bearerToken = value; return this; }
        public String getFilterByDeviceGuid() { return filterByDeviceGuid; }
        public GetDeviceConsumptionList setFilterByDeviceGuid(String value) { this.filterByDeviceGuid = value; return this; }
    }

    public static class GetDeviceConsumptionListResponse
    {
        public ArrayList<DeviceConsumption> deviceConsumptionList = null;
        public ResponseStatus responseStatus = null;
        
        public ArrayList<DeviceConsumption> getDeviceConsumptionList() { return deviceConsumptionList; }
        public GetDeviceConsumptionListResponse setDeviceConsumptionList(ArrayList<DeviceConsumption> value) { this.deviceConsumptionList = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public GetDeviceConsumptionListResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class DeviceConsumption
    {
        @DataMember
        public UUID guid = null;

        @DataMember
        public Double deviceReading = null;

        @DataMember
        public Date deviceReadingDate = null;

        @DataMember
        public DeviceReadingKind deviceReadingKind = null;

        @DataMember
        public Date changeDate = null;

        @DataMember
        public String note = null;

        @DataMember
        public String ampouleColour = null;

        @DataMember
        public String deviceGuid = null;
        
        public UUID getGuid() { return guid; }
        public DeviceConsumption setGuid(UUID value) { this.guid = value; return this; }
        public Double getDeviceReading() { return deviceReading; }
        public DeviceConsumption setDeviceReading(Double value) { this.deviceReading = value; return this; }
        public Date getDeviceReadingDate() { return deviceReadingDate; }
        public DeviceConsumption setDeviceReadingDate(Date value) { this.deviceReadingDate = value; return this; }
        public DeviceReadingKind getDeviceReadingKind() { return deviceReadingKind; }
        public DeviceConsumption setDeviceReadingKind(DeviceReadingKind value) { this.deviceReadingKind = value; return this; }
        public Date getChangeDate() { return changeDate; }
        public DeviceConsumption setChangeDate(Date value) { this.changeDate = value; return this; }
        public String getNote() { return note; }
        public DeviceConsumption setNote(String value) { this.note = value; return this; }
        public String getAmpouleColour() { return ampouleColour; }
        public DeviceConsumption setAmpouleColour(String value) { this.ampouleColour = value; return this; }
        public String getDeviceGuid() { return deviceGuid; }
        public DeviceConsumption setDeviceGuid(String value) { this.deviceGuid = value; return this; }
    }

    public static enum DeviceReadingKind
    {
        Za,
        Ha,
        Mo,
        Eb,
        Ab;
    }

}

Java GetDeviceConsumptionList DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /api/v1/deviceconsumptions HTTP/1.1 
Host: dumpro-servdesk.eras-online.de 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<GetDeviceConsumptionListResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Get">
  <DeviceConsumptionList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models" i:nil="true" />
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</GetDeviceConsumptionListResponse>