Indico HTTP Export API

• URLs
  • ​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
  • ​http://indico.cern.ch/export/event/1234/0.json

• 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

• HTTPS only
• HTTP auth?
• Cookie?
• SSO? Is there anything?
• API key for specific user?
  • ​http://broadcast.oreilly.com/2009/12/principles-for-standardized-rest-authentication.html
• client-side certificates?

Others

• Caching
  • File, memory, memcached?