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.

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

Namespace Global

    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(Validator:="IsAuthenticated")>
        Public Partial Class CreateTag
            Implements 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 Overridable Property CompanyId As Guid? Implements ICompany.CompanyId

            '''<Summary>
            '''The tag name.
            '''</Summary>
            <ApiMember(Description:="The tag name.", IsRequired:=true)>
            Public Overridable Property Name As String

            '''<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 Overridable Property Scope As TagScope

            '''<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 Overridable Property Color As String

            '''<Summary>
            '''The sort order for the tag.
            '''</Summary>
            <ApiMember(Description:="The sort order for the tag.")>
            Public Overridable Property SortOrder As Integer
        End Class

        Public Partial Class TagResponse
            Public Overridable Property Id As Integer
            Public Overridable Property CompanyId As Guid
            Public Overridable Property Name As String
            Public Overridable Property Scope As Integer
            Public Overridable Property Color As String
            Public Overridable Property SortOrder As Integer
            Public Overridable Property Active As Boolean
            Public Overridable Property CreatedDate As Date
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace

    Namespace BokaMera.API.ServiceModel.Enums

        Public Enum TagScope
            Booking
            Customer
        End Enum
    End Namespace
End Namespace

VB.NET 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
		}
	}
}