BokaMera.API.Host

<back to all web services

SetCompanyFeatureFlag

Requires Authentication
Requires any of the roles:superadmin, bookingsupplier-administrator-write
The following routes are available for this service:
PUT/feature/{CompanyId}/{Id}Set a company feature flag overrideSets 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 'package:servicestack/servicestack.dart';

class CompanyFeatureFlagResponse implements IConvertible
{
    int Id = 0;
    String Name = "";
    bool IsEnabled;
    bool IsPublic;
    bool CompanyAdminCanToggle;
    ResponseStatus ResponseStatus;

    CompanyFeatureFlagResponse({this.Id,this.Name,this.IsEnabled,this.IsPublic,this.CompanyAdminCanToggle,this.ResponseStatus});
    CompanyFeatureFlagResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Id = json['Id'];
        Name = json['Name'];
        IsEnabled = json['IsEnabled'];
        IsPublic = json['IsPublic'];
        CompanyAdminCanToggle = json['CompanyAdminCanToggle'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Id': Id,
        'Name': Name,
        'IsEnabled': IsEnabled,
        'IsPublic': IsPublic,
        'CompanyAdminCanToggle': CompanyAdminCanToggle,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "CompanyFeatureFlagResponse";
    TypeContext? context = _ctx;
}

// @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")
class SetCompanyFeatureFlag implements ICompany, IConvertible
{
    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.", IsRequired=true, ParameterType="path")
    String CompanyId = "";

    /**
    * The feature flag id.
    */
    // @ApiMember(Description="The feature flag id.", IsRequired=true, ParameterType="path")
    int Id = 0;

    /**
    * Whether the feature is enabled for this company.
    */
    // @ApiMember(Description="Whether the feature is enabled for this company.", IsRequired=true)
    bool IsEnabled;

    SetCompanyFeatureFlag({this.CompanyId,this.Id,this.IsEnabled});
    SetCompanyFeatureFlag.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CompanyId = json['CompanyId'];
        Id = json['Id'];
        IsEnabled = json['IsEnabled'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CompanyId': CompanyId,
        'Id': Id,
        'IsEnabled': IsEnabled
    };

    getTypeName() => "SetCompanyFeatureFlag";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.bookmore.com', types: <String, TypeInfo> {
    'CompanyFeatureFlagResponse': TypeInfo(TypeOf.Class, create:() => CompanyFeatureFlagResponse()),
    'SetCompanyFeatureFlag': TypeInfo(TypeOf.Class, create:() => SetCompanyFeatureFlag()),
});

Dart SetCompanyFeatureFlag DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>