| 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 'package:servicestack/servicestack.dart';
class WidgetConfigurationResponse implements IConvertible
{
String Id = "";
String CompanyId = "";
String Name = "";
String? Slug;
String? Description;
String Configuration = "";
int SchemaVersion = 0;
DateTime CreatedDate = DateTime(0);
DateTime? UpdatedDate;
ResponseStatus ResponseStatus;
WidgetConfigurationResponse({this.Id,this.CompanyId,this.Name,this.Slug,this.Description,this.Configuration,this.SchemaVersion,this.CreatedDate,this.UpdatedDate,this.ResponseStatus});
WidgetConfigurationResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
Id = json['Id'];
CompanyId = json['CompanyId'];
Name = json['Name'];
Slug = json['Slug'];
Description = json['Description'];
Configuration = json['Configuration'];
SchemaVersion = json['SchemaVersion'];
CreatedDate = JsonConverters.fromJson(json['CreatedDate'],'DateTime',context!);
UpdatedDate = JsonConverters.fromJson(json['UpdatedDate'],'DateTime',context!);
ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
return this;
}
Map<String, dynamic> toJson() => {
'Id': Id,
'CompanyId': CompanyId,
'Name': Name,
'Slug': Slug,
'Description': Description,
'Configuration': Configuration,
'SchemaVersion': SchemaVersion,
'CreatedDate': JsonConverters.toJson(CreatedDate,'DateTime',context!),
'UpdatedDate': JsonConverters.toJson(UpdatedDate,'DateTime',context!),
'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
};
getTypeName() => "WidgetConfigurationResponse";
TypeContext? context = _ctx;
}
// @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")
class UpdateWidgetConfiguration implements ICompany, IConvertible
{
/**
* 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.")
String? CompanyId;
/**
* The widget configuration id (6-character NanoID).
*/
// @ApiMember(Description="The widget configuration id (6-character NanoID).", IsRequired=true, ParameterType="path")
String Id = "";
/**
* The widget configuration name.
*/
// @ApiMember(Description="The widget configuration name.", IsRequired=true)
String Name = "";
/**
* 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 slug (URL-friendly identifier). The API will append the last 3 characters of the company ID. Example: 'hairsalon' becomes 'hairsalon-001'.")
String? Slug;
/**
* Optional description.
*/
// @ApiMember(Description="Optional description.")
String? Description;
/**
* The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.
*/
// @ApiMember(Description="The widget configuration as a JSON string. Must validate against the schema for SchemaVersion.", IsRequired=true)
String Configuration = "";
/**
* Version of the configuration schema this Configuration adheres to.
*/
// @ApiMember(Description="Version of the configuration schema this Configuration adheres to.", IsRequired=true)
int SchemaVersion = 0;
UpdateWidgetConfiguration({this.CompanyId,this.Id,this.Name,this.Slug,this.Description,this.Configuration,this.SchemaVersion});
UpdateWidgetConfiguration.fromJson(Map<String, dynamic> json) { fromMap(json); }
fromMap(Map<String, dynamic> json) {
CompanyId = json['CompanyId'];
Id = json['Id'];
Name = json['Name'];
Slug = json['Slug'];
Description = json['Description'];
Configuration = json['Configuration'];
SchemaVersion = json['SchemaVersion'];
return this;
}
Map<String, dynamic> toJson() => {
'CompanyId': CompanyId,
'Id': Id,
'Name': Name,
'Slug': Slug,
'Description': Description,
'Configuration': Configuration,
'SchemaVersion': SchemaVersion
};
getTypeName() => "UpdateWidgetConfiguration";
TypeContext? context = _ctx;
}
TypeContext _ctx = TypeContext(library: 'testapi.bokamera.se', types: <String, TypeInfo> {
'WidgetConfigurationResponse': TypeInfo(TypeOf.Class, create:() => WidgetConfigurationResponse()),
'UpdateWidgetConfiguration': TypeInfo(TypeOf.Class, create:() => UpdateWidgetConfiguration()),
});
Dart UpdateWidgetConfiguration DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<UpdateWidgetConfiguration xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Configuration>String</Configuration>
<Description>String</Description>
<Id>String</Id>
<Name>String</Name>
<SchemaVersion>0</SchemaVersion>
<Slug>String</Slug>
</UpdateWidgetConfiguration>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<WidgetConfigurationResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
<CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
<Configuration>String</Configuration>
<CreatedDate>0001-01-01T00:00:00</CreatedDate>
<Description>String</Description>
<Id>String</Id>
<Name>String</Name>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<SchemaVersion>0</SchemaVersion>
<Slug>String</Slug>
<UpdatedDate xmlns:d2p1="http://schemas.datacontract.org/2004/07/System">
<d2p1:DateTime>0001-01-01T00:00:00Z</d2p1:DateTime>
<d2p1:OffsetMinutes>0</d2p1:OffsetMinutes>
</UpdatedDate>
</WidgetConfigurationResponse>