BokaMera.API.Host

ResetWidgetConfiguration

The following routes are available for this service:
PUT	/widget/configuration/{Id}/reset	Reset the homepage default widget configuration to factory defaults	Resets the auto-provisioned homepage default configuration's Configuration JSON and SchemaVersion back to the factory-default values. Only valid for the homepage default configuration — returns 400 for any other configuration.

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports BokaMera.API.ServiceModel.Dtos

Namespace Global

    Namespace BokaMera.API.ServiceModel.Dtos

        <ApiResponse(Description:="Returned if the target configuration is not the homepage default", 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")>
        Public Partial Class ResetWidgetConfiguration
            Implements ICompany
            '''<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.")>
            Public Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''The widget configuration id (6-character NanoID).
            '''</Summary>
            <ApiMember(Description:="The widget configuration id (6-character NanoID).", IsRequired:=true, ParameterType:="path")>
            Public Overridable Property Id As String
        End Class

        Public Partial Class WidgetConfigurationResponse
            Public Overridable Property Id As String
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Slug As String
            Public Overridable Property Description As String
            Public Overridable Property Configuration As String
            Public Overridable Property SchemaVersion As Integer
            Public Overridable Property IsHomepageDefault As Boolean
            Public Overridable Property CreatedDate As Date
            Public Overridable Property UpdatedDate As DateTimeOffset?
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET ResetWidgetConfiguration DTOs

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

HTTP + JSV

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

PUT /widget/configuration/{Id}/reset HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Name: String,
	Slug: String,
	Description: String,
	Configuration: String,
	SchemaVersion: 0,
	IsHomepageDefault: False,
	UpdatedDate: 0001-01-01T00:00:00.0000000+00:00,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}