| GET | /bookings | ||
|---|---|---|---|
| GET | /bookings/{Id} |
namespace MyApp.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type AuditBase() =
[<DataMember(Order=1)>]
member val CreatedDate:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
[<Required>]
member val CreatedBy:String = null with get,set
[<DataMember(Order=3)>]
member val ModifiedDate:DateTime = new DateTime() with get,set
[<DataMember(Order=4)>]
[<Required>]
member val ModifiedBy:String = null with get,set
[<DataMember(Order=5)>]
member val DeletedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=6)>]
member val DeletedBy:String = null with get,set
type RoomType =
| Single = 0
| Double = 1
| Queen = 2
| Twin = 3
| Suite = 4
///<summary>
///Booking Details
///</summary>
[<AllowNullLiteral>]
type Booking() =
inherit AuditBase()
member val Id:Int32 = new Int32() with get,set
member val Name:String = null with get,set
member val RoomType:RoomType = new RoomType() with get,set
member val RoomNumber:Int32 = new Int32() with get,set
member val BookingStartDate:DateTime = new DateTime() with get,set
member val BookingEndDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Cost:Decimal = new Decimal() with get,set
member val Notes:String = null with get,set
member val Cancelled:Nullable<Boolean> = new Nullable<Boolean>() with get,set
[<DataMember(Order=1)>]
member val CreatedDate:DateTime = new DateTime() with get,set
[<DataMember(Order=2)>]
[<Required>]
member val CreatedBy:String = null with get,set
[<DataMember(Order=3)>]
member val ModifiedDate:DateTime = new DateTime() with get,set
[<DataMember(Order=4)>]
[<Required>]
member val ModifiedBy:String = null with get,set
[<DataMember(Order=5)>]
member val DeletedDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set
[<DataMember(Order=6)>]
member val DeletedBy:String = null with get,set
///<summary>
///Find Bookings
///</summary>
[<AllowNullLiteral>]
type QueryBookings() =
inherit QueryDb<Booking>()
member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
[<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> = null with get,set
[<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()
[<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 Todo() =
member val Id:Int64 = new Int64() with get,set
member val Text:String = null with get,set
member val IsFinished:Boolean = new Boolean() with get,set
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<Todo>() =
[<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<Todo> = new ResizeArray<Todo>() 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.
GET /bookings HTTP/1.1 Host: vue-vite-api.jamstacks.net Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
id: 0,
name: String,
roomType: Single,
roomNumber: 0,
bookingStartDate: 0001-01-01,
bookingEndDate: 0001-01-01,
cost: 0,
notes: String,
cancelled: False,
createdDate: 0001-01-01,
createdBy: String,
modifiedDate: 0001-01-01,
modifiedBy: String,
deletedDate: 0001-01-01,
deletedBy: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}