BokaMera.API.Host

<back to all web services

DeleteWidgetConfiguration

Requires Authentication
The following routes are available for this service:
DELETE/widget/configuration/{Id}Delete a widget configurationPermanently removes a widget configuration.
DeleteWidgetConfiguration Parameters:
NameParameterData TypeRequiredDescription
CompanyIdqueryGuid?NoThe company id, if empty will use the company id for the user you are logged in with.
IdpathstringYesThe widget configuration id (6-character NanoID).
WidgetConfigurationResponse Parameters:
NameParameterData TypeRequiredDescription
IdformstringYes
CompanyIdformGuidNo
NameformstringYes
SlugformstringNo
DescriptionformstringNo
ConfigurationformstringYes
SchemaVersionformintNo
CreatedDateformDateTimeNo
UpdatedDateformDateTimeOffset?No
ResponseStatusformResponseStatusYes

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.

DELETE /widget/configuration/{Id} HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv
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
		}
	}
}