| Requires any of the roles: | superadmin, bookingsupplier-administrator-write |
| PUT | /feature/{CompanyId}/{Id} | Set a company feature flag override | Sets the per-company IsEnabled override for a feature flag. SuperAdmin and ApplicationAdmin can always toggle; CompanyAdmin can toggle only for their own company and only when the flag has CompanyAdminCanToggle = true. |
|---|
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 CompanyFeatureFlagResponse:
id: int = 0
name: Optional[str] = None
is_enabled: bool = False
is_public: bool = False
company_admin_can_toggle: bool = False
response_status: Optional[ResponseStatus] = None
# @ApiResponse(Description="Returned if the flag is not toggleable for this caller", StatusCode=400)
# @ApiResponse(Description="Returned if the feature flag or company 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 SetCompanyFeatureFlag(ICompany):
# @ApiMember(Description="The company id.", IsRequired=true, ParameterType="path")
company_id: Optional[str] = None
"""
The company id.
"""
# @ApiMember(Description="The feature flag id.", IsRequired=true, ParameterType="path")
id: int = 0
"""
The feature flag id.
"""
# @ApiMember(Description="Whether the feature is enabled for this company.", IsRequired=true)
is_enabled: bool = False
"""
Whether the feature is enabled for this company.
"""
Python SetCompanyFeatureFlag DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /feature/{CompanyId}/{Id} HTTP/1.1
Host: api.bookmore.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<SetCompanyFeatureFlag xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Id>0</Id>
<IsEnabled>false</IsEnabled>
</SetCompanyFeatureFlag>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CompanyFeatureFlagResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyAdminCanToggle>false</CompanyAdminCanToggle>
<Id>0</Id>
<IsEnabled>false</IsEnabled>
<IsPublic>false</IsPublic>
<Name>String</Name>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
</CompanyFeatureFlagResponse>