Skip to content
This repository has been archived by the owner on Jun 28, 2020. It is now read-only.
Shubham Bhardwaj edited this page Oct 12, 2016 · 7 revisions

Android App API overview:

BASE URL: base

LOGIN:

URL: base/login
TYPE: POST
PARAMS:

  • email: user_email
  • password: user_password

RESPONSE:
{"status" : status_code,"message" : status_message,"user" : {"auth_token" : authentication_token, "name" : user's_name, "email" : email, "reg_no" : user_reg_no, "phone" :user_phone_number ,"block_room" :user_block_room, "gender" : m/f, "linkedin" : linkedin_url, "github" : github_url, "behance" : behance_url, "isAdmin" : true/false, "skills" : [string-array of skills],"slot_last_used" : *slot_countdown_time,"slot_tries" : times_slot_triggered}, "team" : { "name" : team_name, "members" : [object array of members with format ->{ "name" :member_name, "position" : member_position, "status" : member_status}]}}


TIMELINE:

URL: base/timeline
TYPE: POST
PARAMS:

  • email: user_email
  • auth_token: authentication_token

RESPONSE:
{"status" : status_code, "message" : status_message, "timeline" : [object-array of events of format-> { "title" : title_of_event,"start_time" : DDMMYYYYThh:mm (in 24 hrs format), "end_time" : DDMMYYYYTHH:MM (in 24 hrs format), "description": event_description, "image_url": event_image_url_else_null }]}


SPEAKERS:

URL: base/speakers
TYPE: POST
PARAMS:

  • email: user_email
  • auth_token: authentication_token

RESPONSE:
{"status" : status_code, "message" : status_message, "speakers" : [object-array of speakers of format-> { "name" : name_of_the_speaker, "description": speaker_description, "image_url": event_image_url_else_null,"designation":speaker_designation_with_company_name }]}


FAQ:

URL: base/faq
TYPE: POST
PARAMS:

  • email: user_email
  • auth_token: authentication_token

RESPONSE:
{"status" : status_code, "message" : status_message, "faqs" : [object-array of faqs of format-> { "question" : question_description, "answer": question's_answer}]}


API ASSIGNED:

URL: base/apis
TYPE: POST
PARAMS:

  • email: user_email
  • auth_token: authentication_token

RESPONSE:
{"status" : status_code, "message" : status_message, "apis" : [object-array of apis of format-> { "name" : api_name, "url": url_of_documentation, "logo" : api_logo_else_null }]}


SLOT MACHINE:

URL: base/slot
TYPE: POST
PARAMS:

  • email: user_email
  • auth_token: authentication_token
  • number_of_tries: times_slot_triggered
  • slots: slot1,slot2,slot3 (separated by comma)
    RESPONSE:
    {"status" : status_code, "message" : status_message, "slot":{"winner" : true/false}]}

LOGOUT:

URL: base/logout
TYPE: POST
PARAMS:

  • email: user_email
  • auth_token: authentication_token

RESPONSE:
{"status" : status_code, "message" : status_message}


##CHAT BOT
base_faq_url :https://arcane-stream-72838.herokuapp.com
URL: base_faq_url/faq
TYPE: GET
PARAMS:

  • email: user_email
  • question:asked_question
    RESPONSE:
    {"status" : status_code, "message" : status_message, "answer": question's_answer}

Some JSON field marked with star

  • slot_countdown_time: User can trigger the slot machine only after few interval of time. Every time he/she triggers, the countdown will sync with server. Even if user logout from app, next time he logs in, the timer begins from synced time. At start the value from server will be 0.

Please be strict with the parameter names, format and sequence.