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.
<?php namespace dtos;

use DateTime;
use Exception;
use DateInterval;
use JsonSerializable;
use ServiceStack\{IReturn,IReturnVoid,IGet,IPost,IPut,IDelete,IPatch,IMeta,IHasSessionId,IHasBearerToken,IHasVersion};
use ServiceStack\{ICrud,ICreateDb,IUpdateDb,IPatchDb,IDeleteDb,ISaveDb,AuditBase,QueryDb,QueryDb2,QueryData,QueryData2,QueryResponse};
use ServiceStack\{ResponseStatus,ResponseError,EmptyResponse,IdResponse,ArrayList,KeyValuePair2,StringResponse,StringsResponse,Tuple2,Tuple3,ByteArray};
use ServiceStack\{JsonConverters,Returns,TypeContext};


class CompanyFeatureFlagResponse implements JsonSerializable
{
    public function __construct(
        /** @var int */
        public int $Id=0,
        /** @var string */
        public string $Name='',
        /** @var bool|null */
        public ?bool $IsEnabled=null,
        /** @var bool|null */
        public ?bool $IsPublic=null,
        /** @var bool|null */
        public ?bool $CompanyAdminCanToggle=null,
        /** @var ResponseStatus|null */
        public ?ResponseStatus $ResponseStatus=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['Name'])) $this->Name = $o['Name'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
        if (isset($o['IsPublic'])) $this->IsPublic = $o['IsPublic'];
        if (isset($o['CompanyAdminCanToggle'])) $this->CompanyAdminCanToggle = $o['CompanyAdminCanToggle'];
        if (isset($o['ResponseStatus'])) $this->ResponseStatus = JsonConverters::from('ResponseStatus', $o['ResponseStatus']);
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->Name)) $o['Name'] = $this->Name;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        if (isset($this->IsPublic)) $o['IsPublic'] = $this->IsPublic;
        if (isset($this->CompanyAdminCanToggle)) $o['CompanyAdminCanToggle'] = $this->CompanyAdminCanToggle;
        if (isset($this->ResponseStatus)) $o['ResponseStatus'] = JsonConverters::to('ResponseStatus', $this->ResponseStatus);
        return empty($o) ? new class(){} : $o;
    }
}

// @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, JsonSerializable
{
    public function __construct(
        /** @description The company id. */
        // @ApiMember(Description="The company id.", IsRequired=true, ParameterType="path")
        /** @var string */
        public string $CompanyId='',

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

        /** @description Whether the feature is enabled for this company. */
        // @ApiMember(Description="Whether the feature is enabled for this company.", IsRequired=true)
        /** @var bool|null */
        public ?bool $IsEnabled=null
    ) {
    }

    /** @throws Exception */
    public function fromMap($o): void {
        if (isset($o['CompanyId'])) $this->CompanyId = $o['CompanyId'];
        if (isset($o['Id'])) $this->Id = $o['Id'];
        if (isset($o['IsEnabled'])) $this->IsEnabled = $o['IsEnabled'];
    }
    
    /** @throws Exception */
    public function jsonSerialize(): mixed
    {
        $o = [];
        if (isset($this->CompanyId)) $o['CompanyId'] = $this->CompanyId;
        if (isset($this->Id)) $o['Id'] = $this->Id;
        if (isset($this->IsEnabled)) $o['IsEnabled'] = $this->IsEnabled;
        return empty($o) ? new class(){} : $o;
    }
}

PHP SetCompanyFeatureFlag DTOs

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

HTTP + OTHER

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: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":0,"IsEnabled":false}
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"Name":"String","IsEnabled":false,"IsPublic":false,"CompanyAdminCanToggle":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}