Skip to content

GitLab

Last edited by EgbertCasper
Page history

BuildingPhysicsLibraryWebService

Syntax of the Web Service

Buildings physics properties are available thru a web service at:

http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/{physicsLibraryCountry}/{SubClass}/{SubClassID}

with the following "arguments":

       {physicsLibraryCountry}				:= [ germany | united-states-of-america ]
         {SubClass}					:= [ window | construction | material ]
           {physicsLibraryCountryWindowTypeID}		:= [0...7] for "germany/window"
           {physicsLibraryCountryConstructionTypeID}	:= [0...191] for "germany/construction"
           {physicsLibraryCountryMaterialID}		:= [0...96] for "germany/material"
           {physicsLibraryCountryWindowTypeID}		:= [0...7] for "united-states-of-america/window"
           {physicsLibraryCountryConstructionTypeID}	:= [0...205] for "united-states-of-america/construction"
           {physicsLibraryCountryMaterialID}		:= [0...96] for "united-states-of-america/material"

Responses are provided in JSON representation for

	Subclass = window:
		id			string
		name			string
		uValue			float
		gValue			float
		glazingNumber		int	
		frameRatio		float
		embodiedEnergy		fload
		embodiedCarbon		float
		constructionDescription	string
		disposalEnergy		float
		disposalCarbon		float
		disposalDescription	float
	Subclass = construction:
		id			string
		name			string
		layers			subclass of consecutive layers
			layerID 0			string
				materialId		int	
				thickness		float
				href			string	link to material
			...
			layerID N			string
				materialId		int	
				thickness		float
				href			string	link to material
	Subclass = material:
		id			string
		name			string
		density			float
		heatCapacity		float
		conductivity		float	
		embodiedEnergy		float
		embodiedCarbon		fload
		constructionDescription	string
		disposalEnergy		float
		disposalCarbon		float
		disposalDescription	float
classDiagram
  
    Country -- Window
    Country -- Construction
    Country -- Material

    Window -- WindowType
    Construction -- ConstructionType
    Material -- MaterialType
    ConstructionType "*" -->  Layer

	class Country {
		+String id 
		+String name
		+href(physicsLibraryCountry)   
	}
    class Window{
	+String id 
	+String nameype
	+href (physicsLibraryCountryWindowTypeID)
      }
    class Construction{
      +String id 
      +String name
      +href (physicsLibraryCountryConstructionTypeID)
    }
    class Material{
      +String id 
      +String name
      +href (physicsLibraryCountryMaterialID)
    }

    class WindowType {
        +String id
        +String name
        +Float  uValue
        +Float  gValue
        +Int    glazingNumber
	+Float  frameRatio		
	+Float  embodiedEnergy		
	+Float  embodiedCarbon		
	+String constructionDescription	
	+Float  disposalEnergy		
	+Float  disposalCarbon		
	+Float  disposalDescription	
    }
	class MaterialType {
		+String id
		+String name
		+Float  density
		+Float  heatCapacity
		+Float  conductivity		
		+Float  embodiedEnergy		
		+Float  embodiedCarbon		
		+String constructionDescription	
		+Float  disposalEnergy		
		+Float  disposalCarbon		
		+Float  disposalDescription	
	}
      
	class ConstructionType {
		+String id
		+String name
		+Int  Layer()
	}
	class Layer {
		+String materialId
		+Float  thickness
		+href   (physicsLibraryCountryMaterialID)
    }

WADL representation

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<application xmlns="http://wadl.dev.java.net/2009/02">
	<doc xmlns:jersey="http://jersey.java.net/" jersey:generatedBy="Jersey: 1.19.4 05/24/2017 03:20 PM"/>
	<grammars/>
	<resources base="http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/">
		<resource path="">
			<resource path="/buildingphysics/">
				<method id="physicsLibrary" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountry" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}/window">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountryWindowTypes" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}/construction">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountryConstructionTypes" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}/material">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountryMaterials" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}/window/{WindowTypeID}">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="WindowTypeID" style="template" type="xs:int"/>
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountryWindowTypesID" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}/construction/{ConstructionTypeID}">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="ConstructionTypeID" style="template" type="xs:int"/>
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountryConstructionTypeID" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
			<resource path="/buildingphysics/{countryID}/material/{MaterialID}">
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="MaterialID" style="template" type="xs:int"/>
				<param xmlns:xs="http://www.w3.org/2001/XMLSchema" name="countryID" style="template" type="xs:string"/>
				<method id="physicsLibraryCountryMaterialID" name="GET">
					<response>
						<representation mediaType="application/json"/>
					</response>
				</method>
			</resource>
		</resource>
	</resources>
</application>

Samples

  1. Calling the Web Service

    http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics

    Response in JSON:

[
    {
        "name": "germany",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany"
    },
    {
        "name": "united-states-of-america",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/united-states-of-america"
    }
]

  1. Get a list of available window types for Germany

    http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window

    Response in JSON:

[
    {
        "id": "0",
        "name": "Double-glazed window with old wooden/aluminum frame",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/0"
    },
    {
        "id": "1",
        "name": "Double-glazed window with plastic frame",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/1"
    },
    {
        "id": "2",
        "name": "Low-E double-glazed window",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/2"
    },
    {
        "id": "3",
        "name": "Low-E double-glazed window EnEV2016",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/3"
    },
    {
        "id": "4",
        "name": "Low-E triple-glazed window",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/4"
    },
    {
        "id": "5",
        "name": "Low-E triple-glazed window KfW 40",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/5"
    },
    {
        "id": "6",
        "name": "Low-E triple-glazed window KfW 55",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/6"
    },
    {
        "id": "7",
        "name": "Single-glazed window",
        "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/7"
    }
]

  1. Get the properties for window with ID 7 ( "single glazed window" ) in Germany

    http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/window/7

    Response in JSON:

{
    "id": "7",
    "name": "Single-glazed window",
    "uValue": 5.0,
    "gValue": 0.86,
    "glazingNumber": 1,
    "frameRatio": 0.3,
    "embodiedEnergy": null,
    "embodiedCarbon": null,
    "constructionDescription": null,
    "disposalEnergy": null,
    "disposalCarbon": null,
    "disposalDescription": null
}

  1. Get the properties for material with ID 54 ( "sand" ) in the USA

    http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/united-states-of-america/material/54

    Response in JSON:

{
    "id": 54,
    "name": "Sand",
    "density": 1500.0,
    "heatCapacity": 830.0,
    "conductivity": 0.2,
    "embodiedEnergy": 0.05,
    "embodiedCarbon": 0.01,
    "constructionDescription": "sand, produced in Germany, transportation 50 km",
    "disposalEnergy": 0.08,
    "disposalCarbon": 0.01,
    "disposalDescription": "100% sent to landfill, transportation 50 km"
}

  1. Get the layer properties for construction with ID 29 ( "Cavity wall_EnEV2016" ) in Germany

    http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/construction/29

    Response in JSON:

{
    "id": "29",
    "name": "Cavity wall_EnEV2016",
    "layers": [
        {
            "materialId": 4,
            "thickness": 0.12,
            "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/material/4"
        },
        {
            "materialId": 27,
            "thickness": 0.1,
            "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/material/27"
        },
        {
            "materialId": 3,
            "thickness": 0.17,
            "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/material/3"
        },
        {
            "materialId": 30,
            "thickness": 0.03,
            "href": "http://dmz02.rz.hft-stuttgart.de:8080/simstadtlibrary/buildingphysics/germany/material/30"
        }
    ]
}

Dies ist die Gitlab-Instanz des Transferportals der Hochschule für Technik Stuttgart. Hier geht es zurück zum Portal