Data Models User Management - AmayaHena/AreaDocumentation GitHub Wiki

Data Models User Management

Data models is a page to explain the format of data received on/by the server.

On this page you can find data models of the following models:

Login Response

Description: Information about a successful login.

Format:

{
  "login": "$RVlogin",
  "username": "$RVusername",
  "token": "$RVtoken",
  "Area": "$RVarea"
}

Description of right values:

RVlogin:
Definition: tells if the login is successful
Value: true OR false

RVusername:
Definition: username of the user tried to login
Value: string

RVtoken:
Definition: Given value by the server used to identify the account on requests
Value: JWT

RVarea:
Definition: Data Model wich contains all the information about the user
Value: UserInfo Data Model

Definition of UserInfo

Register Response

Description: Information about successful registration.

Format:

{
  "created": "$RVcreated",
  "username": "$RVusername",
  "token": "$RVtoken",
  "Area": "$RVarea"
}

Description of right values:

RVcreated:
Definition: tells if the user as been created in the database
Value: true OR false

RVusername:
Definition: username of the user tried to login
Value: string

RVtoken:
Definition: Given value by the server used to identify the account on requests
Value: JWT

RVarea:
Definition: Data Model wich contains all the information about the user
Value: UserInfo Data Model

Definition of UserInfo