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.*;

public class dtos
{

    @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)
    public static class DeleteUser
    {
        /**
        * The user name of your profile.
        */
        @ApiMember(Description="The user name of your profile.", IsRequired=true)
        public String UserName = 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)
        public KeyCloakRealm Realm = 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.")
        public Boolean DeleteCustomerProfiles = 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.")
        public Boolean ForceDelete = 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.")
        public String Token = null;
        
        public String getUserName() { return UserName; }
        public DeleteUser setUserName(String value) { this.UserName = value; return this; }
        public KeyCloakRealm getRealm() { return Realm; }
        public DeleteUser setRealm(KeyCloakRealm value) { this.Realm = value; return this; }
        public Boolean isDeleteCustomerProfiles() { return DeleteCustomerProfiles; }
        public DeleteUser setDeleteCustomerProfiles(Boolean value) { this.DeleteCustomerProfiles = value; return this; }
        public Boolean isForceDelete() { return ForceDelete; }
        public DeleteUser setForceDelete(Boolean value) { this.ForceDelete = value; return this; }
        public String getToken() { return Token; }
        public DeleteUser setToken(String value) { this.Token = value; return this; }
    }

    public static enum KeyCloakRealm
    {
        BookMore(1),
        BookMoreAdmin(2),
        SuperAdmin(3);

        private final int value;
        KeyCloakRealm(final int intValue) { value = intValue; }
        public int getValue() { return value; }
    }

    public static class DeleteUserResponse
    {
        public Object ResponseStatus = null;
        /**
        * The user id for your profile.
        */
        @ApiMember(Description="The user id for your profile.", IsRequired=true)
        public String UserName = null;

        public UserProfileResponse UserProfile = null;
        public AdminProfile AdminProfile = null;
        
        public Object getResponseStatus() { return ResponseStatus; }
        public DeleteUserResponse setResponseStatus(Object value) { this.ResponseStatus = value; return this; }
        public String getUserName() { return UserName; }
        public DeleteUserResponse setUserName(String value) { this.UserName = value; return this; }
        public UserProfileResponse getUserProfile() { return UserProfile; }
        public DeleteUserResponse setUserProfile(UserProfileResponse value) { this.UserProfile = value; return this; }
        public AdminProfile getAdminProfile() { return AdminProfile; }
        public DeleteUserResponse setAdminProfile(AdminProfile value) { this.AdminProfile = value; return this; }
    }

    public static class UserProfileResponse
    {
        public UUID Id = null;
        public String Firstname = null;
        public String Lastname = null;
        public String Phone = null;
        public String Email = null;
        
        public UUID getId() { return Id; }
        public UserProfileResponse setId(UUID value) { this.Id = value; return this; }
        public String getFirstname() { return Firstname; }
        public UserProfileResponse setFirstname(String value) { this.Firstname = value; return this; }
        public String getLastname() { return Lastname; }
        public UserProfileResponse setLastname(String value) { this.Lastname = value; return this; }
        public String getPhone() { return Phone; }
        public UserProfileResponse setPhone(String value) { this.Phone = value; return this; }
        public String getEmail() { return Email; }
        public UserProfileResponse setEmail(String value) { this.Email = value; return this; }
    }

    public static class AdminProfile
    {
        public UUID CompanyId = null;
        public UUID Id = null;
        public String Firstname = null;
        public String Lastname = null;
        public String Email = null;
        public String WorkerId = null;
        public String Phone = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public AdminProfile setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public UUID getId() { return Id; }
        public AdminProfile setId(UUID value) { this.Id = value; return this; }
        public String getFirstname() { return Firstname; }
        public AdminProfile setFirstname(String value) { this.Firstname = value; return this; }
        public String getLastname() { return Lastname; }
        public AdminProfile setLastname(String value) { this.Lastname = value; return this; }
        public String getEmail() { return Email; }
        public AdminProfile setEmail(String value) { this.Email = value; return this; }
        public String getWorkerId() { return WorkerId; }
        public AdminProfile setWorkerId(String value) { this.WorkerId = value; return this; }
        public String getPhone() { return Phone; }
        public AdminProfile setPhone(String value) { this.Phone = value; return this; }
    }

}

Java 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"}}