BokaMera.API.Host

UpdateUser

The following routes are available for this service:
PUT	/users	Update my information	Updates 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 InvoiceAddress {
    /** @param {{CorporateIdentityNumber?:string,InvoiceAddress1?:string,InvoiceAddress2?:string,InvoiceCity?:string,InvoicePostalCode?:string,InvoiceCountryCode?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    CorporateIdentityNumber;
    /** @type {string} */
    InvoiceAddress1;
    /** @type {string} */
    InvoiceAddress2;
    /** @type {string} */
    InvoiceCity;
    /** @type {string} */
    InvoicePostalCode;
    /** @type {string} */
    InvoiceCountryCode;
}
export class UserProfileResponse {
    /** @param {{Id?:string,Firstname?:string,Lastname?:string,Phone?:string,Email?:string,InvoiceAddress?:InvoiceAddress}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
    /** @type {InvoiceAddress} */
    InvoiceAddress;
}
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,InvoiceAddress?:InvoiceAddress}} [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;
    /** @type {InvoiceAddress} */
    InvoiceAddress;
}
export class UpdateCustomerProfile {
    /** @param {{Firstname?:string,Lastname?:string,Phone?:string,Email?:string,InvoiceAddress?:InvoiceAddress}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Firstname;
    /** @type {string} */
    Lastname;
    /** @type {string} */
    Phone;
    /** @type {string} */
    Email;
    /** @type {InvoiceAddress} */
    InvoiceAddress;
}
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,InvoiceAddress?:InvoiceAddress}} [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;
    /** @type {InvoiceAddress} */
    InvoiceAddress;
}

JavaScript UpdateUser DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<UpdateUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AdminProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </AdminProfile>
  <InvoiceAddress>
    <CorporateIdentityNumber>String</CorporateIdentityNumber>
    <InvoiceAddress1>String</InvoiceAddress1>
    <InvoiceAddress2>String</InvoiceAddress2>
    <InvoiceCity>String</InvoiceCity>
    <InvoiceCountryCode>String</InvoiceCountryCode>
    <InvoicePostalCode>String</InvoicePostalCode>
  </InvoiceAddress>
  <NewEmail>String</NewEmail>
  <Realm>BookMore</Realm>
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
  <UserProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <InvoiceAddress>
      <CorporateIdentityNumber>String</CorporateIdentityNumber>
      <InvoiceAddress1>String</InvoiceAddress1>
      <InvoiceAddress2>String</InvoiceAddress2>
      <InvoiceCity>String</InvoiceCity>
      <InvoiceCountryCode>String</InvoiceCountryCode>
      <InvoicePostalCode>String</InvoicePostalCode>
    </InvoiceAddress>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</UpdateUser>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<UpdateUserResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <AdminProfile>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
    <WorkerId>String</WorkerId>
  </AdminProfile>
  <InvoiceAddress>
    <CorporateIdentityNumber>String</CorporateIdentityNumber>
    <InvoiceAddress1>String</InvoiceAddress1>
    <InvoiceAddress2>String</InvoiceAddress2>
    <InvoiceCity>String</InvoiceCity>
    <InvoiceCountryCode>String</InvoiceCountryCode>
    <InvoicePostalCode>String</InvoicePostalCode>
  </InvoiceAddress>
  <IsSentConfirmationUpdateEmail>false</IsSentConfirmationUpdateEmail>
  <ResponseStatus />
  <UserId>00000000-0000-0000-0000-000000000000</UserId>
  <UserProfile>
    <Email>String</Email>
    <Firstname>String</Firstname>
    <Id>00000000-0000-0000-0000-000000000000</Id>
    <InvoiceAddress>
      <CorporateIdentityNumber>String</CorporateIdentityNumber>
      <InvoiceAddress1>String</InvoiceAddress1>
      <InvoiceAddress2>String</InvoiceAddress2>
      <InvoiceCity>String</InvoiceCity>
      <InvoiceCountryCode>String</InvoiceCountryCode>
      <InvoicePostalCode>String</InvoicePostalCode>
    </InvoiceAddress>
    <Lastname>String</Lastname>
    <Phone>String</Phone>
  </UserProfile>
</UpdateUserResponse>