| 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 datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class TagResponse:
id: int = 0
company_id: Optional[str] = None
name: Optional[str] = None
scope: int = 0
color: Optional[str] = None
sort_order: int = 0
active: bool = False
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
response_status: Optional[ResponseStatus] = None
# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateTag(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The tag id.", IsRequired=true, ParameterType="path")
id: int = 0
"""
The tag id.
"""
# @ApiMember(Description="The tag name.", IsRequired=true)
name: Optional[str] = None
"""
The tag name.
"""
# @ApiMember(Description="The display color for the tag.")
color: Optional[str] = None
"""
The display color for the tag.
"""
# @ApiMember(Description="The sort order. Defaults to 0 when omitted.")
sort_order: Optional[int] = None
"""
The sort order. Defaults to 0 when omitted.
"""
# @ApiMember(Description="Whether the tag is active. Defaults to true when omitted.")
active: Optional[bool] = None
"""
Whether the tag is active. Defaults to true when omitted.
"""
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"}}}