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.
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    @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 static class DeleteWidgetConfiguration implements ICompany
    {
        /**
        * The company id, if empty will use the company id for the user you are logged in with.
        */
        @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
        public UUID CompanyId = null;

        /**
        * The widget configuration id (6-character NanoID).
        */
        @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
        public String Id = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public DeleteWidgetConfiguration setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getId() { return Id; }
        public DeleteWidgetConfiguration setId(String value) { this.Id = value; return this; }
    }

    public static class WidgetConfigurationResponse
    {
        public String Id = null;
        public UUID CompanyId = null;
        public String Name = null;
        public String Slug = null;
        public String Description = null;
        public String Configuration = null;
        public Integer SchemaVersion = null;
        public Date CreatedDate = null;
        public Date UpdatedDate = null;
        public ResponseStatus ResponseStatus = null;
        
        public String getId() { return Id; }
        public WidgetConfigurationResponse setId(String value) { this.Id = value; return this; }
        public UUID getCompanyId() { return CompanyId; }
        public WidgetConfigurationResponse setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public String getName() { return Name; }
        public WidgetConfigurationResponse setName(String value) { this.Name = value; return this; }
        public String getSlug() { return Slug; }
        public WidgetConfigurationResponse setSlug(String value) { this.Slug = value; return this; }
        public String getDescription() { return Description; }
        public WidgetConfigurationResponse setDescription(String value) { this.Description = value; return this; }
        public String getConfiguration() { return Configuration; }
        public WidgetConfigurationResponse setConfiguration(String value) { this.Configuration = value; return this; }
        public Integer getSchemaVersion() { return SchemaVersion; }
        public WidgetConfigurationResponse setSchemaVersion(Integer value) { this.SchemaVersion = value; return this; }
        public Date getCreatedDate() { return CreatedDate; }
        public WidgetConfigurationResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
        public Date getUpdatedDate() { return UpdatedDate; }
        public WidgetConfigurationResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public WidgetConfigurationResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java DeleteWidgetConfiguration 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.

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