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.

**BumpWidgetConfigurationVersion** Parameters:
Name	Parameter	Data Type	Required	Description
CompanyId	body	Guid?	No	The company id, if empty will use the company id for the user you are logged in with.
Id	path	string	Yes	The widget configuration id (6-character NanoID).
UseFactoryDefaults	body	bool	Yes	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.

**WidgetConfigurationResponse** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	Yes
CompanyId	form	Guid	No
Name	form	string	Yes
Slug	form	string	No
Description	form	string	No
Configuration	form	string	Yes
SchemaVersion	form	int	No
IsHomepageDefault	form	bool	No
CreatedDate	form	DateTime	No
UpdatedDate	form	DateTimeOffset?	No
ResponseStatus	form	ResponseStatus	Yes

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}/bumpversion 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,
	UseFactoryDefaults: False
}

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
		}
	}
}