Server

<back to all web services

PostBrennstoff

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
POST/api/v1/brennstofflieferung
"use strict";
export class PostBrennstoffResponse {
    /** @param {{responseStatus?:ResponseStatus,checksumMD5?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    responseStatus;
    /** @type {string} */
    checksumMD5;
}
export class BillingInformation {
    /** @param {{guid?:string,from?:string,to?:string,isCompleted?:boolean,hasNebenkosten?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    from;
    /** @type {string} */
    to;
    /** @type {boolean} */
    isCompleted;
    /** @type {boolean} */
    hasNebenkosten;
}
export class Brennstofflieferung {
    /** @param {{guid?:string,deliveryDate?:string,salexTax?:number,emisionsTax?:number,c02Taxes?:number,customsTax?:number,otherCharges?:number,c02Price?:number,c02Tons?:number,quantity?:number,amount?:number,startMeterReadingValue?:number,endMeterReadingValue?:number,heizwert?:number,brennwert?:boolean,energyReliefAmountDescription?:string,energyReliefAmount?:number,electricityReliefAmountDescription?:string,electricityReliefAmount?:number,cO2EmissionsFactor?:number,cO2Text?:string,cO2Active?:boolean,cO2PriceKnd?:boolean,cO2PriceLandlord?:number,cO2PriceRenter?:number,cO2Area?:number,isForCommercialUse?:boolean,isRenovationRequired?:boolean,isHeatingPadsImproved?:boolean,cO2KWh?:number,includedCO2SalesTax?:number,cO2Costs?:number,totalC02Weight?:number,noTotalDeductionC02Costs?:boolean,isDeleted?:boolean,isCreatedByApp?:boolean,brennstoffMediumGuid?:string,billingInformation?:BillingInformation}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
    /** @type {string} */
    deliveryDate;
    /** @type {?number} */
    salexTax;
    /** @type {?number} */
    emisionsTax;
    /** @type {?number} */
    c02Taxes;
    /** @type {?number} */
    customsTax;
    /** @type {?number} */
    otherCharges;
    /** @type {?number} */
    c02Price;
    /** @type {?number} */
    c02Tons;
    /** @type {?number} */
    quantity;
    /** @type {?number} */
    amount;
    /** @type {?number} */
    startMeterReadingValue;
    /** @type {?number} */
    endMeterReadingValue;
    /** @type {number} */
    heizwert;
    /** @type {boolean} */
    brennwert;
    /** @type {string} */
    energyReliefAmountDescription;
    /** @type {?number} */
    energyReliefAmount;
    /** @type {string} */
    electricityReliefAmountDescription;
    /** @type {?number} */
    electricityReliefAmount;
    /** @type {?number} */
    cO2EmissionsFactor;
    /** @type {string} */
    cO2Text;
    /** @type {?boolean} */
    cO2Active;
    /** @type {?boolean} */
    cO2PriceKnd;
    /** @type {?number} */
    cO2PriceLandlord;
    /** @type {?number} */
    cO2PriceRenter;
    /** @type {?number} */
    cO2Area;
    /** @type {?boolean} */
    isForCommercialUse;
    /** @type {?boolean} */
    isRenovationRequired;
    /** @type {?boolean} */
    isHeatingPadsImproved;
    /** @type {?number} */
    cO2KWh;
    /** @type {?number} */
    includedCO2SalesTax;
    /** @type {?number} */
    cO2Costs;
    /** @type {?number} */
    totalC02Weight;
    /** @type {?boolean} */
    noTotalDeductionC02Costs;
    /** @type {boolean} */
    isDeleted;
    /** @type {boolean} */
    isCreatedByApp;
    /** @type {string} */
    brennstoffMediumGuid;
    /** @type {BillingInformation} */
    billingInformation;
}
export class RelatedTo {
    /** @param {{guid?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    guid;
}
export class PostBrennstoff {
    /** @param {{brennstofflieferung?:Brennstofflieferung,relatedToEnergieVerwerter?:RelatedTo,relatedToBrennstoffMedium?:RelatedTo,relatedToBillingInformation?:RelatedTo,bearerToken?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Brennstofflieferung} */
    brennstofflieferung;
    /** @type {RelatedTo} */
    relatedToEnergieVerwerter;
    /** @type {RelatedTo} */
    relatedToBrennstoffMedium;
    /** @type {RelatedTo} */
    relatedToBillingInformation;
    /** @type {string} */
    bearerToken;
}

