BokaMera.API.Host

<back to all web services

UpdateUser

Requires Authentication
The following routes are available for this service:
PUT/usersUpdate my informationUpdates the logged in users info both in customer profile and application admin profile if any exists. Users are only allowed to update their own info.
"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 UpdateUserResponse {
    /** @param {{ResponseStatus?:Object,UserId?:string,UserProfile?:UserProfileResponse,AdminProfile?:AdminProfile,IsSentConfirmationUpdateEmail?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {Object} */
    ResponseStatus;
    /**
     * @type {string}
     * @description The user id for your profile. */
    UserId;
    /** @type {UserProfileResponse} */
    UserProfile;
    /** @type {AdminProfile} */
    AdminProfile;
    /** @type {?boolean} */
    IsSentConfirmationUpdateEmail;
}
export class UpdateCustomerProfile {
    /** @param {{Firstname?:string,Lastname?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
}
export class UpdateAdminProfile {
    /** @param {{Firstname?:string,Lastname?:string,Phone?:string,Email?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
}
/** @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 UpdateUser {
    /** @param {{UserId?:string,NewEmail?:string,UserProfile?:UpdateCustomerProfile,AdminProfile?:UpdateAdminProfile,Realm?:KeyCloakRealm}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The user id for your profile. */
    UserId;
    /** @type {string} */
    NewEmail;
    /** @type {UpdateCustomerProfile} */
    UserProfile;
    /** @type {UpdateAdminProfile} */
    AdminProfile;
    /**
     * @type {KeyCloakRealm}
     * @description The user realm for identity server.  BookMore = 1, BookMoreAdmin = 2  */
    Realm;
}

JavaScript UpdateUser DTOs

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

HTTP + OTHER

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

PUT /users HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"UserId":"00000000-0000-0000-0000-000000000000","NewEmail":"String","UserProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"AdminProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"Realm":"BookMore"}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"ResponseStatus":{},"UserId":"00000000-0000-0000-0000-000000000000","UserProfile":{"Firstname":"String","Lastname":"String","Phone":"String","Email":"String"},"AdminProfile":{"Firstname":"String","Lastname":"String","Email":"String","WorkerId":"String","Phone":"String"},"IsSentConfirmationUpdateEmail":false}