| 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. |
|---|
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
@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")
open class UpdateTag : ICompany
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
override var CompanyId:UUID? = null
/**
* The tag id.
*/
@ApiMember(Description="The tag id.", IsRequired=true, ParameterType="path")
open var Id:Int? = null
/**
* The tag name.
*/
@ApiMember(Description="The tag name.", IsRequired=true)
open var Name:String? = null
/**
* The display color for the tag.
*/
@ApiMember(Description="The display color for the tag.")
open var Color:String? = null
/**
* The sort order. Defaults to 0 when omitted.
*/
@ApiMember(Description="The sort order. Defaults to 0 when omitted.")
open var SortOrder:Int? = null
/**
* Whether the tag is active. Defaults to true when omitted.
*/
@ApiMember(Description="Whether the tag is active. Defaults to true when omitted.")
open var Active:Boolean? = null
}
open class TagResponse
{
open var Id:Int? = null
open var CompanyId:UUID? = null
open var Name:String? = null
open var Scope:Int? = null
open var Color:String? = null
open var SortOrder:Int? = null
open var Active:Boolean? = null
open var CreatedDate:Date? = null
open var ResponseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: text/jsonl
Content-Type: text/jsonl
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: 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"}}}