JavaScript PostBrennstoff 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.

POST /api/v1/brennstofflieferung HTTP/1.1 
Host: stage-servdesk.eras-online.de 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<PostBrennstoff xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Post">
  <BearerToken>String</BearerToken>
  <Brennstofflieferung xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Amount>0</d2p1:Amount>
    <d2p1:BillingInformation>
      <d2p1:From>0001-01-01T00:00:00</d2p1:From>
      <d2p1:Guid>String</d2p1:Guid>
      <d2p1:HasNebenkosten>false</d2p1:HasNebenkosten>
      <d2p1:IsCompleted>false</d2p1:IsCompleted>
      <d2p1:To>0001-01-01T00:00:00</d2p1:To>
    </d2p1:BillingInformation>
    <d2p1:BrennstoffMediumGuid>00000000-0000-0000-0000-000000000000</d2p1:BrennstoffMediumGuid>
    <d2p1:Brennwert>false</d2p1:Brennwert>
    <d2p1:C02Price>0</d2p1:C02Price>
    <d2p1:C02Taxes>0</d2p1:C02Taxes>
    <d2p1:C02Tons>0</d2p1:C02Tons>
    <d2p1:CO2Active>false</d2p1:CO2Active>
    <d2p1:CO2Area>0</d2p1:CO2Area>
    <d2p1:CO2Costs>0</d2p1:CO2Costs>
    <d2p1:CO2EmissionsFactor>0</d2p1:CO2EmissionsFactor>
    <d2p1:CO2KWh>0</d2p1:CO2KWh>
    <d2p1:CO2PriceKnd>false</d2p1:CO2PriceKnd>
    <d2p1:CO2PriceLandlord>0</d2p1:CO2PriceLandlord>
    <d2p1:CO2PriceRenter>0</d2p1:CO2PriceRenter>
    <d2p1:CO2Text>String</d2p1:CO2Text>
    <d2p1:CustomsTax>0</d2p1:CustomsTax>
    <d2p1:DeliveryDate>0001-01-01T00:00:00</d2p1:DeliveryDate>
    <d2p1:ElectricityReliefAmount>0</d2p1:ElectricityReliefAmount>
    <d2p1:ElectricityReliefAmountDescription>String</d2p1:ElectricityReliefAmountDescription>
    <d2p1:EmisionsTax>0</d2p1:EmisionsTax>
    <d2p1:EndMeterReadingValue>0</d2p1:EndMeterReadingValue>
    <d2p1:EnergyReliefAmount>0</d2p1:EnergyReliefAmount>
    <d2p1:EnergyReliefAmountDescription>String</d2p1:EnergyReliefAmountDescription>
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
    <d2p1:Heizwert>0</d2p1:Heizwert>
    <d2p1:IncludedCO2SalesTax>0</d2p1:IncludedCO2SalesTax>
    <d2p1:IsCreatedByApp>false</d2p1:IsCreatedByApp>
    <d2p1:IsDeleted>false</d2p1:IsDeleted>
    <d2p1:IsForCommercialUse>false</d2p1:IsForCommercialUse>
    <d2p1:IsHeatingPadsImproved>false</d2p1:IsHeatingPadsImproved>
    <d2p1:IsRenovationRequired>false</d2p1:IsRenovationRequired>
    <d2p1:NoTotalDeductionC02Costs>false</d2p1:NoTotalDeductionC02Costs>
    <d2p1:OtherCharges>0</d2p1:OtherCharges>
    <d2p1:Quantity>0</d2p1:Quantity>
    <d2p1:SalexTax>0</d2p1:SalexTax>
    <d2p1:StartMeterReadingValue>0</d2p1:StartMeterReadingValue>
    <d2p1:TotalC02Weight>0</d2p1:TotalC02Weight>
  </Brennstofflieferung>
  <RelatedToBillingInformation xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToBillingInformation>
  <RelatedToBrennstoffMedium xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToBrennstoffMedium>
  <RelatedToEnergieVerwerter xmlns:d2p1="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Models">
    <d2p1:Guid>00000000-0000-0000-0000-000000000000</d2p1:Guid>
  </RelatedToEnergieVerwerter>
</PostBrennstoff>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<PostBrennstoffResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Eras2Web.Service.Desktop.Server.ServiceModel.Eras2WebExt.Post">
  <ChecksumMD5>String</ChecksumMD5>
  <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>
</PostBrennstoffResponse>