BokaMera.API.Host

SetHomepageWidgetConfiguration

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
PUT	/widget/configuration/{Id}/sethomepage	Set a widget configuration as the homepage default	Makes the supplied configuration the company's homepage default and removes the flag from the previous one. Slugs are left unchanged. Calling it on the current homepage default is a no-op success.

"use strict";
export class WidgetConfigurationResponse {
    /** @param {{Id?:string,CompanyId?:string,Name?:string,Slug?:string,Description?:string,Configuration?:string,SchemaVersion?:number,IsHomepageDefault?:boolean,CreatedDate?:string,UpdatedDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Name;
    /** @type {?string} */
    Slug;
    /** @type {?string} */
    Description;
    /** @type {string} */
    Configuration;
    /** @type {number} */
    SchemaVersion;
    /** @type {boolean} */
    IsHomepageDefault;
    /** @type {string} */
    CreatedDate;
    /** @type {?string} */
    UpdatedDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class SetHomepageWidgetConfiguration {
    /** @param {{CompanyId?:string,Id?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The widget configuration id (6-character NanoID). */
    Id;
}

JavaScript SetHomepageWidgetConfiguration 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 /widget/configuration/{Id}/sethomepage HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<SetHomepageWidgetConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Id>String</Id>
</SetHomepageWidgetConfiguration>

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

<WidgetConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Configuration>String</Configuration>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Description>String</Description>
  <Id>String</Id>
  <IsHomepageDefault>false</IsHomepageDefault>
  <Name>String</Name>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SchemaVersion>0</SchemaVersion>
  <Slug>String</Slug>
  <UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
    <d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
    <d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
  </UpdatedDate>
</WidgetConfigurationResponse>