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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Enums;

namespace BokaMera.API.ServiceModel.Dtos
{
    [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("IsAuthenticated")]
    public partial class CreateTag
        : ICompany
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { get; set; }

        ///<summary>
        ///The tag name.
        ///</summary>
        [ApiMember(Description="The tag name.", IsRequired=true)]
        public virtual string Name { get; set; }

        ///<summary>
        ///The scope this tag applies to. 0 = Booking, 1 = Customer.
        ///</summary>
        [ApiMember(Description="The scope this tag applies to. 0 = Booking, 1 = Customer.", IsRequired=true)]
        public virtual TagScope Scope { get; set; }

        ///<summary>
        ///The display color for the tag, e.g. '#FF5733' or 'red'.
        ///</summary>
        [ApiMember(Description="The display color for the tag, e.g. '#FF5733' or 'red'.")]
        public virtual string Color { get; set; }

        ///<summary>
        ///The sort order for the tag.
        ///</summary>
        [ApiMember(Description="The sort order for the tag.")]
        public virtual int SortOrder { get; set; }
    }

    public partial class TagResponse
    {
        public virtual int Id { get; set; }
        public virtual Guid CompanyId { get; set; }
        public virtual string Name { get; set; }
        public virtual int Scope { get; set; }
        public virtual string Color { get; set; }
        public virtual int SortOrder { get; set; }
        public virtual bool Active { get; set; }
        public virtual DateTime CreatedDate { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Enums
{
    public enum TagScope
    {
        Booking,
        Customer,
    }

}

C# CreateTag 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.

POST /tags HTTP/1.1 
Host: api.bookmore.com 
Accept: text/jsv
Content-Type: text/jsv
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/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
		}
	}
}