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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TagResponse:
    id: int = 0
    company_id: Optional[str] = None
    name: Optional[str] = None
    scope: int = 0
    color: Optional[str] = None
    sort_order: int = 0
    active: bool = False
    created_date: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


class TagScope(str, Enum):
    BOOKING = 'Booking'
    CUSTOMER = '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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CreateTag(ICompany):
    # @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    company_id: Optional[str] = None
    """
    The company id, if empty will use the company id for the user you are logged in with.
    """


    # @ApiMember(Description="The tag name.", IsRequired=true)
    name: Optional[str] = None
    """
    The tag name.
    """


    # @ApiMember(Description="The scope this tag applies to. 0 = Booking, 1 = Customer.", IsRequired=true)
    scope: Optional[TagScope] = None
    """
    The scope this tag applies to. 0 = Booking, 1 = Customer.
    """


    # @ApiMember(Description="The display color for the tag, e.g. '#FF5733' or 'red'.")
    color: Optional[str] = None
    """
    The display color for the tag, e.g. '#FF5733' or 'red'.
    """


    # @ApiMember(Description="The sort order for the tag.")
    sort_order: int = 0
    """
    The sort order for the tag.
    """

Python CreateTag DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Name":"String","Scope":"Booking","Color":"String","SortOrder":0}

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