BokaMera.API.Host

BumpWidgetConfigurationVersion

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

The following routes are available for this service:
PUT	/widget/configuration/{Id}/bumpversion	Bump the homepage default widget configuration to the next schema version	Moves the homepage default configuration's SchemaVersion to SchemaVersion + 1. Returns 400 if the next version's schema does not exist yet, if UseFactoryDefaults is true and the next version has no DefaultConfiguration authored, or if the target configuration is not the homepage default.

namespace BokaMera.API.ServiceModel.Dtos

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type WidgetConfigurationResponse() = 
        member val Id:String = null with get,set
        member val CompanyId:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val Slug:String = null with get,set
        member val Description:String = null with get,set
        member val Configuration:String = null with get,set
        member val SchemaVersion:Int32 = new Int32() with get,set
        member val IsHomepageDefault:Boolean = new Boolean() with get,set
        member val CreatedDate:DateTime = new DateTime() with get,set
        member val UpdatedDate:Nullable<DateTimeOffset> = new Nullable<DateTimeOffset>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<ApiResponse(Description="Not the homepage default, next schema version doesn't exist, or (when UseFactoryDefaults) the next version has no factory default authored yet", StatusCode=400)>]
    [<ApiResponse(Description="Returned if the configuration was not found", StatusCode=404)>]
    [<ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)>]
    [<ValidateRequest(Validator="IsAuthenticated")>]
    [<AllowNullLiteral>]
    type BumpWidgetConfigurationVersion() = 
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [<ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")>]
        member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set

        ///<summary>
        ///The widget configuration id (6-character NanoID).
        ///</summary>
        [<ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")>]
        member val Id:String = null with get,set

        ///<summary>
        ///When true, overwrites Configuration with the next schema version's factory-default JSON. When false, only SchemaVersion is moved and the existing Configuration is preserved unvalidated against the new schema.
        ///</summary>
        [<ApiMember(Description="When true, overwrites Configuration with the next schema version's factory-default JSON. When false, only SchemaVersion is moved and the existing Configuration is preserved unvalidated against the new schema.", IsRequired=true)>]
        member val UseFactoryDefaults:Boolean = new Boolean() with get,set

F# BumpWidgetConfigurationVersion 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}/bumpversion HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<BumpWidgetConfigurationVersion 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>
  <UseFactoryDefaults>false</UseFactoryDefaults>
</BumpWidgetConfigurationVersion>

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>