Server

<back to all web services

GetStammdaten

Requires Authentication
The following routes are available for this service:
GET/Stammdaten
GetStammdatenResponse Parameters:
NameParameterData TypeRequiredDescription
BrennstoffMedienformList<BrennstoffMedium>No
DeviceCatalogformList<DeviceCatalog>No
ResponseStatusformResponseStatusNo
BrennstoffMedium Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
LabelformstringNo
StorableformboolNo
EinheitTypeformstringNo
Heizwertformdecimal?No
DeviceCatalog Parameters:
NameParameterData TypeRequiredDescription
GuidformstringNo
TypeShortformstringNo
TypeLongformstringNo
ReadableformboolNo
ClassformstringNo
SubtractionformboolNo
HkvvformboolNo
RadioformboolNo

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 /Stammdaten HTTP/1.1 
Host: fairtherm-servdesk.eras-online.de 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	BrennstoffMedien: 
	[
		{
			Guid: String,
			Bezeichnung: String,
			Lagernd: False,
			EinheitTyp: String,
			Heizwert: 0
		}
	],
	GeraeteKatalog: 
	[
		{
			Guid: String,
			TypKurz: String,
			TypLang: String,
			Ablesbar: False,
			Klasse: String,
			Abzug: False,
			Hkvv: False,
			Funk: False
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}