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.
// @ts-nocheck

export class WidgetConfigurationResponse
{
    public Id: string;
    public CompanyId: string;
    public Name: string;
    public Slug?: string;
    public Description?: string;
    public Configuration: string;
    public SchemaVersion: number;
    public CreatedDate: string;
    public UpdatedDate?: string;
    public ResponseStatus: ResponseStatus;

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

// @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")
export class WidgetConfigurationByIdQuery 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 The widget configuration id (6-character NanoID). */
    // @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
    public Id: string;

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

TypeScript WidgetConfigurationByIdQuery DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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"}}}