Users API

ユーザ登録

ユーザを新規登録することが出来ます。

URL

POST /api/users/regist

パラメータJSON

以下のパラメータを含んだJSONをbodyに入れて送信して下さい。

Name	Type	Discription
screenName 必須	string	表示名 ※他のユーザと表示名が被っても構いません。
name 必須	string	名前 ※既に同じ名前を持つユーザが登録されている場合にはエラーレスポンスが返されます。
password 必須	string	パスワード

パラメータJSONの例

{
  "screenName":"A-1",
  "name":"a1",
  "password":"a1_pw",
}

レスポンス

レスポンスのBodyにUserオブジェクトが返ってきます。

エラーレスポンス

以下のエラーレスポンスが返ってるくる可能性があります。エラーレスポンスについてはError Responseを見てください。

200 201 202 203

---

ユーザ情報取得

ユーザの情報を取得することができます。

URL

GET /api/users/show/(ユーザのname又はID)

レスポンス

レスポンスのBodyにUserオブジェクトが返ってきます。

エラーレスポンス

以下のエラーレスポンスが返ってるくる可能性があります。エラーレスポンスについてはError Responseを見てください。

204

---

ユーザ削除

ユーザを削除することができます。

URL

POST /api/users/delete

パラメータJSON

以下のパラメータを含んだJSONをbodyに入れて送信して下さい。

Name	Type	Discription
name (name又はidのいずれか必須)	string	名前
id (name又はidのいずれか必須)	string	ID
password 必須	string	パスワード

パラメータJSONの例

{
  "name":"a1",
  "password":"a1_pw",
}

レスポンス

削除が成功した場合、ステータス200のレスポンスが返されます。

エラーレスポンス

以下のエラーレスポンスが返ってるくる可能性があります。エラーレスポンスについてはError Responseを見てください。

200 204

---

ユーザ検索

検索文字列に前方一致したユーザを取得することができます。検索対象はnameとidになります。

URL

GET /api/users/search

クエリパラメータ

Name	Type	Discription
q 必須	string	検索文字列

URLの例

/api/users/search?q=a1

レスポンス

レスポンスのBodyにUserオブジェクトの配列が返ってきます。

エラーレスポンス

以下のエラーレスポンスが返ってるくる可能性があります。エラーレスポンスについてはError Responseを見てください。

1