Lignum API (v1.2.1)

Routes

getBauteil:

Returns a list of construction parts with all its data. The result set is limited to 20 entries per request.

https://lignumdata.ch/api/v1.cfc?method=getBauteil

Parameters

JSON Schema

View schema

getBauteilIndex:

Returns an index which contains all construction part ids. The result set is limited to 500 entries per request.

https://lignumdata.ch/api/v1.cfc?method=getBauteilIndex

Parameters

JSON Schema

View schema

getFilter:

Returns the possible filter and the filter values for a given construction part category.

https://lignumdata.ch/api/v1.cfc?method=getFilter&type=decke

Parameters

JSON Schema

View schema and examples

getDescriptions:

Returns the descriptions and units of the properties fetched via getBauteil route.

https://lignumdata.ch/api/v1.cfc?method=getDescriptions

Parameters

JSON Schema

View schema

getLanguages:

Returns a object of all available Languages. Only the languages available with the current login are output.

https://lignumdata.ch/api/v1.cfc?method=getLanguages

Parameters

JSON Schema

View schema

Conditions

Add a condition parameter to the request for additional filtering. The possible filters are explained below.

Filter by id

Filter by the construction part system id.

Example

&condition={"id": "6DF3DCCD-ADC5-78BF-379EE72E6EE25F70"}

Filter by type

Filter by the construction part category.

Possible Values

decke, trennwand, twzweischalig, aussenwand, steildach, flachdach

Example

&condition={"type":"decke"}

Filter by laufnummer

Filter by the construction part number.

Possible Values

e.g. A0090, A0092, …

Example

&condition={"laufnummer": "A0090"}

Filter by hersteller

Filter by the constructor of a single part.

Possible Values

e.g. isover, Rigips, …

Example

&condition={"hersteller":"isover"}

Filter by bauteilevon

Filter by the source of a single part.

Possible Values

e.g. Fermacell, Lignatur, Lignum, …

Example

&condition={"bauteilevon":"Lignum"}

Filter by bauteiltyp

Filter by the type of the supporting structure the construction parts.

Multiple types can be specified at once. Therefore the filter values need to be passed as JSON Array.

Possible Values

Example

&condition={"bauteiltyp": ["Rippen", "Balken"]}

Filter by dicke

Filter by the thickness / height of the construction parts.

Data Structure

The data needs to be provided as JSON Object.

Example

&condition={"dicke": {"min": 250, "max": 400}}
&condition={"dicke": {"min": 250}}

Filter by luftschall

Filter by the weighted sound reduction index. You can also define the spectrum adaptation term.

Data Structure

The data needs to be provided as JSON Object.

Values of the Spectrum Adaptation Term

Example

&condition={"luftschall": {"min": 20, "max": 80}}
&condition={"luftschall": {"max": 80, "anpassung": "c"}}

Filter by daemmungkonstruktion

Filter the construction parts, depending on whether they have cavity insulation between the support structure or not.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
decke, trennwand, twzweischalig, steildach, flachdach

Possible Values

This filter accepts a boolean value: true, false.

Example

&condition={"daemmungkonstruktion": false}
&condition={"type": "decke", "daemmungkonstruktion": true}

Filter by bekleidung

Filter the construction parts by the different ceiling linings.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
decke, aussenwand, steildach, flachdach

Possible Values

Example

&condition={"bekleidung": "Doppelte Bekleidung"}

Filter by beplankung

Filter the construction parts by the different sheathings.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
trennwand, twzweischalig, steildach, flachdach

Possible Values

Example

&condition={"type":"steildach", "beplankung":"Beplankung beidseitig"}

Filter by daemmungbekleidung

Filter the construction parts, depending on whether they have cavity insulation in the cover or not.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
trennwand, steildach, flachdach

Possible Values

This filter accepts a boolean value: true, false.

Example

&condition={"type":"trennwand", "daemmungbekleidung": false}

Filter by trittschall

