|
|
@@ -1,7 +1,6 @@
|
|
|
-Goals
|
|
|
-=====
|
|
|
-
|
|
|
-Definitions:
|
|
|
+Definitions
|
|
|
+===========
|
|
|
+:
|
|
|
- **event**: a faire, convention, congress or any other kind of meeting
|
|
|
- **registered person**: someone who said it will attend at the event
|
|
|
- **attendee**: a person who actually *show up* (checked in) at the event
|
|
|
@@ -13,7 +12,7 @@ Paths
|
|
|
Webapp
|
|
|
------
|
|
|
|
|
|
-These are the path you see in the browser (AngularJS does client-side routing: no request is issued to the web server, during navigation, if not for fetching data and issuing commands):
|
|
|
+These are the paths you see in the browser (AngularJS does client-side routing: no request is issued to the web server, during navigation, if not for fetching data and issuing commands):
|
|
|
|
|
|
- /#/events - the list of events
|
|
|
- /#/event/new - edit form to create a new event
|
|
|
@@ -51,8 +50,8 @@ The paths used to communicate with the Tornado web server:
|
|
|
- /login - login form
|
|
|
- /logout - when visited, the user is logged out
|
|
|
|
|
|
-Notice that the above path are the ones used by the webapp. If you plan to use them from an external application (like the _eventman_ barcode/qrcode scanner) you better prepend all the path with /v1.0, where 1.0 is the current value of API\_VERSION.
|
|
|
-The main advantage in doing so is that, for every call, a useful status code and a JSON value is returned (also for /v10/login that usually would show you the login page).
|
|
|
+Notice that the above paths are the ones used by the webapp. If you plan to use them from an external application (like the _eventman_ barcode/qrcode scanner) you better prepend all the path with /v1.0, where 1.0 is the current value of API\_VERSION.
|
|
|
+The main advantage of doing so is that, for every call, a useful status code and a JSON value is returned (also for /v1.0/login that usually would show you the login page).
|
|
|
|
|
|
Also, remember that most of the paths can take query parameters that will be used as a filter, like GET /events/:event_id/persons?name=Mario
|
|
|
|
|
|
@@ -165,7 +164,6 @@ Nice to have
|
|
|
------------
|
|
|
|
|
|
- a test suite
|
|
|
-- join the page used to add persons/events into the lists (shown when the filter field returns nothing and/or when a button is pressed)
|
|
|
- notifications for form editing and other actions
|
|
|
- authentication for administrators
|
|
|
- i18n
|
