Page Types

== URL ==
Format of the URL:
 <nowiki>http://domain.tld/index.php?type=xx</nowiki>
or
 <nowiki>http://domain.tld/index.php?id=xx</nowiki>
or
 <nowiki>http://domain.tld/index.php?type=xx&id=xx (only works with type=80 and if a special type is set for the id=0 page)</nowiki>

== Parameter for XML-Output ==
=== Content ===
==== type=10 - shows the whole content and configuration in one page ====

 type=10 (same as type=40 plus all id=xx together)


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| description_html     || Description (Text, which will be shown in "About us"-page, formated as HTML         
|-
| about_img             || Image with relative path that is shown in "about us" 
|-
| adminmail || Emailadrress which is used to send feedback to issuer of the software  
|}


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| bookmark_icon     || Bookmark-Icon shown on the first page         
|-
| showall_icon            || Icon "showall" shown on the first page 
|-
| history_icon || History-icon shown on the first page  
|-
| rootlink_icon     || Icon that is shown to get to the first root-page ("home")  
|-
| location_icon     || Icon that is shown on the lower left side for triggering the location-update  
|-
| settings_icon     || Brings up the settings dialog  
|-
| Prior_icon     || Icon for previous "page" (should be an arrow)  
|-
| Next_icon     || Icon for next "page" (should be an arrow) 
|-
| DirUp_icon     || Icon for sortging alphabetically (up)  
|-
| DirDown_icon     || Icon for sortging alphabetically (down) 
|-
| DistUp_icon     || Sorting via distance (upwards)  
|-
| DistDown_icon     || Sorting via distance (down) 
|-
| Delete_icon     || Deleting items from bookmarks  
|-
| default_icon     || This icon ish shown when no image is specified  
|}


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| menu id     || id of the item (same as page id)         
|-
| menu_title             || Title of the item (shown on tableview, item heading) 
|-
| adminmail || Emailadrress which is used to send feedback to issuer of the software  
|-
| menu_desc || Shows short description on table view  
|-
| menu_image || Thumbnail-icon that is in the tableview (if there are two, take the first one)
|-
| page id     || id of the item (same as menu id)   
|-
| name || Heading for the item  
|-
| desc || Text of the item  
|-
| lat || Geocordinate (lat)  
|-
| lon || Geocordinate (lon)  
|-
| largeimg || Image that is shown on the page. This image is shown in full when clicked and as a small image when on the item-page  
|-
| img || Image (depreciated, will be removed soon, if not already)  
|}

==== type=11 - shows the whole content and configuration in one page "minus" the icons ====

 type=11 (same as type=10 minus the icons section)

=== Configuration ===

==== type=40 - loads the configuration and corresponding images ==== 

 type=40


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| description_html     || Description (Text, which will be shown in "About us"-page, formated as HTML         
|-
| about_img             || Image with relative path that is shown in "about us" 
|-
| adminmail || Emailadrress which is used to send feedback to issuer of the software  
|}


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| bookmark_icon     || Bookmark-Icon shown on the first page         
|-
| showall_icon            || Icon "showall" shown on the first page 
|-
| history_icon || History-icon shown on the first page  
|-
| rootlink_icon     || Icon that is shown to get to the first root-page ("home")  
|-
| location_icon     || Icon that is shown on the lower left side for triggering the location-update  
|-
| settings_icon     || Brings up the settings dialog  
|-
| Prior_icon     || Icon for previous "page" (should be an arrow)  
|-
| Next_icon     || Icon for next "page" (should be an arrow) 
|-
| DirUp_icon     || Icon for sortging alphabetically (up)  
|-
| DirDown_icon     || Icon for sortging alphabetically (down) 
|-
| DistUp_icon     || Sorting via distance (upwards)  
|-
| DistDown_icon     || Sorting via distance (down) 
|-
| Delete_icon     || Deleting items from bookmarks  
|-
| default_icon     || This icon ish shown when no image is specified  
|}


==== type=70 - config images without configuration ====

 type=70 (part of type=40)


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| bookmark_icon     || Bookmark-Icon shown on the first page         
|-
| showall_icon            || Icon "showall" shown on the first page 
|-
| history_icon || History-icon shown on the first page  
|-
| rootlink_icon     || Icon that is shown to get to the first root-page ("home")  
|-
| location_icon     || Icon that is shown on the lower left side for triggering the location-update  
|-
| settings_icon     || Brings up the settings dialog  
|-
| Prior_icon     || Icon for previous "page" (should be an arrow)  
|-
| Next_icon     || Icon for next "page" (should be an arrow) 
|-
| DirUp_icon     || Icon for sortging alphabetically (up)  
|-
| DirDown_icon     || Icon for sortging alphabetically (down) 
|-
| DistUp_icon     || Sorting via distance (upwards)  
|-
| DistDown_icon     || Sorting via distance (down) 
|-
| Delete_icon     || Deleting items from bookmarks  
|-
| default_icon     || This icon ish shown when no image is specified  
|}



==== type=90 - configuration without the config images ====

 type=90 (part of type=40)


