No description, website, or topics provided.
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
src
.gitignore
.gitignore~
LICENSE
README.md
requirements.txt

README.md

Location_Assistance

Location Assistance is location based service with features like:

  1. One to one location sharing
  2. Location + Activity sharing with friends.
  3. Location based reminders.
  4. Location based automatic mobile settings.

The project is in its intial development phase, product will be ready soon 👍 😄

#API Guidelines:

##Register Table ###1.New user registration:

  • URL: http://awasthikamal97.pythonanywhere.com/location/registration
  • Fields names and values:
    1. 'username' : "example_username"
    2. 'password' : "example_password"
    3. 'first_name' : "example_name"
    4. 'last_name' : "example_name"
  • password will be saved a hash
  • Response:
      if username is already registered: "username already taken"
      Sucessful Registration: "registration successful"
  • POST request values are to be sent in test form(not JSON)

###2.Login registered user:

  • URL: http://awasthikamal97.pythonanywhere.com/location/login
  • Fields names and values:
    1. 'username' : "example_username"
    2. 'password' : "example_password"
  • username and password will be authenticated and response will be returned
  • Response:
      if credentials are valid: "login successful"
      If credentials are invalid: "invalid credentials"
  • POST request values are to be sent in test form(not JSON)

##SaveSettings Table ###1.Set New Settings

  • URL: http://awasthikamal97.pythonanywhere.com/location/set_settings
  • Field names and values:
    1. 'longitude' : '23.76986543' - (decimal value, 8 digits after decimal and 2 digits before decimal)
    2. 'latitude' : '34.78905634' - (decimal value, 8 digits after decimal and 2 digits before decimal)
    3. 'volumeLevel' : '4.5' - (decimal value)
    4. 'vibrationMode' : 'True' - (Boolean Value)
    5. 'brightness' : '6.7' - (decimal value)
    6. 'mobileData' : 'True' - (Boolean Value)
    7. 'wifi' : 'True' - (Boolean Value)
    8. 'bluetooth' : 'True' - (Boolean Value)
    9. 'username' : "kamal' - (Character Field)
    10. 'activity' : "going for shopping" - (Text Value)
  • after the user authenctication, settings will be saved
  • Response:
      sucessful save: "settings saved"
      error in input: "error in user input"
      If username is does not found in database: "username not registered"

###2.SyncSettings

  • URL: http://awasthikamal97.pythonanywhere.com/location/sync_settings
  • Field names and values:
    1. 'username' : "kamal' - (Character Field)
  • after the user authenctication, settings will be filtered on the basis of username
  • Response:
      response: setiings list in JSON form
      If username is does not found in database: "username not registered"

##Live Table ###1.Record Live Status

  • URL: http://awasthikamal97.pythonanywhere.com/location/set_status
  • Field names and values:
    1. 'longitude' : '23.76986543' - (decimal value, 8 digits after decimal and 2 digits before decimal)
    2. 'latitude' : '34.78905634' - (decimal value, 8 digits after decimal and 2 digits before decimal)
    3. 'username' : "kamal' - (Character Field)
    4. 'time' : "2016-10-19 12:34:12" - (DateTime Field)
  • after verifying the username, live status would be recorded
  • Response:
      sucessful save: "live status recorded"
      If username is does not found in database: "username not registered"

##Reminder Table ###1.Set Reminder

  • URL: http://awasthikamal97.pythonanywhere.com/location/set_reminder
  • Field names and values:
    1. 'longitude' : '23.76986543' - (decimal value, 8 digits after decimal and 2 digits before decimal)
    2. 'latitude' : '34.78905634' - (decimal value, 8 digits after decimal and 2 digits before decimal)
    3. 'username' : "kamal' - (Character Field)
    4. 'reminder_title' : "Buy Milk" - (Character Field)
    5. 'reminder_text' : "Buy milk from here, this place is really good" - (Text Field)
  • after verifying the username, reminder would be recorded
  • Response:
      sucessful save: "reminder has been set"
      If username is does not found in database: "username not registered"

###2.Sync Reminders

  • URL: http://awasthikamal97.pythonanywhere.com/location/sync_reminders
  • Field names and values:
    1. 'username' : "kamal' - (Character Field)
  • after the user authenctication, settings will be filtered on the basis of username
  • Response:
      Response: User's reminders in JSON form
      If username is does not found in database: "username not registered"

###2.Delete Reminder

  • URL: http://awasthikamal97.pythonanywhere.com/location/elete_reminder
  • Field names and values:
    1. 'username' : "kamal' - (Character Field)
    2. 'id' : "12" - (Integer Field)
  • after verifying the username, reminder would be deleted
  • Response:
      sucessful save: "reminder deleted sucessfull"
      If username is does not found in database: "username not registered"