BokaMera.API.Host

<back to all web services

DeleteWidgetConfigurationSchemaMigration

Requires Authentication
Requires the role:superadmin
The following routes are available for this service:
DELETE/widget/configurationschema/{Version}/migrationClear the migration patch for a schema versionSets MigrationFromPreviousVersion back to NULL for the given Version. SuperAdmin only. Idempotent — deleting an already-cleared value is a no-op success.
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;

namespace BokaMera.API.ServiceModel.Dtos
{
    [ApiResponse(Description="Returned if Version doesn't exist", StatusCode=404)]
    [ApiResponse(Description="Returned if the current user is not a SuperAdmin", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class DeleteWidgetConfigurationSchemaMigration
    {
        ///<summary>
        ///The schema version whose migration patch should be cleared.
        ///</summary>
        [ApiMember(Description="The schema version whose migration patch should be cleared.", IsRequired=true, ParameterType="path")]
        public virtual int Version { get; set; }
    }

    public partial class WidgetConfigurationSchemaResponse
    {
        public virtual int Id { get; set; }
        public virtual int Version { get; set; }
        public virtual Dictionary<string, Object> Schema { get; set; } = new();
        public virtual string? DefaultConfiguration { get; set; }
        public virtual string? MigrationFromPreviousVersion { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# DeleteWidgetConfigurationSchemaMigration 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.

DELETE /widget/configurationschema/{Version}/migration HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WidgetConfigurationSchemaResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <DefaultConfiguration>String</DefaultConfiguration>
  <Id>0</Id>
  <MigrationFromPreviousVersion>String</MigrationFromPreviousVersion>
  <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>
  <Schema xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Schema>
  <Version>0</Version>
</WidgetConfigurationSchemaResponse>