All Verbs | /query/customers |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class QueryCustomers : QueryDb<Customer>()
{
var ids:ArrayList<String>? = null
var countryStartsWith:String? = null
}
open class QueryDb<T> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
var skip:Int? = null
@DataMember(Order=2)
var take:Int? = null
@DataMember(Order=3)
var orderBy:String? = null
@DataMember(Order=4)
var orderByDesc:String? = null
@DataMember(Order=5)
var include:String? = null
@DataMember(Order=6)
var fields:String? = null
@DataMember(Order=7)
var meta:HashMap<String,String> = HashMap<String,String>()
}
@DataContract
open class Customer
{
@DataMember
var id:String? = null
@DataMember
var companyName:String? = null
@DataMember
var contactName:String? = null
@DataMember
var contactTitle:String? = null
@DataMember
var address:String? = null
@DataMember
var city:String? = null
@DataMember
var region:String? = null
@DataMember
var postalCode:String? = null
@DataMember
var country:String? = null
@DataMember
var phone:String? = null
@DataMember
var fax:String? = null
}
@DataContract
open class QueryResponse<Customer>
{
@DataMember(Order=1)
var offset:Int? = null
@DataMember(Order=2)
var total:Int? = null
@DataMember(Order=3)
var results:ArrayList<Customer> = ArrayList<Customer>()
@DataMember(Order=4)
var meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var responseStatus:ResponseStatus? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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/jsonl
Content-Type: text/jsonl
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/jsonl 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"}}}