| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| POST | /tags | Create a new tag | Creates a new tag for the company. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type TagResponse() =
member val Id:Int32 = new Int32() with get,set
member val CompanyId:Guid = new Guid() with get,set
member val Name:String = null with get,set
member val Scope:Int32 = new Int32() with get,set
member val Color:String = null with get,set
member val SortOrder:Int32 = new Int32() with get,set
member val Active:Boolean = new Boolean() with get,set
member val CreatedDate:DateTime = new DateTime() with get,set
member val ResponseStatus:ResponseStatus = null with get,set
type TagScope =
| Booking = 0
| Customer = 1
[<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")>]
[<AllowNullLiteral>]
type CreateTag() =
///<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.")>]
member val CompanyId:Nullable<Guid> = new Nullable<Guid>() with get,set
///<summary>
///The tag name.
///</summary>
[<ApiMember(Description="The tag name.", IsRequired=true)>]
member val Name:String = null with 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)>]
member val Scope:TagScope = new TagScope() with 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'.")>]
member val Color:String = null with get,set
///<summary>
///The sort order for the tag.
///</summary>
[<ApiMember(Description="The sort order for the tag.")>]
member val SortOrder:Int32 = new Int32() with get,set
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
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/csv
Content-Type: text/csv
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/csv
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"}}}