Parameter Overview

This page gives an overview over all parameters which can be returned by your server and the consequences on the client application.

id

  • Possible Values: String (alphanummeric characters only)
  • Description: Alphanumeric attribute holding a unique POI identifier. It is important to determine with which POI a user interacted.

interactionfeedback

  • Possible Values: (none,click)
  • Description: Attribute determining the type of interaction the client expects.
  • Effect: Currently there are two possible values:
    "none": The client does not expect any feedback. A poi/event will be sent out upon clicking the POI, however no feedback will be processed.
    "click": The client expects an update of POI information after a user clicked on a POI. The poi/event request will be triggered and the client awaits return values to process.
  • Hints: Make sure to set this value correctly for each POI, otherwise performance is reduced and user feedback can be misleading.

removed

  • Possible Values: (true)
  • Description: Attribute to be returned upon pois/event to remove a loaded POI.
  • Effect: Set to "true" to remove a POI, which is displayed.
  • Hints: Make sure to set this value correctly for each POI, otherwise performance is reduced and user feedback can be misleading.

trackingurl

  • Possible Values: String (Url)
  • Description: Attribute of results. For junaio GLUE only! Path to the tracking XML.

name

  • Possible Values: String
  • Description: The name of the POI.
  • Effect: Sets the title of the POI.
    See Layout for more information.

description

  • Possible Values: String
  • Description: Sets a message for a POI (up to 1024 characters). It is mendatory for mime-type "text/plain", optional otherwise.
  • Effect: Sets the description of a POI.
    See Layout for more information.

date

  • Possible Values: DateTime
  • Description: Sets a date, when the POI was created. This tag can be empty.

l

  • Possible Values: lat:Float,long:Float,alt:Float
  • Description: Determines the location of a POI and needs to be given with latitude, longitude, altitude (WGS84). The string has to represent all three values. If in doubt, set altitude to "0".
  • Effect: The parameter is needed with every poi to determine its location.
  • Hints: Make sure that there are no spaces in the "l" tag (e.g. 37.8084900,-122.4101100,0.0)

translation

  • Possible Values: x:Float,y:Float,z:Float
  • Description: It sets the position of the poi/model
  • Effect: The parameter is needed with every poi to determine its location on the image.
  • Hints: Make sure that there are no spaces in the "translation" tag (e.g. 0.0,5.0,0.0)

o

  • Possible Values: x:Float,y:Float,z:Float
  • Description: Sets the orientation of a POI with euler angles in radians around x-, y- and z-Axis. Positive and negative values are possible.
  • Effect: Rotates a model according to the values given. For non-3D models, only the z value effects the model.

minaccuracy

  • Possible Values: Integer
  • Description: Determines a minimum accuracy the mobile client has to provide, before the 3D model will be shown.
  • Effect: The client application will not render any POIs where the minaccuracy is lower than the current position accuracy of the mobile client.

maxdistance

  • Possible Values: Integer
  • Description: Determines the max distance of a POI, before it will be displayed on the mobile client.
  • Effect: The client application will not render any POIs where the maxdistance is lower than the user's current distance to the POI.
  • Hints: This way of filtering valid information is considerably expensive on the client application. Please use a radius search or spatial database queries to send valid information to the client only.

mime-type

  • Possible Values: String (valid types only)
  • Description: It defines the type of media given for the client.
  • Effect: Depending on the mime type, different representations will be chosen for the information. The following mime-types are supported:
    image/png
    image/jpeg
    video/mp4
    audio/mp3
    text/plain
    model/md2 - not standardized
    model/obj - not standardized

    See Layout for more information.

mainresource

  • Possible Values: String (Url)
  • Description: Depending on the mimetype, this tag will hold a url to an image, to an encrypted 3D model file or an audio or video file. For mime-type text/plain, this is optional.

thumbnail

  • Possible Values: String (Url)
  • Description: Holds a url to an image file which will be displayed with the POI in live view.
  • Effect: Shows a thumbail image with a POI in the live view. The thumbnail can be png or jpg format and should not exceed the size of 150x150 pixels.
    See Layout for more information.

icon

  • Possible Values: String (Url)
  • Description: Holds a url to an image file which will be displayed with the POI on the map.
  • Effect: Shows an icon on the map for a given POI. The icon can be png or jpg format and should not exceed the size of 40x40 pixels.
    See Layout for more information.

force3d

  • Possible Values: Boolean
  • Description: Force the display of the 3D model. Only valid in combination with mime-type model/md2 or model/obj.
  • Effect: Displays the 3D model, without showing the thumbnail first.
    See Layout for more information.

relativetoscreen

  • Possible Values: x:Float,Y:Float
  • Description: Displays a model screen fixed. Only relativetoscreen or l will be considered.
  • Effect: Fixes a model to the screen, e.g. for additional GUI elements. The lower left corner if the screen is 0,0; the upper right is 1,1.
    See Layout for more information.

showcorrectperspective

  • Possible Values: Boolean
  • Description: For usability reason we adjust model distances in the world, so they can be seen by users. Set to "true" to avoid view correction.
  • Effect: Set the model at the correct location in the world.
    See Layout for more information.

homepage

  • Possible Values: String (Url)
  • Description: Provides a URL to be linked to a POI.
  • Effect: If this parameter is set, an "Open Web" button will be displayed.
    See Layout for more information.

route

  • Possible Values: Boolean
  • Description: Determines, whether a user should be able to be navigated to that POI.
  • Effect: If this parameter is set, an "Directions" button will be displayed.
    See Layout for more information.

s

  • Possible Values: Float
  • Description: For 3D models only! Sets the scale of a model.

behaviour - type

  • Possible Values: (idle, click, hit)
  • Description: For animated 3D models only! Behaviours determine possible animations of a 3D model. It sets the type of the animation.
  • Hints: If type is set to "idle" the stated animation of the model will be started, after the model is done loading, "click" animations will be started upon clicking, "hit", when the model was hit (shooter style).

behaviour - length

  • Possible Values: Float
  • Description: For animated 3D models only! Behaviours determine possible animations of a 3D model. Sets the length of an animation in frames.
  • Hints: Set length in frames to 0 means looping the animation.

behaviour - node_id

  • Possible Values: String
  • Description: For animated 3D models only! Behaviours determine possible animations of a 3D model. Sets the name of the animation that shall be started.
  • Effect: This parameter determines the animation that will be started after loading the model.
    See 3D Models for more information.

customization - name

  • Possible Values: String
  • Description: Name of the customization or the name of the animation to be listened for type "startAnimation" and node_id "animationEnded"

customization - type

  • Possible Values: (video/sound/url/triggerEvent/startAnimation)
  • Description: Type of value given in the customization. It will either open or start the type given (url, sound, video), trigger a pois/event reuqest on your server or start an animation.

customization - node_id

  • Possible Values: (click/idle/onTargetDetect/animationEnded)
  • Description: When is the customization started.
  • Hints: "click"/"idle"/"onTargetDetect" is valid for all customization types and animationEnded only in combination with animation control.
    See 3D Models for more information.

customization - value

  • Possible Values: String (Url)
  • Description: Provides a url to a website, video file or sound file)
  • Effect: Depending on the node_id, at a certain point or user interaction, the value will be loaded or started.
    See Media in junaio - Sound, Movies and Images for more information.

resource

  • Possible Values: String (Url)
  • Description: For 3D models only! Defines a url to a texture or material file for a 3D model.
  • Effect: The image file pointed to within this tag, will define the look of a 3D model.
    See 3D Models for more information.