BokaMera.API.Host

DeleteTag

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin

The following routes are available for this service:
DELETE	/tags/{Id}	Deactivate a tag	Deactivates a tag (soft delete). The tag is not removed from the database.

import 'package:servicestack/servicestack.dart';

class TagResponse implements IConvertible
{
    int Id = 0;
    String CompanyId = "";
    String Name = "";
    int Scope = 0;
    String Color = "";
    int SortOrder = 0;
    bool Active;
    DateTime CreatedDate = DateTime(0);
    ResponseStatus ResponseStatus;

    TagResponse({this.Id,this.CompanyId,this.Name,this.Scope,this.Color,this.SortOrder,this.Active,this.CreatedDate,this.ResponseStatus});
    TagResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        CompanyId = json['CompanyId'];
        Name = json['Name'];
        Scope = json['Scope'];
        Color = json['Color'];
        SortOrder = json['SortOrder'];
        Active = json['Active'];
        CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'CompanyId': CompanyId,
        'Name': Name,
        'Scope': Scope,
        'Color': Color,
        'SortOrder': SortOrder,
        'Active': Active,
        'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

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

// @ApiResponse(Description="Returned if the tag 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 DeleteTag 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 tag id.
    */
    // @ApiMember(Description="The tag id.", IsRequired=true, ParameterType="path")
    int Id = 0;

    DeleteTag({this.CompanyId,this.Id});
    DeleteTag.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() => "DeleteTag";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'TagResponse': TypeInfo(TypeOf.Class, create:() => TagResponse()),
    'DeleteTag': TypeInfo(TypeOf.Class, create:() => DeleteTag()),
});

Dart DeleteTag 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 /tags/{Id} HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv

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

{
	Id: 0,
	Name: String,
	Scope: 0,
	Color: String,
	SortOrder: 0,
	Active: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}