| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| PUT | /tags/{Id} | Update a tag | Replaces the editable fields of a tag. Name is required; Color, SortOrder, and Active default to null/0/true when omitted. Scope cannot be changed because it would orphan existing tag relations. |
|---|
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
[<ApiResponse(Description="Returned if Name is missing or there is another validation error on the input parameters", StatusCode=400)>]
[<ApiResponse(Description="Returned if renaming the tag would clash with another tag of the same scope", StatusCode=409)>]
[<ApiResponse(Description="Returned if the tag was not found", StatusCode=404)>]
[<ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)>]
[<ValidateRequest(Validator="IsAuthenticated")>]
[<AllowNullLiteral>]
type UpdateTag() =
///<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 id.
///</summary>
[<ApiMember(Description="The tag id.", IsRequired=true, ParameterType="path")>]
member val Id:Int32 = new Int32() 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 display color for the tag.
///</summary>
[<ApiMember(Description="The display color for the tag.")>]
member val Color:String = null with get,set
///<summary>
///The sort order. Defaults to 0 when omitted.
///</summary>
[<ApiMember(Description="The sort order. Defaults to 0 when omitted.")>]
member val SortOrder:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Whether the tag is active. Defaults to true when omitted.
///</summary>
[<ApiMember(Description="Whether the tag is active. Defaults to true when omitted.")>]
member val Active:Nullable<Boolean> = new Nullable<Boolean>() with get,set
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
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /tags/{Id} HTTP/1.1
Host: api-staging.bookmore.com
Accept: application/json
Content-Type: application/json
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"Name":"String","Color":"String","SortOrder":0,"Active":false}
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"}}}