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 java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

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

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

        /**
        * Whether the feature is enabled for this company.
        */
        @ApiMember(Description="Whether the feature is enabled for this company.", IsRequired=true)
        public Boolean IsEnabled = null;
        
        public UUID getCompanyId() { return CompanyId; }
        public SetCompanyFeatureFlag setCompanyId(UUID value) { this.CompanyId = value; return this; }
        public Integer getId() { return Id; }
        public SetCompanyFeatureFlag setId(Integer value) { this.Id = value; return this; }
        public Boolean getIsEnabled() { return IsEnabled; }
        public SetCompanyFeatureFlag setIsEnabled(Boolean value) { this.IsEnabled = value; return this; }
    }

    public static class CompanyFeatureFlagResponse
    {
        public Integer Id = null;
        public String Name = null;
        public Boolean IsEnabled = null;
        public Boolean IsPublic = null;
        public Boolean CompanyAdminCanToggle = null;
        public ResponseStatus ResponseStatus = null;
        
        public Integer getId() { return Id; }
        public CompanyFeatureFlagResponse setId(Integer value) { this.Id = value; return this; }
        public String getName() { return Name; }
        public CompanyFeatureFlagResponse setName(String value) { this.Name = value; return this; }
        public Boolean getIsEnabled() { return IsEnabled; }
        public CompanyFeatureFlagResponse setIsEnabled(Boolean value) { this.IsEnabled = value; return this; }
        public Boolean getIsPublic() { return IsPublic; }
        public CompanyFeatureFlagResponse setIsPublic(Boolean value) { this.IsPublic = value; return this; }
        public Boolean isCompanyAdminCanToggle() { return CompanyAdminCanToggle; }
        public CompanyFeatureFlagResponse setCompanyAdminCanToggle(Boolean value) { this.CompanyAdminCanToggle = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CompanyFeatureFlagResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

}

Java 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.bokamera.se 
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>