Any call to the module needs to use the base URL https://api.waermepumpe.de/api/sound.
No Arguments
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump.
Limited to assigned manufacturer IDs.
Required
heatSource: int
The heat source ID. See /heatSources.
Required
Returns JSON data.
No Arguments
Returns JSON data.
No Arguments
Returns JSON data.
No Arguments
Returns JSON data containing the Base64-encoded depictions of directivity indexes and shieldings.
No Arguments
Returns JSON data.
No Arguments
Returns JSON data.
No Arguments
Returns JSON data.
No Arguments
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump. Required if stored model data shall be used.
Limited to assigned manufacturer IDs.
Conditional
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump.
If not given, model data must be provided directly.
Conditional
modelTitle: string
The model title. Must be provided if no stored model is given.
Conditional
soundPowerLevel: float
The sound power level according to ErP in dB(A). Must be provided if no stored model is given.
Conditional
maxSoundPowerLevelDefaultMode: float
The maximum sound power level of the unit in dB(A). Must be provided if no stored model is given.
Conditional
maxSoundPowerLevelSilentMode: float
The maximum sound power level of the unit in silent mode in dB(A). If not given, its default mode equivalent is used for night time evaluation.
Optional
tonalityDefaultMode: int [0, 3 ,6]
The tonality of the unit in dB(A). Must be provided if no stored model is given.
Conditional
tonalitySilentMode: int [0, 3 ,6]
The tonality of the unit in silent mode in dB(A). If not given, its default mode equivalent is used for night time evaluation.
Optional
considerSilentMode: int [0, 1]
Take silent mode into consideration for night time.
Optional. A Value of 0 is taken if not set.
Optional
distance: float
Distance in m between the sound source and the relevant place of immission. Required
directivityIndex: int
The directivity index ID. See /directivityIndexes.
Required
shielding: int
The shielding ID. See /shieldings.
Optional. A Value of 0 is taken if not set.
Optional
sensitivityLevel: int
The sensitivity level ID. See /sensitivityLevels.
Required
noiseAbatements: array of arrays
The noise abatements applied to the installed heat pump. See /noiseAbatements.
Each child element requires two elements: 'type' (int) and 'value' (float).
Element 'custom' (string) describes the noise abatement and is required if custom type is used.
Value corresponds to the noise reduction in dB and the needs to be negative.
Optional
Returns JSON data.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump. Required if stored model data shall be used.
Limited to assigned manufacturer IDs.
Conditional
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump.
If not given, model data must be provided directly.
Conditional
modelTitle: string
The model title. Must be provided if no stored model is given.
Conditional
soundPowerLevel: float
The sound power level according to ErP in dB(A). Must be provided if no stored model is given.
Conditional
maxSoundPowerLevelDefaultMode: float
The maximum sound power level of the unit in dB(A). Must be provided if no stored model is given.
Conditional
maxSoundPowerLevelSilentMode: float
The maximum sound power level of the unit in silent mode in dB(A). If not given, its default mode equivalent is used for night time evaluation.
Optional
tonalityDefaultMode: int [0, 3 ,6]
The tonality of the unit in dB(A). Must be provided if no stored model is given.
Conditional
tonalitySilentMode: int [0, 3 ,6]
The tonality of the unit in silent mode in dB(A). If not given, its default mode equivalent is used for night time evaluation.
Optional
considerSilentMode: int [0, 1]
Take silent mode into consideration for night time.
Optional. A Value of 0 is taken if not set.
Optional
distance: float
Distance in m between the sound source and the relevant place of immission. Required
directivityIndex: int
The directivity index ID. See /directivityIndexes.
Required
shielding: int
The shielding ID. See /shieldings.
Optional. A Value of 0 is taken if not set.
Optional
sensitivityLevel: int
The sensitivity level ID. See /sensitivityLevels.
Required
noiseAbatements: array of arrays
The noise abatements applied to the installed heat pump. See /noiseAbatements.
Each child element requires two elements: 'type' (int) and 'value' (float).
Element 'custom' (string) describes the noise abatement and is required if custom type is used.
Value corresponds to the noise reduction in dB and the needs to be negative.
Optional
scope: int
The scope ID. See /scopes.
Required
Returns a PNG file.
Arguments:
manufacturer: int
The manufacturer ID of the space heating heat pump. Required if stored model data shall be used.
Limited to assigned manufacturer IDs.
Conditional
model: int
The model ID. Must correspond to the manufacturer of the space heating heat pump.
If not given, model data must be provided directly.
Conditional
modelTitle: string
The model title. Must be provided if no stored model is given.
Conditional
soundPowerLevel: float
The sound power level according to ErP in dB(A). Must be provided if no stored model is given.
Conditional
maxSoundPowerLevelDefaultMode: float
The maximum sound power level of the unit in dB(A). Must be provided if no stored model is given.
Conditional
maxSoundPowerLevelSilentMode: float
The maximum sound power level of the unit in silent mode in dB(A). If not given, its default mode equivalent is used for night time evaluation.
Optional
tonalityDefaultMode: int [0, 3 ,6]
The tonality of the unit in dB(A). Must be provided if no stored model is given.
Conditional
tonalitySilentMode: int [0, 3 ,6]
The tonality of the unit in silent mode in dB(A). If not given, its default mode equivalent is used for night time evaluation.
Optional
considerSilentMode: int [0, 1]
Take silent mode into consideration for night time.
Optional. A Value of 0 is taken if not set.
Optional
distance: float
Distance in m between the sound source and the relevant place of immission. Required
directivityIndex: int
The directivity index ID. See /directivityIndexes.
Required
shielding: int
The shielding ID. See /shieldings.
Optional. A Value of 0 is taken if not set.
Optional
sensitivityLevel: int
The sensitivity level ID. See /sensitivityLevels.
Required
noiseAbatements: array of arrays
The noise abatements applied to the installed heat pump. See /noiseAbatements.
Each child element requires two elements: 'type' (int) and 'value' (float).
Element 'custom' (string) describes the noise abatement and is required if custom type is used.
Value corresponds to the noise reduction in dB and the needs to be negative.
Optional
addressName: string
The owner's or operator's name, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressStreet: string
The owner's or operator's street, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressZip: string
The owner's or operator's zip code, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressPlace: string
The owner's or operator's place, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressPhone: string
The owner's or operator's phone number, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional
addressEmail: string
The owner's or operator's e-mail address, respectively, as part of the contact data. Will be printed on the report is contact is complete.
Optional