trabajo-afectivo/app/controllers/groups_controller.rb

155 lines
2.2 KiB
Ruby
Raw Normal View History

2016-10-19 03:11:36 +00:00
# Copyright (C) 2012-2016 Zammad Foundation, http://zammad-foundation.org/
2012-04-10 14:06:46 +00:00
class GroupsController < ApplicationController
before_action { authentication_check(permission: 'admin.group') }
2012-04-10 14:06:46 +00:00
=begin
Format:
JSON
Example:
{
"id":1,
"name":"some group",
"assignment_timeout": null,
"follow_up_assignment": true,
"follow_up_possible": "yes",
"note":"",
"active":true,
"updated_at":"2012-09-14T17:51:53Z",
"created_at":"2012-09-14T17:51:53Z",
"created_by_id":2,
}
=end
=begin
Resource:
GET /api/v1/groups
Response:
[
{
"id": 1,
"name": "some_name1",
...
},
{
"id": 2,
"name": "some_name2",
...
}
]
Test:
curl http://localhost/api/v1/groups -v -u #{login}:#{password}
=end
2012-04-10 14:06:46 +00:00
def index
model_index_render(Group, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
GET /api/v1/groups/#{id}
Response:
{
"id": 1,
"name": "name_1",
...
}
2012-04-10 14:06:46 +00:00
Test:
curl http://localhost/api/v1/groups/#{id} -v -u #{login}:#{password}
=end
def show
model_show_render(Group, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
POST /api/v1/groups
Payload:
{
"name": "some name",
"assignment_timeout": null,
"follow_up_assignment": true,
"follow_up_possible": "yes",
"note":"",
"active":true,
}
Response:
{
"id": 1,
"name": "some_name",
...
}
Test:
curl http://localhost/api/v1/groups -v -u #{login}:#{password} -H "Content-Type: application/json" -X POST -d '{"name": "some_name","active": true, "note": "some note"}'
=end
2012-04-10 14:06:46 +00:00
def create
model_create_render(Group, params)
2012-04-10 14:06:46 +00:00
end
=begin
Resource:
PUT /api/v1/groups/{id}
Payload:
{
"name": "some name",
"assignment_timeout": null,
"follow_up_assignment": true,
"follow_up_possible": "yes",
"note":"",
"active":true,
}
Response:
{
"id": 1,
"name": "some_name",
...
}
2012-04-10 14:06:46 +00:00
Test:
curl http://localhost/api/v1/groups -v -u #{login}:#{password} -H "Content-Type: application/json" -X PUT -d '{"name": "some_name","active": true, "note": "some note"}'
=end
def update
model_update_render(Group, params)
2012-04-10 14:06:46 +00:00
end
=begin
2012-04-10 14:06:46 +00:00
Resource:
DELETE /api/v1/groups/{id}
Response:
{}
Test:
curl http://localhost/api/v1/groups/{id} -v -u #{login}:#{password} -H "Content-Type: application/json" -X DELETE -d '{}'
=end
def destroy
model_destroy_render(Group, params)
2012-04-10 14:06:46 +00:00
end
end