BokaMera.API.Host

<back to all web services

SetHomepageWidgetConfiguration

Requires Authentication
Requires any of the roles:bookingsupplier-administrator-write, superadmin
The following routes are available for this service:
PUT/widget/configuration/{Id}/sethomepageSet a widget configuration as the homepage defaultMakes the supplied configuration the company's homepage default and removes the flag from the previous one. Slugs are left unchanged. Calling it on the current homepage default is a no-op success.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="Returned if there is a validation error on the input parameters", StatusCode=400)
// @ApiResponse(Description="Returned if the configuration was not found", StatusCode=404)
// @ApiResponse(Description="Returned if the current user is not allowed to perform the action", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class SetHomepageWidgetConfiguration : ICompany
{
    /**
    * 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.")
    override var CompanyId:UUID? = null

    /**
    * The widget configuration id (6-character NanoID).
    */
    @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
    open var Id:String? = null
}

open class WidgetConfigurationResponse
{
    open var Id:String? = null
    open var CompanyId:UUID? = null
    open var Name:String? = null
    open var Slug:String? = null
    open var Description:String? = null
    open var Configuration:String? = null
    open var SchemaVersion:Int? = null
    open var IsHomepageDefault:Boolean? = null
    open var CreatedDate:Date? = null
    open var UpdatedDate:Date? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin SetHomepageWidgetConfiguration DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

PUT /widget/configuration/{Id}/sethomepage HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0,"IsHomepageDefault":false,"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"}}}