BokaMera.API.Host

<back to all web services

DeleteUser

The following routes are available for this service:
DELETE/usersDeletes a userDeletes the logged in user account.
import java.math.*
import java.util.*
import net.servicestack.client.*


@ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
open class DeleteUser
{
    /**
    * The user name of your profile.
    */
    @ApiMember(Description="The user name of your profile.", IsRequired=true)
    var UserName:String? = null

    /**
    * The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 
    */
    @ApiMember(Description="The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2 ", IsRequired=true)
    var Realm:KeyCloakRealm? = null

    /**
    * If this equals true it will force delete all customer profiles on all company on there you have booked a time.
    */
    @ApiMember(Description="If this equals true it will force delete all customer profiles on all company on there you have booked a time.")
    var DeleteCustomerProfiles:Boolean? = null

    /**
    * If this equals true it will check the request token value and try to delete user, if it is false it will send a delete confirmation email.
    */
    @ApiMember(Description="If this equals true it will check the request token value and try to delete user, if it is false it will send a delete confirmation email.")
    var ForceDelete:Boolean? = null

    /**
    * The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.
    */
    @ApiMember(Description="The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email.")
    var Token:String? = null
}

enum class KeyCloakRealm(val value:Int)
{
    BookMore(1),
    BookMoreAdmin(2),
    SuperAdmin(3),
}

open class DeleteUserResponse
{
    var ResponseStatus:Object? = null
    /**
    * The user id for your profile.
    */
    @ApiMember(Description="The user id for your profile.", IsRequired=true)
    var UserName:String? = null

    var UserProfile:UserProfileResponse? = null
    var AdminProfile:AdminProfile? = null
}

open class UserProfileResponse
{
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Phone:String? = null
    var Email:String? = null
}

open class AdminProfile
{
    var CompanyId:UUID? = null
    var Id:UUID? = null
    var Firstname:String? = null
    var Lastname:String? = null
    var Email:String? = null
    var WorkerId:String? = null
    var Phone:String? = null
}

Kotlin DeleteUser DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

DELETE /users HTTP/1.1 
Host: api.bokamera.se 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ResponseStatus":{},"UserName":"String","UserProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"AdminProfile":{"Firstname":"String","Lastname":"String","Email":"String","WorkerId":"String","Phone":"String"}}