BokaMera.API.Host

DeleteUser

The following routes are available for this service:
DELETE	/users	Deletes a user	Deletes the logged in user account.


export class UserProfileResponse
{
    public Id: string;
    public Firstname: string;
    public Lastname: string;
    public Phone: string;
    public Email: string;

    public constructor(init?: Partial<UserProfileResponse>) { (Object as any).assign(this, init); }
}

export class AdminProfile
{
    public CompanyId: string;
    public Id: string;
    public Firstname: string;
    public Lastname: string;
    public Email: string;
    public WorkerId: string;
    public Phone: string;

    public constructor(init?: Partial<AdminProfile>) { (Object as any).assign(this, init); }
}

export class DeleteUserResponse
{
    public ResponseStatus: Object;
    /** @description The user id for your profile. */
    // @ApiMember(Description="The user id for your profile.", IsRequired=true)
    public UserName: string;

    public UserProfile: UserProfileResponse;
    public AdminProfile: AdminProfile;

    public constructor(init?: Partial<DeleteUserResponse>) { (Object as any).assign(this, init); }
}

export enum KeyCloakRealm
{
    BookMore = 1,
    BookMoreAdmin = 2,
    SuperAdmin = 3,
}

// @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)
export class DeleteUser
{
    /** @description The user name of your profile. */
    // @ApiMember(Description="The user name of your profile.", IsRequired=true)
    public UserName: string;

    /** @description 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 Realm: KeyCloakRealm;

    /** @description 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 DeleteCustomerProfiles: boolean;

    /** @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. */
    // @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 ForceDelete: boolean;

    /** @description 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 Token: string;

    public constructor(init?: Partial<DeleteUser>) { (Object as any).assign(this, init); }
}

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