Server

<back to all web services

GetBrennstoffList

Brennstofflieferung
Requires Authentication
The following routes are available for this service:
GET/api/v1/brennstofflieferung
GetBrennstoffList Parameters:
NameParameterData TypeRequiredDescription
BearerTokenquerystringYes
FilterByObjektGuidquerystringNoOptional! Follow the format : /api/v1/brennstofflieferung?filter[ObjektGuid]=*
FilterByEnergieVerwerterGuidquerystringNoOptional! Follow the format : /api/v1/brennstofflieferung?filter[EnergieVerwerterGuid]=*
FilterByBillingInformationGuidquerystringNoOptional! Follow the format : /api/v1/brennstofflieferung?filter[BillingInformationGuid]=*
GetBrennstoffListResponse Parameters:
NameParameterData TypeRequiredDescription
BrennstofflieferungenformIEnumerable<Brennstofflieferung>No
BrennstoffMediumformIEnumerable<BrennstoffMedium>No
ResponseStatusformResponseStatusNo
Brennstofflieferung Parameters:
NameParameterData TypeRequiredDescription
GuidformGuidNo
DeliveryDateformDateTimeNo
SalexTaxformdecimal?No
EmisionsTaxformdecimal?No
C02Taxesformdecimal?No
CustomsTaxformdecimal?No
OtherChargesformdecimal?No
C02Priceformdecimal?No
C02Tonsformdecimal?No
Quantityformdecimal?No
Amountformdecimal?No
StartMeterReadingValueformdecimal?No
EndMeterReadingValueformdecimal?No
HeizwertformdecimalNo
BrennwertformboolNo
EnergyReliefAmountDescriptionformstringNo
EnergyReliefAmountformdecimal?No
ElectricityReliefAmountDescriptionformstringNo
ElectricityReliefAmountformdecimal?No
CO2EmissionsFactorformdecimal?No
CO2TextformstringNo
CO2Activeformbool?No
CO2PriceKndformbool?No
CO2PriceLandlordformdecimal?No
CO2PriceRenterformdecimal?No
CO2Areaformdecimal?No
IsForCommercialUseformbool?No
IsRenovationRequiredformbool?No
IsHeatingPadsImprovedformbool?No
CO2KWhformdecimal?No
IncludedCO2SalesTaxformdecimal?No
CO2Costsformdecimal?No
TotalC02Weightformdecimal?No
NoTotalDeductionC02Costsformbool?No
IsDeletedformboolNo
IsCreatedByAppformboolNo
BrennstoffMediumGuidformGuidNo
BillingInformationformBillingInformationNo
BillingInformation Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
FromformDateTimeNo
ToformDateTimeNo
IsCompletedformboolNo
HasNebenkostenformboolNo
BrennstoffMedium Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
LabelformstringNo
StorableformboolNo
EinheitTypeformstringNo
Heizwertformdecimal?No

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