| All Verbs | /query/customers |
|---|
namespace Northwind.ServiceModel
open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<DataContract>]
[<AllowNullLiteral>]
type Customer() =
[<DataMember>]
member val Id:String = null with get,set
[<DataMember>]
member val CompanyName:String = null with get,set
[<DataMember>]
member val ContactName:String = null with get,set
[<DataMember>]
member val ContactTitle:String = null with get,set
[<DataMember>]
member val Address:String = null with get,set
[<DataMember>]
member val City:String = null with get,set
[<DataMember>]
member val Region:String = null with get,set
[<DataMember>]
member val PostalCode:String = null with get,set
[<DataMember>]
member val Country:String = null with get,set
[<DataMember>]
member val Phone:String = null with get,set
[<DataMember>]
member val Fax:String = null with get,set
[<AllowNullLiteral>]
type QueryCustomers() =
inherit QueryDb<Customer>()
member val Ids:ResizeArray<String> = null with get,set
member val CountryStartsWith: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()
[<DataContract>]
[<AllowNullLiteral>]
type QueryResponse<Customer>() =
[<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<Customer> = new ResizeArray<Customer>() 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 /query/customers HTTP/1.1
Host: northwind.netcore.io
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
ids:
[
String
],
countryStartsWith: String,
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:
[
{
id: String,
companyName: String,
contactName: String,
contactTitle: String,
address: String,
city: String,
region: String,
postalCode: String,
country: String,
phone: String,
fax: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}