Server

<back to all web services

PutBrennstoff

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

public class PutBrennstoff : IHasBearerToken, Codable
{
    // @ApiMember(IsRequired=true, ParameterType="body")
    public var brennstofflieferung:Brennstofflieferung

    // @ApiMember(IsRequired=true, ParameterType="body")
    public var relatedToEnergieVerwerter:RelatedTo

    // @ApiMember(IsRequired=true, ParameterType="body")
    public var relatedToBrennstoffMedium:RelatedTo

    // @ApiMember(ParameterType="body")
    public var relatedToBillingInformation:RelatedTo

    // @ApiMember(IsRequired=true, ParameterType="body")
    public var bearerToken:String

    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 RelatedTo : Codable
{
    // @DataMember
    public var guid:String

    required public init(){}
}

public class PutBrennstoffResponse : Codable
{
    public var responseStatus:ResponseStatus

    required public init(){}
}

Swift PutBrennstoff 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.

PUT /api/v1/brennstofflieferung HTTP/1.1 
Host: fairtherm-servdesk.eras-online.de 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	brennstofflieferung: 
	{
		guid: 00000000000000000000000000000000,
		deliveryDate: 0001-01-01T00:00:00Z,
		salexTax: 0,
		emisionsTax: 0,
		c02Taxes: 0,
		customsTax: 0,
		otherCharges: 0,
		c02Price: 0,
		c02Tons: 0,
		quantity: 0,
		amount: 0,
		startMeterReadingValue: 0,
		endMeterReadingValue: 0,
		heizwert: 0,
		brennwert: False,
		energyReliefAmountDescription: String,
		energyReliefAmount: 0,
		electricityReliefAmountDescription: String,
		electricityReliefAmount: 0,
		cO2EmissionsFactor: 0,
		cO2Text: String,
		cO2Active: False,
		cO2PriceKnd: False,
		cO2PriceLandlord: 0,
		cO2PriceRenter: 0,
		cO2Area: 0,
		isForCommercialUse: False,
		isRenovationRequired: False,
		isHeatingPadsImproved: False,
		cO2KWh: 0,
		includedCO2SalesTax: 0,
		cO2Costs: 0,
		totalC02Weight: 0,
		noTotalDeductionC02Costs: False,
		isDeleted: False,
		isCreatedByApp: False,
		brennstoffMediumGuid: 00000000000000000000000000000000,
		billingInformation: 
		{
			guid: String,
			from: 0001-01-01T00:00:00Z,
			to: 0001-01-01T00:00:00Z,
			isCompleted: False,
			hasNebenkosten: False
		}
	},
	relatedToEnergieVerwerter: 
	{
		guid: 00000000000000000000000000000000
	},
	relatedToBrennstoffMedium: 
	{
		guid: 00000000000000000000000000000000
	},
	relatedToBillingInformation: 
	{
		guid: 00000000000000000000000000000000
	},
	bearerToken: String
}

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
		}
	}
}