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 Foundation
import ServiceStack

// @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 class SetCompanyFeatureFlag : ICompany, Codable
{
    /**
    * The company id.
    */
    // @ApiMember(Description="The company id.", IsRequired=true, ParameterType="path")
    public var companyId:String?

    /**
    * The feature flag id.
    */
    // @ApiMember(Description="The feature flag id.", IsRequired=true, ParameterType="path")
    public var id:Int

    /**
    * Whether the feature is enabled for this company.
    */
    // @ApiMember(Description="Whether the feature is enabled for this company.", IsRequired=true)
    public var isEnabled:Bool

    required public init(){}
}

public class CompanyFeatureFlagResponse : Codable
{
    public var id:Int
    public var name:String
    public var isEnabled:Bool
    public var isPublic:Bool
    public var companyAdminCanToggle:Bool
    public var responseStatus:ResponseStatus

    required public init(){}
}


Swift SetCompanyFeatureFlag DTOs

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

HTTP + JSV

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

{
	CompanyId: 00000000-0000-0000-0000-000000000000,
	Id: 0,
	IsEnabled: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}