| Required role: | API |
| All Verbs | /api/Query/BookingCategory |
|---|
namespace ClubManager.Api.Services.Query
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type BookingCategoryInstance() =
member val BookingCategoryId:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val Description:String = null with get,set
member val ParamTitle1:String = null with get,set
member val ParamValue1:String = null with get,set
member val ParamTitle2:String = null with get,set
member val ParamValue2:String = null with get,set
member val ParamTitle3:String = null with get,set
member val ParamValue3:String = null with get,set
member val Order:Int32 = new Int32() with get,set
member val Deleted:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val VisibleOnline:Boolean = new Boolean() with get,set
[<AutoQueryViewer(Description="", IconUrl="octicon:database", Title="BookingCategory")>]
[<AllowNullLiteral>]
type FindBookingCategory() =
inherit QueryDb<BookingCategoryInstance>()
[<DataContract>]
[<AllowNullLiteral>]
type QueryBase() =
[<DataMember(Order=1)>]
member val Skip:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=2)>]
member val Take:Nullable<Int32> = new Nullable<Int32>() with get,set
[<DataMember(Order=3)>]
member val OrderBy:String = null with get,set
[<DataMember(Order=4)>]
member val OrderByDesc:String = null with get,set
[<DataMember(Order=5)>]
member val Include:String = null with get,set
[<DataMember(Order=6)>]
member val Fields:String = null with get,set
[<DataMember(Order=7)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<AllowNullLiteral>]
type QueryDb<'T>() =
inherit QueryBase()
[<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<'T> = new ResizeArray<'T>() with get,set
[<DataMember(Order=4)>]
member val Meta:Dictionary<String, String> = new Dictionary<String, String>() with get,set
[<DataMember(Order=5)>]
member val ResponseStatus:ResponseStatus = null with get,set
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.
POST /api/Query/BookingCategory HTTP/1.1
Host: api.clubmanagercentral.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
Skip: 0,
Take: 0,
OrderBy: String,
OrderByDesc: String,
Include: String,
Fields: String,
Meta:
{
String: String
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
BookingCategoryId: 0,
Name: String,
Description: String,
ParamTitle1: String,
ParamValue1: String,
ParamTitle2: String,
ParamValue2: String,
ParamTitle3: String,
ParamValue3: String,
Order: 0,
Deleted: 0001-01-01,
VisibleOnline: False
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}