User Tools

Site Tools


webapi:parameters

Titan Web API

Parameters

Parameters are the details added to an API request, e.g. to specify the playback to fire, the level to set it to, the new page name etc.

While all this is explained in great detail in the macros context (in particular as it is much more sensible there) here a more practical approach is being taken: the parameters are explained in their use context. However, for a more detailed view ypu are encouraged to have a look at the macros section, e.g. Identifiers, Types, Location or Handle. Maybe in the future the parameters are also elaborated on more deeply but at the moment this should get you up and running.

If a request is sent from your browser's address bar the notation is

http://localhost:4430/titan/{command}?parameterName=parameterValue

  • the command is followed by a question mark ?
  • then the parameter name, an equal sign = and the parameter value
  • if there are multiple parameter name/value pairs to be applied then the pairs are separated by an ampersand &:
    http://localhost:4430/titan/{command}?parameter1Name=parameter1Value&parameter2Name=parameter2Value
  • the order in which multiple parameters are given does not matter:
    ?level_levelDelta=.3&srcHandle_userNumber=1 has the same effect like ?srcHandle_userNumber=1&level_levelDelta=.3

You may find these parameters here:

webapi/parameters.txt · Last modified: 2020/04/19 16:00 by icke_siegen

Donate Powered by PHP Valid HTML5 Valid CSS Driven by DokuWiki