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.
"use strict";
export class UserProfileResponse {
    /** @param {{Id?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
}
export class AdminProfile {
    /** @param {{CompanyId?:string,Id?:string,Firstname?:string,Lastname?:string,Email?:string,WorkerId?:string,Phone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Id;
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Email;
    /** @type {string} */
    WorkerId;
    /** @type {string} */
    Phone;
}
export class DeleteUserResponse {
    /** @param {{ResponseStatus?:Object,UserName?:string,UserProfile?:UserProfileResponse,AdminProfile?:AdminProfile}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Object} */
    ResponseStatus;
    /**
     * @type {string}
     * @description The user id for your profile. */
    UserName;
    /** @type {UserProfileResponse} */
    UserProfile;
    /** @type {AdminProfile} */
    AdminProfile;
}
/** @typedef {number} */
export var KeyCloakRealm;
(function (KeyCloakRealm) {
    KeyCloakRealm[KeyCloakRealm["BookMore"] = 1] = "BookMore"
    KeyCloakRealm[KeyCloakRealm["BookMoreAdmin"] = 2] = "BookMoreAdmin"
    KeyCloakRealm[KeyCloakRealm["SuperAdmin"] = 3] = "SuperAdmin"
})(KeyCloakRealm || (KeyCloakRealm = {}));
export class DeleteUser {
    /** @param {{UserName?:string,Realm?:KeyCloakRealm,DeleteCustomerProfiles?:boolean,ForceDelete?:boolean,Token?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {string}
     * @description The user name of your profile. */
    UserName;
    /**
     * @type {KeyCloakRealm}
     * @description The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2  */
    Realm;
    /**
     * @type {boolean}
     * @description If this equals true it will force delete all customer profiles on all company on there you have booked a time. */
    DeleteCustomerProfiles;
    /**
     * @type {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. */
    ForceDelete;
    /**
     * @type {string}
     * @description The value is only checked when ForceDelete is set to true. Contains the token value what was sent to email. */
    Token;
}

JavaScript DeleteUser DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

DELETE /users HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}