Response Format

[ryanking13]

Response Format

{
  "resultcode": 200 ( for successful requests ) / 4xx or 5xx ( for failed requests)
  "success" : true / false,
  "message" : "Response message",
  "data" : response data ( if none - [])
}

# use send_response() function for sending response

var send_response = require("../general/response_manager.js").send_response

return send_response(res, 400, "Message")

    {
      "resultcode": 400,
      "success": false,
      "message": "Message",
      "data": [],
    }

return send_response(res, 200, "Message", data)

    {
      "resultcode": 200,
      "success": true,
      "message": "Message",
      "data": data,
    }

---

Common Responses

Success

• Returning Data

{
  "resultcode" : 200,
  "success" : true,
  "message" : "",
  "data": [{"some": "data"}],
}

• Not returning Data

{
  "resultcode" : 200,
  "success" : true,
  "message" : "",
  "data": [],
}

Fail

• Lacking parameters

{
  "resultcode" : 400,
  "success" : false,
  "message" : "Parameters not given",
  "data": [],
}

• User authentication fail

{
  "resultcode" : 401,
  "success" : false,
  "message" : "User auth fail",
  "data": [],
}

• Internal server error

{
  "resultcode" : 500,
  "success" : false,
  "message" : "Internal server error",
  "data": [],
}