api-docs/reference/events.rst

   1 .. _events-api:
   2
   3 Events API
   4 ==========
   5
   6
   7 Resources
   8 ---------
   9
  10 The Events API defines the following resources ::
  11
  12     /user/<username>/events
  13     /user/<username>/events/<id>
  14
  15
  16 Upload Events
  17 -------------
  18
  19 Request ::
  20
  21     POST /user/<username>/events
  22     Content-Tpe: application/json
  23
  24
  25 Responses:
  26
  27 Processed immediatelly ::
  28
  29     204 No Content
  30
  31
  32 Accepted for later processing ::
  33
  34     202 Accepted
  35
  36
  37
  38 Download Events
  39 ---------------
  40
  41 Parameters
  42
  43 * since (optional, default 0)
  44
  45
  46 Request ::
  47
  48     GET /user/<username>/events
  49
  50
  51 Responses.
  52
  53 Response ::
  54
  55     200 OK
  56     Content-Tpe: application/json
  57     TODO ...?
  58
  59
  60 Response is being prepared ::
  61
  62     203 Found / 202 See Other
  63     Link: /user/<username>/events/<id>
  64
  65
  66 The server is preparing the result at the specified resource. The client should
  67 try to fetch the data from the given URLs. ::
  68
  69     GET /user/<username>/events/<id>
  70     Content-Tpe: application/json
  71
  72
  73 A 404 might be returned before the data is ready. The client may retry after
  74 xxx seconds. ::
  75
  76     404 Not Found
  77
  78
  79 When the data is ready, 200 will be returned ::
  80
  81     200 OK
  82     Content-Tpe: application/json
  83
  84     TODO: body...
  85
  86
  87 When the data is no longer available, a 410 is returned. ::
  88
  89     410 Gone
  90
  91