Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung
import Foundation
import ServiceStack

public class GetBrennstoffList : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="query")
    public var bearerToken:String

    /**
    * Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*
    */
    // @DataMember(Name="filter[ObjektGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*", ParameterType="query")
    public var filter_ObjektGuid_:String

    /**
    * Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*
    */
    // @DataMember(Name="filter[EnergieVerwerterGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*", ParameterType="query")
    public var filter_EnergieVerwerterGuid_:String

    /**
    * Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*
    */
    // @DataMember(Name="filter[BillingInformationGuid]")
    // @ApiMember(Description="Optional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*", ParameterType="query")
    public var filter_BillingInformationGuid_:String

    required public init(){}
}

public class GetBrennstoffListResponse : Codable
{
    public var brennstofflieferungen:[Brennstofflieferung] = []
    public var brennstoffMedium:[BrennstoffMedium] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

// @DataContract
public class Brennstofflieferung : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var deliveryDate:Date

    // @DataMember
    public var salexTax:Double?

    // @DataMember
    public var emisionsTax:Double?

    // @DataMember
    public var c02Taxes:Double?

    // @DataMember
    public var customsTax:Double?

    // @DataMember
    public var otherCharges:Double?

    // @DataMember
    public var c02Price:Double?

    // @DataMember
    public var c02Tons:Double?

    // @DataMember
    public var quantity:Double?

    // @DataMember
    public var amount:Double?

    // @DataMember
    public var startMeterReadingValue:Double?

    // @DataMember
    public var endMeterReadingValue:Double?

    // @DataMember
    public var heizwert:Double

    // @DataMember
    public var brennwert:Bool

    // @DataMember
    public var energyReliefAmountDescription:String

    // @DataMember
    public var energyReliefAmount:Double?

    // @DataMember
    public var electricityReliefAmountDescription:String

    // @DataMember
    public var electricityReliefAmount:Double?

    // @DataMember
    public var cO2EmissionsFactor:Double?

    // @DataMember
    public var cO2Text:String

    // @DataMember
    public var cO2Active:Bool?

    // @DataMember
    public var cO2PriceKnd:Bool?

    // @DataMember
    public var cO2PriceLandlord:Double?

    // @DataMember
    public var cO2PriceRenter:Double?

    // @DataMember
    public var cO2Area:Double?

    // @DataMember
    public var isForCommercialUse:Bool?

    // @DataMember
    public var isRenovationRequired:Bool?

    // @DataMember
    public var isHeatingPadsImproved:Bool?

    // @DataMember
    public var cO2KWh:Double?

    // @DataMember
    public var includedCO2SalesTax:Double?

    // @DataMember
    public var cO2Costs:Double?

    // @DataMember
    public var totalC02Weight:Double?

    // @DataMember
    public var noTotalDeductionC02Costs:Bool?

    // @DataMember
    public var isDeleted:Bool

    // @DataMember
    public var isCreatedByApp:Bool

    // @DataMember
    public var brennstoffMediumGuid:String

    // @DataMember
    public var billingInformation:BillingInformation

    required public init(){}
}

// @DataContract
public class BillingInformation : Codable
{
    // @DataMember
    public var guid:String

    // @DataMember
    public var from:Date

    // @DataMember
    public var to:Date

    // @DataMember
    public var isCompleted:Bool

    // @DataMember
    public var hasNebenkosten:Bool

    required public init(){}
}

// @DataContract
public class BrennstoffMedium : Codable
{
    // @DataMember(Name="Guid")
    public var Guid:String

    // @DataMember(Name="Bezeichnung")
    public var Bezeichnung:String

    // @DataMember(Name="Lagernd")
    public var Lagernd:Bool

    // @DataMember(Name="EinheitTyp")
    public var EinheitTyp:String

    // @DataMember(Name="Heizwert")
    public var Heizwert:Double?

    required public init(){}
}

Swift GetBrennstoffList DTOs

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

HTTP + JSV

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

GET /api/v1/brennstofflieferung HTTP/1.1 
Host: kromer-servdesk.eras-online.de 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}