{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| description_html     || Description (Text, which will be shown in "About us"-page, formated as HTML         
|-
| about_img             || Image with relative path that is shown in "about us" 
|-
| adminmail || Emailadrress which is used to send feedback to issuer of the software  
|}


=== Update ===
==== type=20 - Tree of ids and timestamps ====
 type=20

Shows a XML-page with menu id="xx" and updated="xxxx" where id carries the id of the page and updated is the timestamp. 

Use this output for comparing the timestamps to find out which page (id) has been updated.

 <menu id="xx" updated="1251036675">
  <page id="xx" updated="1255448874"/>
 </menu>

==== id=xx - XML of the item (leaf) ====

{| border="2" cellspacing="0" cellpadding="4" rules="all" style="margin:0em 0em 1em 0em; border:solid 1px #AAAAAA; border-collapse:collapse; background-color:#F9F9F9; font-size:95%; empty-cells:show; color:black; {{{1}}}"
|-
! Parameter                                          !! Funktion                           
|-
| menu id     || id of the item (same as page id)         
|-
| menu_title             || Title of the item (shown on tableview, item heading) 
|-
| adminmail || Emailadrress which is used to send feedback to issuer of the software  
|-
| menu_desc || Shows short description on table view  
|-
| menu_image || Thumbnail-icon that is in the tableview (if there are two, take the first one)
|-
| page id     || id of the item (same as menu id)   
|-
| name || Heading for the item  
|-
| desc || Text of the item  
|-
| lat || Geocordinate (lat)  
|-
| lon || Geocordinate (lon)  
|-
| largeimg || Image that is shown on the page. This image is shown in full when clicked and as a small image when on the item-page  
|-
| img || Image (depreciated, will be removed soon, if not already)  
|}

=== HTML ===
==== type=80 - HTML-output ====
 type=80 
Renders html-output for checking data

==== type=50 - about-page preview ====
 type=50
Renders a preview from the description_html in the browser.


=== Checkin (I was there) ===
==== type=702 - posting a checkin for a UID ====
 type=702

- The data have two value-pairs:
 tx_lpiphone_pi1[board][deviceid]=value
 tx_lpiphone_pi1[board][comment]=value
 tx_lpiphone_pi1[board][lon]=value
 tx_lpiphone_pi1[board][lat]=value
 id=value

The thrid value is a md5-hash created form the values in the above order PLUS a secret key
The calculated hash is sent in the variable 
 tx_lpiphone_pi1[myMd5hash]
(note that the third value has no [board] prefix to it!!)

The ''checkin'' value is a unix timestamp that is generated on the server and stored as this.

The response XML for success looks as follwos:
 <root>
   <checkinID>7</checkinID>
   <databaseSuccess>TRUE</databaseSuccess>
   <usermessage>Vielen Dank für den Kommentar! Wir werden ihn nach Prüfung frei schalten.</usermessage>
   <deviceid>deiceid</deviceid>
   <comment>This is the comment put in</comment>
   <lon>47.123456</lon>
   <lat>9.123456</lat>
   <checkin>1290364765</checkin>
   <md5hash>02e0adc2608671b08fc177dbaed5fde3</md5hash>
   <crdate>1290364765</crdate>
   <tstamp>1290364765</tstamp>
   <hidden>0</hidden>
   <pid>118</pid>
   <username>iphone-user_10</username>
 </root>

The response XML for failure looks like this:
 <root>
    <databaseSuccess>FALSE</databaseSuccess>
    <usermessage>An error has occured - your comment was not posted to ouue system - sorry!</usermessage>
 </root>

==== type=703 - displaying checkins for page ====

Parameters: 
 type=703&id=xx

Appending "&type=703" to the "id=xx" shows the checkins that reside on this page in this XML-format. :
 <root>
   <checkin checkinid="2" menuid="140" updated="1289355905">
     <nickname>iphone-user_99</nickname>
     <checkin_tstamp>1289354813</checkin_tstamp>
     <comment>test99</comment>
     <userimage>typo3temp/pics/f38056cdd0.png</userimage>
   </checkin>
 </root>

It shows as many of the <comments> as there are on the page.
The parameter "commentid" is unique in the system.
The parameter menuid is the item to which it belongs.

==== type=706 - has checked in ====

Parameters:
 type=706&id=xx&tx_lpiphone_pi1[deviceid]=DEVICEID

Returnes the checkin status for the combination of a ''page-id'' and the given ''deviceid''
 <root>
   <checkin checkinid="20">
     <checkin_status>TRUE</checkin_status>
     <checkin_timestamp>12345678</checkin_timestamp>
     <deiceid>DEVICEID</deviceid>
   </checkin>
 </root>

If the '''deviceid''' has no checkin the following XML will be returned
 <root>
   <checkin_status>FALSE</checkin_status>
 </root>

==== type=707 - get checkins for user by deviceid ====

Parameters:
 type=707&tx_lpiphone_pi1[deviceid]=DEVICEID

Returnes a XML with all pageids of the users chekcin
 <root>
   <deviceid>DEVICEID</deviceid>
   <nickname>test99</nickname>
   <checkins>
      <checkin_pid>10</checkin_pid>
      <checkin_pid>25</checkin_pid>
      <checkin_pid>83</checkin_pid>
      <checkin_pid>189</checkin_pid>
      <checkin_pid>91</checkin_pid>
   </checkins>
 </root>

==== type=708 - all checkins from all users ====

Parameters:
 type=708

Returnes a XML-list of all checkins with usernames in the system
 <root>
   <checkin_pid timestamp="1289354644" deviceid="test99">94</checkin_pid>
   <checkin_pid timestamp="1289354813" deviceid="test99">117</checkin_pid>
   <checkin_pid timestamp="1289357127" deviceid="test2222">117</checkin_pid>
 </root>

=== Comments ===
==== type=802 - adding comments ====

- The data have two value-pairs:
 tx_lpiphone_pi1[board][deviceid]=value
 tx_lpiphone_pi1[board][comment]=value
The thrid value is a md5-hash created form the values in the above order PLUS a secret key
The calculated hash is sent in the variable 
 tx_lpiphone_pi1[myMd5hash]
(note that the third value has no [board] prefix to it!!)

==== type=803 - displaying comments ====

Parameters: 
 type=803&id=xx&mydeviceid=DEVICEID

Appending "&type=803" to the "id=xx" shows the comments that reside on this page in this XML-format. Adding the parameter mydeviceid=DEVICEID will also display the username. If there is no Parameter ''mydeviceid'' the username will be ''FALSE'' (TODO: this is broken!!) :
 <root>
   <current_username>iphone_user_123</current_username>
   <comments commentid="2" menuid="40" updated="1262222505">
   <nickname>test99</nickname>
   <comment>test99</comment>
   <deviceid>test99</deviceid>
  </comments>
 </root>

It shows as many of the <comments> as there are on the page.
The parameter "commentid" is unique in the system.
The parameter menuid is the item to which it belongs.

==== type=804 - query of the username ====

The server will generate a username based to the deviceID (which then can be updated)

Following parameter are needed: 
* tx_lpiphone_pi1[deviceid]=value
* tx_lpiphone_pi1[myCheckHash]=value 
(note that is a differnt value than the myMd5hash) This is the calculated value from "secretKey and the deviceid. Be ware of the order: The deviceid has to be first and then the secret key.

If a user to the deviceid exists the response will look like this:
 <root>
   <username>username</username>
 </root>

If there is no user to the given deviceid the output will look something like this:
 <root>
   <crdate>1265248038</crdate>
   <tstamp>1265248038</tstamp>
   <disable>0</disable>
   <pid>567</pid>
   <usergroup>1</usergroup>
   <tx_lpiphone_deviceid>12345678901234567890</tx_lpiphone_deviceid>
   <username>iphone-user_4</username>
 </root>
The most important value is the <username>. This is tied to the deviceId and can can/will be used later as well. It is stored in the usersection of the database.

If validation of the hash fails the response will look like this:
 <root>
   <username>
   An error has occured - no user was created - sorry!
   </username>
 <error>HASHCHECK_FAILED</error>
 </root>

==== type=805 - updating a user ====

Parameters:
 tx_lpiphone_pi1[deviceid]=deviceid
 tx_lpiphone_pi1[myCheckHash]=calculated_md5_hash
 tx_lpiphone_pi1[new_username]=username

The hash is checked the same way the ohters are: deviceid,new_username, secretkey * md5

On success something like this is returned:
 <root>
   <old_username>old_username</old_username>
   <sucessmessage_userupdate>You have successfully updated a user!</sucessmessage_userupdate>
   <sucess>TRUE</sucess>
   <username>username</username>
   <deviceid>xxxxxxxxxxx</deviceid>
 </root>

Note that the <old_username> is also there (just for reference and checking). The updated username is wrapped in <username>

The failmessage looks like this:
 <root>
   <failmessage_userupdate>
   An error has occured - user was not updated - sorry!
   </failmessage_userupdate>
   <sucess>FALSE</sucess>
   <deviceid>xxxxxxxxxxx</deviceid>
 </root>


==== type=806 - comment-count ====
 id=xx&type=806
Returns the comment-cont of a given page-id (id=xx)
 <root>
  <comment_count>23</comment_count>
 </root>


==== type=807 - all comments in the system ====
 type=807

Shows all comments availible in the syste with its pageids

 <root>
   <comment pageid="92" deviceid="DEVICEID">testcomment99</comment>
   <comment pageid="117" deviceid="DEVICEID">testcomment88</comment>
   <comment pageid="127" deviceid="DEVICEID">testcomment77</comment>
 </root>

=== Shows locations on a Google map (XML for that) ===
==== type=900 - output for a google-map ====
 type=900 

Outputs XML that the google-maps API could read

 <markers>
   <marker id="568">
     <menu_image>typo3temp/pics/486d1d1adf.jpg</menu_image>
     <name>Disneyland Railroad</name>
     <lat>33.809972388658565</lat>
     <lon>-117.91893929243088</lon>
   </marker>
 <markers>