API guide

1. Adding a new session.

• URL : http://localhost:5000/add

• Set Header:

• Content-Type application/json

• if do_save is set then it will store this configuration of data sources against a Session_id which will be returned in json format.

• Request : POST
  { "github_by_user" : ["ninjatrench", "irl"], "github_by_repo" : ["dpocock/github-icalendar"], "bitbucket" : ["jagguli/aioweb"], "bugzilla" : ["screen splash", "ww"], "direct" : "http://<direct_ical_url>/", "ubuntu_events" : "True", "rss" : "http://<rss feed url>", "atom" : "http://<atom event url>", "deb_summit" : "True", "udd" : ["daniel@pocock.pro"], "do_save" : "True" }

• Response: { "Session_id": "<session_id> string of alphanumeric characters of length 12", "Success": true }

• If do_save is not set, it will return a downloadable ical file.

• Request : POST
  { "github_by_user" : ["ninjatrench", "irl"], "github_by_repo" : ["dpocock/github-icalendar"], "bitbucket" : ["jagguli/aioweb"], "bugzilla" : ["screen splash", "ww"], "direct" : "http://<direct_ical_url>/", "ubuntu_events" : "True", "deb_summit" : "True", "udd" : ["daniel@pocock.pro"], }

2. Retriveing Session details via session_id

• URL : http://localhost:5000/get/<session_id>

• Request : GET

• If key exists then it will be returned in JSON format.

• Response: { "direct": "http://<direct_ical_url>/", "deb_summit": "True", "github_by_repo": [ "dpocock/github-icalendar" ], "session_id": "QuISXHcwAAna", "bugzilla": [ "screen splash", "ww" ], "udd": [ "daniel@pocock.pro" ], "bitbucket": [ "jagguli/aioweb" ], "ubuntu_events": "True", "github_by_user": [ "ninjatrench", "irl" ] }

• If provided session_id does not exist then it returns corresponding message

• Response: { "Message": "Specified Session does not found.", "Error": true }

3. Directly downloading ical file from session_id. It usually takes about a minute to generate response, if all data sources are selected. (AJAX calls and jquery calls are responded as well)

• URL : http://localhost:5000/download/<session_id>
• Request : GET
• Response : Downloadable ical file.

4. Generate Short URL for session's permanent URL

• URL : http://localhost:5000/download

• Request : POST
  { "url" : "http://<link>" }

• Response: { "Success": True, "Url": "http://deb.li/<something> }