BokaMera.API.Host

CreateTag

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

The following routes are available for this service:
POST	/tags	Create a new tag	Creates a new tag for the company.

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

enum TagScope
{
    Booking,
    Customer,
}

// @ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
class CreateTag 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 name.
    */
    // @ApiMember(Description="The tag name.", IsRequired=true)
    String Name = "";

    /**
    * The scope this tag applies to. 0 = Booking, 1 = Customer.
    */
    // @ApiMember(Description="The scope this tag applies to. 0 = Booking, 1 = Customer.", IsRequired=true)
    TagScope Scope;

    /**
    * The display color for the tag, e.g. '#FF5733' or 'red'.
    */
    // @ApiMember(Description="The display color for the tag, e.g. '#FF5733' or 'red'.")
    String Color = "";

    /**
    * The sort order for the tag.
    */
    // @ApiMember(Description="The sort order for the tag.")
    int SortOrder = 0;

    CreateTag({this.CompanyId,this.Name,this.Scope,this.Color,this.SortOrder});
    CreateTag.fromJson(Map<String, dynamic> json) { fromMap(json); }

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

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

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

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

Dart CreateTag DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /tags HTTP/1.1 
Host: api.bookmore.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateTag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Color>String</Color>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <Name>String</Name>
  <Scope>Booking</Scope>
  <SortOrder>0</SortOrder>
</CreateTag>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<TagResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Color>String</Color>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <CreatedDate>0001-01-01T00:00:00</CreatedDate>
  <Id>0</Id>
  <Name>String</Name>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Scope>0</Scope>
  <SortOrder>0</SortOrder>
</TagResponse>