GET /api/v1/groups HTTP/1.1
| パラメータ | 内容 | 必須 | デフォルト値 | 最大値 |
|---|
| name | 検索するグループ名を設定 | | | 20文字 |
| user_code | 検索するユーザーコードを設定 | | | |
| page | ページ | | 1 | |
| per_page | ページ毎の取得数 | | 20 | 100 |
{
"name": "グループ",
"user_code": "0000000001",
"page": 1,
"per_page": 50
}
HTTP/1.1 200 OK
{
groups: [ /*nameの昇順*/
{
"name": "グループA"
},
{
"name": "グループB"
}
],
meta: {
"previous_page": null,
"next_page": "https://projectmode.notepm.jp/api/v1/groups?page=2&per_page=50",
"page": 1,
"per_page": 50,
"total": 500
}
}
POST /api/v1/groups HTTP/1.1
| パラメータ | 内容 | 必須 | デフォルト値 | 最大値 |
|---|
| name | グループ名を設定 | ○ | | |
HTTP/1.1 201 Created
{
"group": {
"name": "グループA",
"users": [
{
"user_code": "0000000001",
"name": "Aさん",
"is_admin": true
}
]
},
"meta": {
}
}
GET /api/v1/groups/:group_name HTTP/1.1
HTTP/1.1 200 OK
{
"group": {
"name": "グループA",
"users": [
{
"user_code": "0000000001",
"name": "Aさん",
"is_admin": true
},
{
"user_code": "0000000002",
"name": "Bさん",
"is_admin": false
}
]
},
"meta": {
}
}
DELETE /api/v1/groups/:group_name HTTP/1.1
POST /api/v1/groups/:group_name/users HTTP/1.1
| パラメータ | 内容 | 必須 | デフォルト値 | 最大値 |
|---|
| users | 追加するユーザーを配列で設定する | | | |
{
"users": [
"0000000002",
"0000000003"
]
}
DELETE /api/v1/groups/:group_name/users HTTP/1.1
| パラメータ | 内容 | 必須 | デフォルト値 | 最大値 |
|---|
| users | 削除するユーザーを配列で設定する | | | |
{
"users": [
"0000000002",
"0000000003"
]
}
