email_addresses_controller.rb 2.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. class EmailAddressesController < ApplicationController
  2. before_filter :authentication_check
  3. =begin
  4. Format:
  5. JSON
  6. Example:
  7. {
  8. "id":1,
  9. "realname":"some realname",
  10. "email":"system@example.com",
  11. "updated_at":"2012-09-14T17:51:53Z",
  12. "created_at":"2012-09-14T17:51:53Z",
  13. "updated_by_id":2,
  14. "created_by_id":2,
  15. }
  16. =end
  17. =begin
  18. Resource:
  19. GET /api/email_address.json
  20. Response:
  21. [
  22. {
  23. "id": 1,
  24. "realname":"some realname1",
  25. ...
  26. },
  27. {
  28. "id": 2,
  29. "realname":"some realname2",
  30. ...
  31. }
  32. ]
  33. Test:
  34. curl http://localhost/api/email_address.json -v -u #{login}:#{password}
  35. =end
  36. def index
  37. model_index_render(EmailAddress, params)
  38. end
  39. =begin
  40. Resource:
  41. GET /api/email_address/#{id}.json
  42. Response:
  43. {
  44. "id": 1,
  45. "name": "name_1",
  46. ...
  47. }
  48. Test:
  49. curl http://localhost/api/email_address/#{id}.json -v -u #{login}:#{password}
  50. =end
  51. def show
  52. model_show_render(EmailAddress, params)
  53. end
  54. =begin
  55. Resource:
  56. POST /api/email_address.json
  57. Payload:
  58. {
  59. "realname":"some realname",
  60. "email":"system@example.com",
  61. "note": "",
  62. "active":true,
  63. }
  64. Response:
  65. {
  66. "id": 1,
  67. "realname":"some realname",
  68. "email":"system@example.com",
  69. ...
  70. }
  71. Test:
  72. curl http://localhost/api/email_address.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"name": "some_name","active": true, "note": "some note"}'
  73. =end
  74. def create
  75. model_create_render(EmailAddress, params)
  76. end
  77. =begin
  78. Resource:
  79. PUT /api/email_address/{id}.json
  80. Payload:
  81. {
  82. "realname":"some realname",
  83. "email":"system@example.com",
  84. "note": "",
  85. "active":true,
  86. }
  87. Response:
  88. {
  89. "id": 1,
  90. "realname":"some realname",
  91. "email":"system@example.com",
  92. ...
  93. }
  94. Test:
  95. curl http://localhost/api/email_address.json -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"name": "some_name","active": true, "note": "some note"}'
  96. =end
  97. def update
  98. model_update_render(EmailAddress, params)
  99. end
  100. =begin
  101. Resource:
  102. Response:
  103. Test:
  104. =end
  105. def destroy
  106. model_destory_render(EmailAddress, params)
  107. end
  108. end