[HH-6][GUIDE] Add guide module

[roxanamacarie]

This module will implement the logic and the necessary requests between client and server modules for the guide module.

In the guide module, users can choose between two options:

• classical tourist guide - some users can sign up for being a local/licensed tourist guide, others can contact them
• own guide => planner module - you create your personalized journey.

Guide

1. getGuides is a HTTP GET request which returns a list with all the quides from a city

Request example http://localhost:8095/getGuides?city=<city-name>&md5Key=<valid-md5-key>

---

2. getGuideDetails is a HTTP GET request which returns details for a specific guide. This should be used when a user is interested in a specific guide and wants to see important details in order to contact him.

Request example http://localhost:8095/geGuideDetails?city=<city-name>&gid=<guide-id>&md5Key=<valid-md5-key>

---

3. updateGuide is HTTP POST request which can do multiple operations.

The operations a user can do:

• ADD guide Request example http://localhost:8095/updateGuide and the body which is application/json

  {
  "city": "bucharest",
  "name": "John Doe",
  "md5KeyGuide": "--------",
  "timeStamp": "3 Jun 2008 11:05",
  "description": "I am a local and I want to offer free tours.",
  "email": "john.doe@gmail.com",
  "phone": "+40711111111"
  "gid": 0,
  "operation": "add"
  }

• REMOVE quide Request example http://localhost:8095/updateGuide and the body which is application/json

  {
  "city": "bucharest",
  "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267",
  "md5KeyCurrent": "a7e726de9b7e85e5c1f52bf056fd5267",
  "gid": 0,
  "operation": "remove"
  }

• EDIT guide details
  1. Edit guide email Request example http://localhost:8095/updateQuestion and the body which is application/json

     {
     "city": "bucharest",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267",
     "md5KeyCurrent": "a7e726de9b7e85e5c1f52bf056fd5267",
     "gid": 0,
     "operation": "edit",
     "editField": {
     "email": "johnDoe@gmail.com"
     }
     }

  2. Add comment to guide Request example http://localhost:8095/updateQuestion and the body which is application/json

     {
     "city": "bucharest",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267",
     "md5KeyCurrent": "a7e726de9b7e85e5c1f52bf056fd5267",
     "gid": 0,
     "operation": "edit",
     "editField": {
     "comments": {
     "operation": "add",
     "timeStamp": "3 Jun 2008 11:05",
     "comment": "What about a comment..."
     }
     }
     }

  3. Remove comment to guide Request example http://localhost:8095/updateQuestion and the body which is application/json

     {
     "city": "bucharest",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267",
     "md5KeyCurrent": "a7e726de9b7e85e5c1f52bf056fd5267",
     "gid": 0,
     "operation": "edit",
     "editField": {
     "comments": {
     "operation": "remove",
     "commId": "adbf5a778175ee757c34d0eba4e932bc",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267"
     }
     }
     }

  4. Edit comment to question Request example http://localhost:8095/updateQuestion and the body which is application/json

     {
     "city": "bucharest",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267",
     "md5KeyCurrent": "a7e726de9b7e85e5c1f52bf056fd5267",
     "gid": 0,
     "operation": "edit",
     "editField": {
     "comments": {
     "operation": "edit",
     "commId": "adbf5a778175ee757c34d0eba4e932bc",
     "comment": "Modified comment",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267"
     }
     }
     }

  5. Add like/dislike to question Request example http://localhost:8095/updateQuestion and the body which is application/json

     {
     "city": "bucharest",
     "md5KeyGuide": "a7e726de9b7e85e5c1f52bf056fd5267",
     "md5KeyCurrent": "a7e726de9b7e85e5c1f52bf056fd5267",
     "qid": 0,
     "operation": "edit",
     "editField": {
     "likes": {
     "operation": "add",
     "react": "like"
     }
     }
     }