Difference between revisions of "API:POST /user"

From SoFurry
Jump to: navigation, search
(Created page with "= Resource URL = This method will register new users. If a user is successfully registered, an activation email will be sent containing the activation code. https://api.sof...")
 
(Request)
 
Line 9: Line 9:
 
  POST /user
 
  POST /user
 
  {
 
  {
   "name": "bob", # Required, Unique, Alphanumeric Only
+
   "username": "bob", # Required, Unique, Alphanumeric Only
 +
  "birthdate": "1994-01-01", # Required, Date
 
   "email": "bob@example.org", # Required, Valid Email, Unique
 
   "email": "bob@example.org", # Required, Valid Email, Unique
 
   "password": "hunter2" # Required, Min 6 characters
 
   "password": "hunter2" # Required, Min 6 characters

Latest revision as of 14:25, 15 May 2016

Resource URL

This method will register new users. If a user is successfully registered, an activation email will be sent containing the activation code.

https://api.sofurrybeta.com/user

Request

POST /user
{
  "username": "bob", # Required, Unique, Alphanumeric Only
  "birthdate": "1994-01-01", # Required, Date
  "email": "bob@example.org", # Required, Valid Email, Unique
  "password": "hunter2" # Required, Min 6 characters
}

Response: Success

HTTP 200
{
  "result": true,
  "token": "Registration complete! Please check your inbox for your activation link"
}

If the result is TRUE, then the activation was a success. The corresponding user will now be able to log in with their username and password.