Backend API specification : Admin Page

[ryanking13]

Request List

• Get User List
• Edit User Type
• Delete User

Get User List

Request

GET /admin/get_user_list

parameter:

Parameter	Description	Example
type	User type to get	all

• type
  • all (or NOT GIVEN)
  • member
  • regular
  • ob

Response

On success:

{
  "resultcode": 200,
  "success": true,
  "message": "",
  "data": [
    {
        "user_id": 1,
        "username": "admin",
        "nickname": "admin",
        "register_time": 150000000,
        "email": "admin@admin.com",
        "phone": "01234567890",
        "is_club_member": 1,
        "is_admin": 1,
    },
    {
      ...
    }
  ]
}

On fail:

# when type is invalid
{
  "resultcode": 400,
  "success": false,
  "message": "Invalid type",
  "data": []
}

# when user is not admin
{
  "resultcode": 401,
  "success": false,
  "message": "Not admin",
  "data": []
}

# on DB error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}

Edit User Type

Request

POST /admin/edit_user_type

parameter:

Parameter	Description	Example
username	User to be changed	guest
type	member type that user will become	ob

• type
  • basic
  • regular
  • ob

Response

On success:

{
  "resultcode": 200,
  "success": true,
  "message": "Successfully updated",
  "data": []
}

On fail:

# when type is invalid
{
  "resultcode": 400,
  "success": false,
  "message": "Invalid type",
  "data": []
}

# when user is not admin
{
  "resultcode": 401,
  "success": false,
  "message": "Not admin",
  "data": []
}

# when parameters are not fully given
{
  "resultcode": 400,
  "success": false,
  "message": "Parameters not given",
  "data": []
}

# on DB error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}

Delete User

Request

POST /admin/delete_user

parameter:

Parameter	Description	Example
username	User to be deleted	guest

Response

On success:

{
  "resultcode": 200,
  "success": true,
  "message": "Successfully deleted",
  "data": []
}

On fail:

# when user is not admin
{
  "resultcode": 401,
  "success": false,
  "message": "Not admin",
  "data": []
}

# when parameters are not fully given
{
  "resultcode": 400,
  "success": false,
  "message": "Parameters not given",
  "data": []
}

# on DB error
{
  "resultcode": 500,
  "success": false,
  "message": "Internal server error",
  "data": []
}