email_addresses_controller.rb 2.3 KB

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