Skip to content
Jake Gordon edited this page Apr 3, 2015 · 13 revisions

POST /api/v1/Users

Description: Register a new User and Gaming Group at the same time. Will also create a single Player with the same name as the new User. A confirmation email will be sent to the email address of the new User.

Supported Versions: This service is consistent through all version of the API.

Request

Parameter Description
emailAddress Email address of the new User
userName Username of the new User
password Password of the new User

Example Request

{
  "emailAddress" : "example@email.com",
  "userName" : "myUsername",
  "password" : "l33tp@assword!"
}

Response

Parameter Description
userId Id of the newly created User
playerId Id of the newly created Player
playerName Name of the newly created player that was automatically added to the new gaming group. By default, the playerName will be {userName}.
gamingGroupId Id of the newly created Gaming Group
gamingGroupName Name of the newly created Gaming Group. Will be "{userName}'s Gaming Group" by default
authenticationToken A new authentication token that should be sent on subsequent requests that require authentication (as documented in the corresponding service)

Example Response

{
  "userId" : "15511",
  "playerId" : "53311",
  "playerName" : "myUsername",
  "gamingGroupId" : "9151,
  "gamingGroupName" : "myUsername's Gaming Group",
  "authenticationToken" : "ijd7ad89fdijfdfjoiad8f7d8fua98uduf9839ajdjf"
}

Possible Errors Returns an HTTP 400 status code with a descriptive message if the User could not be registered due to an invalid userName, email, or password.

Clone this wiki locally