Server

<back to all web services

PutBrennstoff

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

export class PutBrennstoffResponse
{
    public responseStatus: ResponseStatus;

    public constructor(init?: Partial<PutBrennstoffResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class BillingInformation
{
    // @DataMember
    public guid: string;

    // @DataMember
    public from: string;

    // @DataMember
    public to: string;

    // @DataMember
    public isCompleted: boolean;

    // @DataMember
    public hasNebenkosten: boolean;

    public constructor(init?: Partial<BillingInformation>) { (Object as any).assign(this, init); }
}

// @DataContract
export class Brennstofflieferung
{
    // @DataMember
    public guid: string;

    // @DataMember
    public deliveryDate: string;

    // @DataMember
    public salexTax?: number;

    // @DataMember
    public emisionsTax?: number;

    // @DataMember
    public c02Taxes?: number;

    // @DataMember
    public customsTax?: number;

    // @DataMember
    public otherCharges?: number;

    // @DataMember
    public c02Price?: number;

    // @DataMember
    public c02Tons?: number;

    // @DataMember
    public quantity?: number;

    // @DataMember
    public amount?: number;

    // @DataMember
    public startMeterReadingValue?: number;

    // @DataMember
    public endMeterReadingValue?: number;

    // @DataMember
    public heizwert: number;

    // @DataMember
    public brennwert: boolean;

    // @DataMember
    public energyReliefAmountDescription: string;

    // @DataMember
    public energyReliefAmount?: number;

    // @DataMember
    public electricityReliefAmountDescription: string;

    // @DataMember
    public electricityReliefAmount?: number;

    // @DataMember
    public cO2EmissionsFactor?: number;

    // @DataMember
    public cO2Text: string;

    // @DataMember
    public cO2Active?: boolean;

    // @DataMember
    public cO2PriceKnd?: boolean;

    // @DataMember
    public cO2PriceLandlord?: number;

    // @DataMember
    public cO2PriceRenter?: number;

    // @DataMember
    public cO2Area?: number;

    // @DataMember
    public isForCommercialUse?: boolean;

    // @DataMember
    public isRenovationRequired?: boolean;

    // @DataMember
    public isHeatingPadsImproved?: boolean;

    // @DataMember
    public cO2KWh?: number;

    // @DataMember
    public includedCO2SalesTax?: number;

    // @DataMember
    public cO2Costs?: number;

    // @DataMember
    public totalC02Weight?: number;

    // @DataMember
    public noTotalDeductionC02Costs?: boolean;

    // @DataMember
    public isDeleted: boolean;

    // @DataMember
    public isCreatedByApp: boolean;

    // @DataMember
    public brennstoffMediumGuid: string;

    // @DataMember
    public billingInformation: BillingInformation;

    public constructor(init?: Partial<Brennstofflieferung>) { (Object as any).assign(this, init); }
}

// @DataContract
export class RelatedTo
{
    // @DataMember
    public guid: string;

    public constructor(init?: Partial<RelatedTo>) { (Object as any).assign(this, init); }
}

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

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

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

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

    // @ApiMember(IsRequired=true, ParameterType="body")
    public bearerToken: string;

    public constructor(init?: Partial<PutBrennstoff>) { (Object as any).assign(this, init); }
}

TypeScript 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: mdf-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
		}
	}
}