3 A feature represents a location. It has index _fid_. It has two dimensions:
4 _lagitude_ and _longitude_. It may have an image represented by it's url.
5 This field is called _imgurl_; it may also have a _title_ and/or a _description_.
7 # client to server communication:
9 Client submits a classic html form to server.
11 **note**: In this documentation, php notation is used (`_POST` and `_FILES`),
12 but server may be written in any language.
14 ` _POST["password"]` and `_POST["user"] may contain user name and password. If
15 they are set, access is checked. If they is not set, cookies are checked. If
18 `_POST["request"]` is either:
21 asks for authentication
25 * `$_POST ["pass_current"]` must contain current password. This is needed: cookie
26 authentification is not enough.
27 * `$_POST ["pass_new"]` must contain new password
31 * `$_POST ["newuser_name"]` must contain user name
32 * `$_POST ["newuser_password"]` must contain user password
34 Only admin can add new users.
40 * `_POST["lon"]` must contain feature longitude
41 * `_POST["lat"]` must contain feature latitude
42 * `_POST["title"]` may contain feature title
43 * `_POST["description"]` may contain feature description
44 * `_FILES["image_file"]` may contain an uploaded image
47 to delete an existing feature
49 * `_POST["fid"]` must contain feature id
52 to modify an existing feature
54 * `_POST["fid"]` must contain feature id
55 * `_POST["lon"]` must contain feature longitude
56 * `_POST["lat"]` must contain feature latitude
57 * `_POST["title"]` may contain feature title
58 * `_POST["description"]` may contain feature description
60 if `_POST["keep_img"]` is "yes", feature image will not be modified.
61 Otherwise, `_FILES["photo_file"]` is checked for an uploaded file. If
62 `_FILES["photo_file"]` is empty, existing feature image will be deleted.
63 Otherwise, uploaded file will replace current feature image.
65 # server reply to client:
66 Server replies with xml content. In an ideal world, reply would be just xml
67 content. But due to technical issues, syp must wrap xml content in the body of a
68 html document. So for example, instead of sending
70 `<error reason="unauthorized"></error>`
72 as _text/xml_, syp sends
74 `<html><head></head><body><error reason="unauthorized"></error></body></html>`
80 reply is something like `<error reason="?reason?"></error>` with _?reason?_ can be either:
82 * `unauthorized`: user is not authorized to execute request, or authentication failed
83 * `server`: an error occured on server side (such as database problem)
84 * `request`: server could not understand request
85 * `toobig`: uploaded file was too big
86 * `notation`: uploaded file was not an image
87 * `nochange`: when trying to update a feature, there is nothing to update (ie: no field of the feature has changed)
88 * `wrongpass`: wrong current password when trying to change password
89 * `newuser_exists`: when trying to add an user which has the same name as an already registered user
93 * `<success request="auth"><user>?user_name?</name></success>`:
94 authentication was successfull. ?user_name? is name of authenticated user.
96 * `<success request="newuser"><user>?user_name?</name></success>`:
97 new user addition was successfull. ?user_name? is name of newly added user.
99 * `<success request="changepass"><user>?user_name?</name></success>`:
100 password change was successfull. ?user_name? is name user whose password
103 * `<success request="del">
108 deletion was successfull. _?id?_ was property of deleted feature
110 * `<success request="add">
113 <imgurl>?imgurl?</imgurl>
114 <description>?description?</description>
115 <heading>?heading?</heading>
120 addition was successfull. _?id?_, _?imgurl?_, _?description?_,
121 _?heading?_, _?lon?_, _?lat?_ are properties of added feature;
123 * `<success request="update">
126 <imgurl>?imgurl?</imgurl>
127 <description>?description?</description>
128 <heading>?heading?</heading>
133 update was successfull. _?id?_, _?imgurl?_, _?description?_, _?heading?_,
134 _?lon?_, _?lat?_ are properties of updated feature;