api_data.js

define({ "api": [
  {
    "type": "get",
    "url": "/match/activity",
    "title": "Request User Activity list",
    "name": "getMyActivity",
    "description": "<p>Request All list of User Activity.</p>",
    "group": "Match",
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n{\n  \"msg\": \"Success\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "Fail",
          "content": "HTTP/1.1 400 Bad Request\n{\n  \"err_point\": {err_msg}\n}",
          "type": "json"
        },
        {
          "title": "HTTP/1.1 401 Not Authenticated",
          "content": "HTTP/1.1 401 Not Authenticated\n{\n  \"err_point\": \"Authentication failed. Please sign in first.\"\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/match.route.js",
    "groupTitle": "Match"
  },
  {
    "type": "post",
    "url": "/match/request",
    "title": "Send request to mentor",
    "name": "requestMentoring",
    "description": "<p>Mentee request mentoring to mentor via Email.</p>",
    "group": "Match",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "mentor_id",
            "description": "<p>ObjectId of mentor who want to get mentoring service.</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "content",
            "description": "<p>Email contains this content.</p>"
          }
        ]
      }
    },
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n{\n  \"msg\": \"SendMail - Success to Send an email.\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "Fail",
          "content": "HTTP/1.1 400 Bad Request\n{\n  \"err_point\": \"SendMail - Fail to Send an email.\"\n}",
          "type": "json"
        },
        {
          "title": "HTTP/1.1 401 Not Authenticated",
          "content": "HTTP/1.1 401 Not Authenticated\n{\n  \"err_point\": \"Authentication failed. Please sign in first.\"\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/match.route.js",
    "groupTitle": "Match"
  },
  {
    "type": "post",
    "url": "/match/response",
    "title": "Send response to mentee",
    "name": "responseMentoring",
    "description": "<p>Mentor response mentoring to mentee.</p>",
    "group": "Match",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "match_id",
            "description": "<p>ObjectId of match to response.</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "option",
            "description": "<p>{accept : 1 , reject : 0}</p>"
          }
        ]
      }
    },
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n{\n  \"msg\": \"Success\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "Fail",
          "content": "HTTP/1.1 400 Bad Request\n{\n  \"err_point\": {err_msg}\n}",
          "type": "json"
        },
        {
          "title": "HTTP/1.1 401 Not Authenticated",
          "content": "HTTP/1.1 401 Not Authenticated\n{\n  \"err_point\": \"Authentication failed. Please sign in first.\"\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/match.route.js",
    "groupTitle": "Match"
  },
  {
    "type": "get",
    "url": "/users/all",
    "title": "Request All User info",
    "name": "getAll",
    "group": "User",
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n[\n {\n   User1's Info\n },\n {\n   User2's Info\n },\n {\n   User3's Info\n },....\n]",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "HTTP/1.1 401 Not Authenticated",
          "content": "HTTP/1.1 401 Not Authenticated\n{\n  \"err_point\": \"Authentication failed. Please sign in first.\"\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/users.route.js",
    "groupTitle": "User"
  },
  {
    "type": "get",
    "url": "/users/mentorlist",
    "title": "Request Mentor's list",
    "name": "getMentorList",
    "group": "User",
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n[\n {\n   Mentor1's Info\n },\n {\n   Mentor2's Info\n },\n {\n   Mentor3's Info\n },....\n]",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "HTTP/1.1 401 Not Authenticated",
          "content": "HTTP/1.1 401 Not Authenticated\n{\n  \"err_point\": \"Authentication failed. Please sign in first.\"\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/users.route.js",
    "groupTitle": "User"
  },
  {
    "type": "get",
    "url": "/users/me",
    "title": "Request My info",
    "name": "getMyProfile",
    "group": "User",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "_id",
            "description": "<p>ObjectId of User.</p>"
          }
        ]
      }
    },
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n{\n  \"_id\": \"57d214b87bdc0820732da371\",\n  \"email\": \"lyw0149@naver.com\",\n  \"name\": \"Yangwoo Lee\",\n  \"platform_id\": \"10205720438113883\",\n  \"platform_type\": 1,\n  \"locale\": \"ko_KR\",\n  \"timezone\": 9,\n  \"profile_picture\": \"https://scontent.xx.fbcdn.net/v/t1.0-1/...\",\n  \"__v\": 0,\n  \"date\": \"2016-09-09T01:47:36.628Z\"\n}",
          "type": "json"
        }
      ]
    },
    "error": {
      "examples": [
        {
          "title": "HTTP/1.1 401 Not Authenticated",
          "content": "HTTP/1.1 401 Not Authenticated\n{\n  \"err_point\": \"Authentication failed. Please sign in first.\"\n}",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/users.route.js",
    "groupTitle": "User"
  },
  {
    "type": "get",
    "url": "/users/id/:id",
    "title": "Request User info",
    "name": "getProfileById",
    "group": "User",
    "success": {
      "examples": [
        {
          "title": "Success",
          "content": "HTTP/1.1 200 OK\n[\n {\n\n }\n]",
          "type": "json"
        }
      ]
    },
    "version": "0.0.0",
    "filename": "src/server/routes/users.route.js",
    "groupTitle": "User"
  },
  {
    "type": "post",
    "url": "/users/signin",
    "title": "Request Sign in",
    "name": "signin",
    "group": "User",
    "parameter": {
      "fields": {
        "Parameter": [
          {
            "group": "Parameter",
            "type": "String",
            "optional": false,
            "field": "access_token",
            "description": "<p>access_token gained from Platform API.</p>"
          },
          {
            "group": "Parameter",
            "type": "Number",
            "optional": false,
            "field": "platform_type",
            "description": "<p>Platform that user used when join { Facebook: 1,  LinkedIn: 2 }.</p>"
          }
        ]
      }
    },
    "version": "0.0.0",
    "filename": "src/server/routes/users.route.js",
    "groupTitle": "User"
  }
] });