BokaMera.API.Host

WidgetConfigurationQuery

The following routes are available for this service:
GET	/widget/configuration	List or get widget configurations	Returns widget configurations. If slug is provided, returns a single configuration matching that slug. Otherwise returns all configurations for the company.

// @ts-nocheck

// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
// @ValidateRequest(Validator="IsAuthenticated")
export class WidgetConfigurationQuery implements ICompany
{
    /** @description The company id, if empty will use the company id for the user you are logged in with. */
    // @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
    public CompanyId?: string;

    /** @description Optional slug to fetch a single configuration (e.g., 'hairsalon-001'). If provided, ignores other filter parameters. */
    // @ApiMember(Description="Optional slug to fetch a single configuration (e.g., 'hairsalon-001'). If provided, ignores other filter parameters.")
    public Slug?: string;

    /** @description Filter by schema version. */
    // @ApiMember(Description="Filter by schema version.")
    public SchemaVersion?: number;

    /** @description Number of records to skip */
    // @ApiMember(Description="Number of records to skip")
    public Skip?: number;

    /** @description Number of records to take */
    // @ApiMember(Description="Number of records to take")
    public Take?: number;

    /** @description Sort field */
    // @ApiMember(Description="Sort field")
    public OrderBy: string;

    public constructor(init?: Partial<WidgetConfigurationQuery>) { (Object as any).assign(this, init); }
}

export class AccessKeyTypeResponse
{
    public Id: number;
    public KeyType: string;
    public Description: string;

    public constructor(init?: Partial<AccessKeyTypeResponse>) { (Object as any).assign(this, init); }
}

// @DataContract
export class QueryResponse<T>
{
    // @DataMember(Order=1)
    public Offset: number;

    // @DataMember(Order=2)
    public Total: number;

    // @DataMember(Order=3)
    public Results: AccessKeyTypeResponse[] = [];

    // @DataMember(Order=4)
    public Meta?: { [index:string]: string; };

    // @DataMember(Order=5)
    public ResponseStatus?: ResponseStatus;

    public constructor(init?: Partial<QueryResponse<T>>) { (Object as any).assign(this, init); }
}

TypeScript WidgetConfigurationQuery 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.

GET /widget/configuration HTTP/1.1 
Host: testapi.bokamera.se 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Offset: 0,
	Total: 0,
	Results: 
	[
		{
			Id: String,
			Name: String,
			Slug: String,
			Description: String,
			Configuration: String,
			SchemaVersion: 0,
			UpdatedDate: 0001-01-01T00:00:00.0000000+00:00,
			ResponseStatus: 
			{
				ErrorCode: String,
				Message: String,
				StackTrace: String,
				Errors: 
				[
					{
						ErrorCode: String,
						FieldName: String,
						Message: String,
						Meta: 
						{
							String: String
						}
					}
				],
				Meta: 
				{
					String: String
				}
			}
		}
	],
	Meta: 
	{
		String: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}