ViRe User Service

The API for the User Service from ViRe WaDe Project
More information: https://helloreverb.com
Contact Info: hello@helloreverb.com
Version: 1.0.0
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html

Access

Methods

[ Jump to Models ]

Table of Contents

Auth

User

Auth

Up 
post /login
(loginUser)
login user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body UserLogin (optional)
Body Parameter —

Return type

ApiResponse

Example data

Content-Type: application/json
{
  "code" : 0,
  "message" : "everything is ok"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfull logged in ApiResponse
Up 
post /logout
(logoutUser)
logout user

Return type

ApiResponse

Example data

Content-Type: application/json
{
  "code" : 0,
  "message" : "everything is ok"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfull logged out ApiResponse
Up 
post /register
(registerUser)
register user

Consumes

This API call consumes the following media types via the Content-Type request header:

Request body

body User (optional)
Body Parameter —

Return type

User

Example data

Content-Type: application/json
{
  "password" : "password",
  "firstname" : "John",
  "email" : "mail@mail.com",
  "username" : "user0123",
  "lastname" : "Doe"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successfull register user User

User

Up 
put /user/{userId}
(editUserDetails)
edit user details

Path parameters

userId (required)
Path Parameter —

Return type

User

Example data

Content-Type: application/json
{
  "password" : "password",
  "firstname" : "John",
  "email" : "mail@mail.com",
  "username" : "user0123",
  "lastname" : "Doe"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful update user details User
Up 
get /user/{userId}
(getUserDetails)
get user details

Path parameters

userId (required)
Path Parameter —

Return type

User

Example data

Content-Type: application/json
{
  "password" : "password",
  "firstname" : "John",
  "email" : "mail@mail.com",
  "username" : "user0123",
  "lastname" : "Doe"
}

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful get user details User
Up 
get /user/{userId}/playlists
(getUserPlaylists)
get user playlists

Path parameters

userId (required)
Path Parameter —

Return type

array[String]

Example data

Content-Type: application/json
[ "", "" ]

Produces

This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.

Responses

200

Successful update user details

Models

[ Jump to Methods ]

Table of Contents

  1. AnyValue
  2. ApiResponse
  3. User
  4. UserLogin

AnyValue Up

ApiResponse Up

code (optional)
Integer format: int32
message (optional)
String
example: everything is ok

User Up

username (optional)
String
example: user0123
password (optional)
String
example: password
email (optional)
String
example: mail@mail.com
firstname (optional)
String
example: John
lastname (optional)
String
example: Doe

UserLogin Up

username (optional)
String
example: user0123
password (optional)
String
example: password