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.

"use strict";
export class TagResponse {
    /** @param {{Id?:number,CompanyId?:string,Name?:string,Scope?:number,Color?:string,SortOrder?:number,Active?:boolean,CreatedDate?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    Id;
    /** @type {string} */
    CompanyId;
    /** @type {string} */
    Name;
    /** @type {number} */
    Scope;
    /** @type {string} */
    Color;
    /** @type {number} */
    SortOrder;
    /** @type {boolean} */
    Active;
    /** @type {string} */
    CreatedDate;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
/** @typedef {'Booking'|'Customer'} */
export var TagScope;
(function (TagScope) {
    TagScope["Booking"] = "Booking"
    TagScope["Customer"] = "Customer"
})(TagScope || (TagScope = {}));
export class CreateTag {
    /** @param {{CompanyId?:string,Name?:string,Scope?:TagScope,Color?:string,SortOrder?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /**
     * @type {?string}
     * @description The company id, if empty will use the company id for the user you are logged in with. */
    CompanyId;
    /**
     * @type {string}
     * @description The tag name. */
    Name;
    /**
     * @type {TagScope}
     * @description The scope this tag applies to. 0 = Booking, 1 = Customer. */
    Scope;
    /**
     * @type {string}
     * @description The display color for the tag, e.g. '#FF5733' or 'red'. */
    Color;
    /**
     * @type {number}
     * @description The sort order for the tag. */
    SortOrder;
}

JavaScript CreateTag DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

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

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