BokaMera.API.Host

CreateWidgetConfiguration

The following routes are available for this service:
POST	/widget/configuration	Create a widget configuration	Creates a new widget configuration. The Configuration JSON is validated against the schema for SchemaVersion.

**CreateWidgetConfiguration** 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.
Name	body	string	Yes	The widget configuration name.
Slug	body	string	No	Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.
Description	body	string	No	Optional description.
Configuration	body	string	Yes	The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.
SchemaVersion	body	int	Yes	Version of the configuration schema this Configuration adheres to.

**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
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.

POST /widget/configuration HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Name: String,
	Slug: String,
	Description: String,
	Configuration: String,
	SchemaVersion: 0
}

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

{
	Id: String,
	Name: String,
	Slug: String,
	Description: String,
	Configuration: String,
	SchemaVersion: 0,
	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
		}
	}
}