wiki:Dev/Technical/ExportAPI

Version 4 (modified by pferreir, 3 years ago) (diff)

--

Indico HTTP Export API

http://indico.cern.ch/export/categ/2l5.json?&orderby=date&descending=true&from=20100120&to=20110202T150000Z00&limit=10 http://indico.cern.ch/export/event/1234.json?&orderby=date&descending=true&from=20100120&to=20110202T150000Z00&limit=10 http://indico.cern.ch/export/event/1234/0.json?&orderby=date&descending=true&from=20100120&to=20110202T150000Z00&limit=10

  • Output granularity:
    • events
    • sessions / contributions
    • only contributions
    • sub-contributions
  • Criteria (only one? several?)
    • Name - regexp?
    • Date/time
      • event criterion: start date, end date, happening
      • absolute interval: from/to
      • relative interval (next 2 hours, 5 days, 1 month...)
    • ID (URL implicit?)
    • Location - extension?
  • Results
    • Limit (number of results)
    • Order by (criterion) . date . alphabetic . ...
    • Suppress sorting if the result set is getting too big;
      • either just fail or return the incomplete set;
    • Descending - order of appearance
  • Metadata
    • Authors/speakers
    • Whole timetable? (w/ breaks, etc)
    • Materials?
    • Protection data?
  • Formats:
    • URL encoded?
    • JSON
      • jsonp?
    • XML
    • HTML 4
    • HTML 5 Microdata ?
    • YAML ?
    • RDF ?
    • CSV ?

Access

Others

  • Caching
    • File, memory, memcached?