filter by the weighted normalized impact sound pressure level. You can also define the spectrum adaptation term.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
decke, flachdach

Data Structure

The data needs to be provided as JSON Object.

Values of the Spectrum Adaptation Term

Example

&condition={"trittschall": {"min": 25, "max": 60}}
&condition={"trittschall": {"max": 60, "anpassung": "ci"}}

Filter by beschwerungkonstruktion

Filter the construction parts, depending on whether they have damping in the construction or not.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
decke

Possible Values

This filter accepts a boolean value: true, false.

Example

&condition={"type":"`decke`", "beschwerungkonstruktion": true}

Filter by beschwerungtragschicht

Filter the construction parts, depending on whether they have damping on the construction or not.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
decke

Possible Values

This filter accepts a boolean value: true, false.

Example

&condition={"type":"decke", "beschwerungtragschicht": false}

Filter by estrich

Filter the construction parts by the different screeds.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
decke

Possible Values

Example

&condition={"type":"decke", "estrich": "ohne Estrich"}

Filter by lueftung

Filter the construction parts by the different facade types.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
aussenwand

Possible Values

Example

&condition={"type":"aussenwand", "lueftung": "Hinterlüftete Fassade"}

Filter by nutzschicht

filter the construction parts by the different wear layers.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
flachdach

Possible Values

Example

&condition={"type":"flachdach", "nutzschicht": "Kies"}

Filter by wandbekleidung

Filter the construction parts by the different wallcovering.

Affected Construction Part Categories

This filter only has an effect on construction parts belonging to the following categories:
trennwand

Possible Values

Example

&condition={"type":"trennwand", "wandbekleidung": "Freistehend"}

Combined Conditions

The single filter conditions can be combined for more finegrained filtering.

&condition={"type":"decke", "laufnummer": "A0090", "hersteller":"isover"}
&condition={"type":"flachdach", "luftschall":{"min":50, "anpassung":"ctr"}, "nutzschicht": "Kies"}
&condition={"type":"decke", "luftschall":{"min":59, "max":69, "anpassung":"c50_3150"}, "trittschall":{"min":49, "max":59, "anpassung":"ci50_2500"}, "dicke":{"min":435, "max":537}, "bauteiltyp":["Hohlkasten","Massivholz"], "estrich":"mit Anhydritfliessestrich", "beschwerungtragschicht":true, "beschwerungkonstruktion":false, "daemmungkonstruktion":true, "bekleidung":"Unterkonstruktion steif befestigt"}

Compatibility Mode

The compatibility mode can be activated by adding &compatMode=true to the query.

The condition object may contain filter values containing a space character. If the compatibility mode is activated, every space in a filter value will be replaced by an underscore (_). The compatibility mode also affects the returned data in the getFilter route.

The filter data from the getFilter route gathered with the compatibility mode activated will only work in the condition object when the the compatibility mode is activated for corresponding calls to the getBauteil and getBauteilIndex routes.

Examples

{
 "type": "steildach",
 "bekleidung": "Ohne Bekleidung",
 "daemmungkonstruktion": true,
}

{
 "type": "steildach",
 "bekleidung": "Ohne_Bekleidung",
 "daemmungkonstruktion": true,
}

{
 "bekleidung": {
  "label": "Ceiling linings",
  "values": [
   {
    "label": "Without covering",
    "key": "Ohne Bekleidung"
   },
   {
    "label": "Simple covering",
    "key": "Einfache Bekleidung"
   },
   {
    "label": "Double covering",
    "key": "Doppelte Bekleidung"
   }
  ]
 }
}

{
 "bekleidung": {
  "label": "Ceiling linings",
  "values": [
   {
    "label": "Without covering",
    "key": "Ohne_Bekleidung"
   },
   {
    "label": "Simple covering",
    "key": "Einfache_Bekleidung"
   },
   {
    "label": "Double covering",
    "key": "Doppelte_Bekleidung"
   }
  ]
 }
}

Paging

