Skip to content
This repository was archived by the owner on Jul 25, 2020. It is now read-only.
Mrcomputer1 edited this page Jun 10, 2016 · 2 revisions

Users

/users/:username

Example URL

/users/Mrcomputer1

Supported Methods

GET, POST

GET Variables

None

POST Variables

  • NOT NEEDED aboutme : The about me contents
  • NOT NEEDED whatimdoing : What I'm doing
  • NOT NEEDED username : Your username : No OAUTH support password required
  • NOT NEEDED, NEEDED IF username IS SET password : Your password - needed for name changes
  • NOT NEEDED, NEEDED IF aboutme or whatimdoing apikey : API Key

GET Output

{
    "id": 1,
    "username": "Mrcomputer1",
    "aboutme": "I am awesome person",
    "whatimdoing": "Being awesome",
    "group": {
        "title": "Sharp Team",
        "admin": true,
        "mod": true,
        "banned": false,
        "hidden": false
    }
}

POST Output (Success)

{"success": true}

POST Output (Failure)

{"success": false, "human": "(Human error message that can be displayed)", "exception": "(Exception)"}

Exceptions

CensoredValue: The value entered was censored : 400

TooLongValue: The value you entered was too long : 400

InvalidValue: The value given was invalid : 400

BadPasswordOrAPIKey: The password or API Key was not valid : 401

403: Permission was denied : 403

Clone this wiki locally