Web API Parameter
Boolean
Strictly this is not a parameter but a type a parameter might be. For a more in-depth discussion see Boolean in the Macros section.
Boolean parameters can only be either true
or false
, the notation is
parameterName=true
or parameterName=false
.
Example
In Playbacks/FirePlaybackAtLevel the parameter alwaysRefire is a boolean.
FirePlaybackAtLevel?handle_userNumber=2&level_level=0.9&alwaysRefire=true
refires LTP values.
FirePlaybackAtLevel?handle_userNumber=2&level_level=0.9&alwaysRefire=false
does not refire LTP values.
Errors
FirePlaybackAtLevel?handle_userNumber=2&level_level=0.9&alwaysRefire=tru
gives
“Error: Die Zeichenfolge wurde nicht als gültiger Boolean erkannt.”
(no valid boolean detected in string)
Reason: a boolean value may only be true
or false
. Even a missing e
invalidates it. The same is true if the value is missing altogether (alwaysRefire=
).
FirePlaybackAtLevel?handle_userNumber=2&level_level=0.9&alwaysRefire
results in
“Error: Der Objektverweis wurde nicht auf eine Objektinstanz festgelegt.”
(no object referenced)
Reason: and the equal sign is missing and thus the parameter is not recognized.
FirePlaybackAtLevel?handle_userNumber=2&level_level=0.9&alwaysRefir=true
throws
“Error: Die Sequenz enthält kein übereinstimmendes Element.”
(no matching element).
Reason: wrong parameter name.