The response is limited to a given number of records. This is mainly for performance reasons. To receive all records from our API your system should call the API multiple times until you have all needed data. To support a such implementation we include the following headers in our response:

• Pagination-Count 4563
• Pagination-Limit 20
• Pagination-Page 1
• Pagination-LastPage 229

To receive a specific page of data, you can add the following parameter to the request:

&page=2

Authentication

As a default setting, the lignum API is publicly available, you get all data which is also available on the website. For partners and authenticated users there are additional construction parts and all parts come with additional information (e.g. Pruefbericht URL).

To make an authenticated request, you can add the "Authentication" header to your request.

The header has to contain the username and password, separated by a colon. This string has to be base64 encoded.

Example:

Authorization:   Basic base64(username:password)

which should then look like:

Authorization:   Basic dXNlcm5hbWU6cGFzc3dvcmQ=

You can use the same credentials as you use on the lignumdata website.

Language

All construction parts have content which is language specific. As a default, the API returns all those language specific parts in german. You can override this setting with the "language" header parameter:

Example:

Language:   en

Currently the following languages are supported: cs,uk,ro,it,no,pl,bg,fr,sv,en,ru,es,de,fi,et,ja.

Note: Depending on the login, not all Languages can be used (see method getLanguages). And keep in mind, not all translations are final.

Changes

v1.2.1

• The property image_jpg from the property media in the getBauteil function is now an optional property (updated schema). The property should be filled in allmost all cases, unless while updating the images there can be a short period, where the property is undefined.

v1.2.0

• Added getLanguages route
• Added ifcorientation property to the property bauteilgruppe in the getBauteil function
• Added aufbau, faserrichtung, kbob_id and grafikfarbcode properties to the layers in the property aufbau in the getBauteil function
• Fixed numbers near zero to be outputed as 0 not -
• Rename Fields produktName and herstellerName to all lowercase variants produktname and herstellername.

v1.1.9

• Added estrich property to the getBauteil function
• Added beschwerungtragschicht property to the getBauteil function
• Added beschwerungkonstruktion property to the getBauteil function
• Added daemmungkonstruktion property to the getBauteil function
• Added compat mode to addition filters in the getFilter function
• Fixed a lazyload bug which had a negative impact on performance
• Fixed assembly layers to respect the hersteller property in the condition parameter of getBauteil route

v1.1.8

• Extended compatibility mode to returned data of getBauteil route
• Added standard construction part name (field bauteilname) to returned data of getBauteil route
• Added flammability group information (field brandverhaltensgruppe) to the assembly layers data (getBauteil route)
• If authenticated, the getBauteilIndex route now accepts page=all to turn off pagination
• Added route getDescriptions

v1.1.7

• Added compatibility mode

v1.1.6

• Added additional field (anpassung) to returned trittschall and luftschall data for getFilter route
• Removed HTML tags from localized descriptions in getFilter route
• Updated JSON schema for getFilter

v1.1.5

• Changed getFilter route to return the filter keys associated with a localized label
• Added additional field (wandbekleidung) to returned data for getBauteil
• Updated JSON schema for getBauteil and getFilter

v1.1.4

• Added getFilter route
• Added JSON schema for getBauteilIndex and getFilter
• Added additional fields (quellekonstruktion, fassadentyp, beplankung, bekleidung) to returned data for getBauteil
• Moved the JSON schema definitions to separate files

v1.1.3

• Added description (field beschreibung) to returned data for getBauteil
• Added JSON schema to this document

v1.1.2

• Added additional filter condition bauteilevon
• Included the ecological indicators in the returned data
• Fixed error with IFC file url

v1.1.1

• Added additional filter conditions (bauteiltyp, dicke, luftschall, daemmungkonstruktion, bekleidung, beplankung, daemmungbekleidung, trittschall, beschwerungkonstruktion, beschwerungtragschicht, estrich, lueftung, nutzschicht, wandbekleidung)
• Fixed IFC file and test report url

v1.1.0

• Initial release