BokaMera.API.Host

<back to all web services

WidgetConfigurationByIdQuery

Requires Authentication
The following routes are available for this service:
GET/widget/configuration/{Id}Get a single widget configurationReturns the widget configuration matching the supplied id within the current company.
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


@ApiResponse(Description="Returned if the configuration was not found", StatusCode=404)
// @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class WidgetConfigurationByIdQuery : 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 CreatedDate:Date? = null
    open var UpdatedDate:Date? = null
    open var ResponseStatus:ResponseStatus? = null
}

Kotlin WidgetConfigurationByIdQuery 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.

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

{"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"}}}