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 'package:servicestack/servicestack.dart';

class WidgetConfigurationResponse implements IConvertible
{
    String Id = "";
    String CompanyId = "";
    String Name = "";
    String? Slug;
    String? Description;
    String Configuration = "";
    int SchemaVersion = 0;
    DateTime CreatedDate = DateTime(0);
    DateTime? UpdatedDate;
    ResponseStatus ResponseStatus;

    WidgetConfigurationResponse({this.Id,this.CompanyId,this.Name,this.Slug,this.Description,this.Configuration,this.SchemaVersion,this.CreatedDate,this.UpdatedDate,this.ResponseStatus});
    WidgetConfigurationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CompanyId = json['CompanyId'];
        Name = json['Name'];
        Slug = json['Slug'];
        Description = json['Description'];
        Configuration = json['Configuration'];
        SchemaVersion = json['SchemaVersion'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        UpdatedDate = JsonConverters.fromJson(json['UpdatedDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CompanyId': CompanyId,
        'Name': Name,
        'Slug': Slug,
        'Description': Description,
        'Configuration': Configuration,
        'SchemaVersion': SchemaVersion,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'UpdatedDate': JsonConverters.toJson(UpdatedDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "WidgetConfigurationResponse";
    TypeContext? context = _ctx;
}

// @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")
class DeleteWidgetConfiguration implements ICompany, IConvertible
{
    /**
    * 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.")
    String? CompanyId;

    /**
    * The widget configuration id (6-character NanoID).
    */
    // @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
    String Id = "";

    DeleteWidgetConfiguration({this.CompanyId,this.Id});
    DeleteWidgetConfiguration.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id
    };

    getTypeName() => "DeleteWidgetConfiguration";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
    'WidgetConfigurationResponse': TypeInfo(TypeOf.Class, create:() => WidgetConfigurationResponse()),
    'DeleteWidgetConfiguration': TypeInfo(TypeOf.Class, create:() => DeleteWidgetConfiguration()),
});

Dart DeleteWidgetConfiguration DTOs

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

HTTP + CSV

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/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}