| PUT | /widget/configuration/{Id} | Update a widget configuration | Updates an existing widget configuration. The Configuration JSON is re-validated against the schema for SchemaVersion. |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
Object = TypeVar('Object')
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WidgetConfigurationResponse:
id: Optional[str] = None
company_id: Optional[str] = None
name: Optional[str] = None
slug: Optional[str] = None
description: Optional[str] = None
configuration: Optional[str] = None
schema_version: int = 0
created_date: datetime.datetime = datetime.datetime(1, 1, 1)
updated_date: Optional[datetime.datetime] = None
response_status: Optional[ResponseStatus] = None
# @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")
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class UpdateWidgetConfiguration(ICompany):
# @ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
company_id: Optional[str] = None
"""
The company id, if empty will use the company id for the user you are logged in with.
"""
# @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
id: Optional[str] = None
"""
The widget configuration id (6-character NanoID).
"""
# @ApiMember(Description="The widget configuration name.", IsRequired=true)
name: Optional[str] = None
"""
The widget configuration name.
"""
# @ApiMember(Description="Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.")
slug: Optional[str] = None
"""
Optional slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.
"""
# @ApiMember(Description="Optional description.")
description: Optional[str] = None
"""
Optional description.
"""
# @ApiMember(Description="The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.", IsRequired=true)
configuration: Optional[str] = None
"""
The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.
"""
# @ApiMember(Description="Version of the configuration schema this Configuration adheres to.", IsRequired=true)
schema_version: int = 0
"""
Version of the configuration schema this Configuration adheres to.
"""
Python UpdateWidgetConfiguration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PUT /widget/configuration/{Id} HTTP/1.1
Host: testapi.bokamera.se
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"CompanyId":"00000000-0000-0000-0000-000000000000","Id":"String","Name":"String","Slug":"String","Description":"String","Configuration":"String","SchemaVersion":0}
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"}}}