| GET | /widget/configurationschema | List widget configuration schemas | Returns all known configuration schemas, sortable via OrderBy. Schemas are global (not company-scoped); the schema document itself (Schema, DefaultConfiguration) is immutable per Version. The one exception is MigrationFromPreviousVersion, which can be set/replaced via PUT /widget/configurationschema/{Version}/migration. |
|---|
namespace BokaMera.API.ServiceModel.Dtos
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type WidgetConfigurationSchemaQuery() =
///<summary>
///Filter by version.
///</summary>
[<ApiMember(Description="Filter by version.")>]
member val Version:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Number of records to skip
///</summary>
[<ApiMember(Description="Number of records to skip")>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Number of records to take
///</summary>
[<ApiMember(Description="Number of records to take")>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
///<summary>
///Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate.
///</summary>
[<ApiMember(Description="Sort field, e.g. 'Version' or '-Version' for descending. Allowed: Id, Version, CreatedDate.")>]
member val OrderBy:String = null with get,set
[<AllowNullLiteral>]
type AccessKeyTypeResponse() =
member val Id:Int32 = new Int32() with get,set
member val KeyType:String = null with get,set
member val Description:String = null with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<T>() =
[<DataMember(Order=1)>]
member val Offset:Int32 = new Int32() with get,set
[<DataMember(Order=2)>]
member val Total:Int32 = new Int32() with get,set
[<DataMember(Order=3)>]
member val Results:ResizeArray<AccessKeyTypeResponse> = null with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = null with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
F# WidgetConfigurationSchemaQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /widget/configurationschema HTTP/1.1 Host: api.bookmore.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
Version: 0,
Schema:
{
String: {}
},
DefaultConfiguration: String,
MigrationFromPreviousVersion: String,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}