| GET | /customers | ||
|---|---|---|---|
| GET | /customers/{CustomerId} |
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class QueryCustomers : QueryDb<Customers>(), IGet
{
open var customerId:Long? = null
}
open class QueryDb<T> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
open var skip:Int? = null
@DataMember(Order=2)
open var take:Int? = null
@DataMember(Order=3)
open var orderBy:String? = null
@DataMember(Order=4)
open var orderByDesc:String? = null
@DataMember(Order=5)
open var include:String? = null
@DataMember(Order=6)
open var fields:String? = null
@DataMember(Order=7)
open var meta:HashMap<String,String>? = null
}
open class Customers
{
open var customerId:Long? = null
@Computed()
open var displayName:String? = null
@Required()
open var firstName:String? = null
@Required()
open var lastName:String? = null
open var supportRepId:Long? = null
open var company:String? = null
open var address:String? = null
open var city:String? = null
open var state:String? = null
open var country:String? = null
open var postalCode:String? = null
open var phone:String? = null
open var fax:String? = null
@Required()
open var email:String? = null
}
@DataContract
open class QueryResponse<T>
{
@DataMember(Order=1)
open var offset:Int? = null
@DataMember(Order=2)
open var total:Int? = null
@DataMember(Order=3)
open var results:ArrayList<Albums>? = null
@DataMember(Order=4)
open var meta:HashMap<String,String>? = null
@DataMember(Order=5)
open var responseStatus:ResponseStatus? = null
}
open class Albums
{
open var albumId:Long? = null
@Required()
open var title:String? = null
open var artistId:Long? = null
}
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 /customers HTTP/1.1 Host: chinook.netcore.io Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
offset: 0,
total: 0,
results:
[
{
customerId: 0,
displayName: String String,
firstName: String,
lastName: String,
supportRepId: 0,
company: String,
address: String,
city: String,
state: String,
country: String,
postalCode: String,
phone: String,
fax: String,
email: String
}
],
meta:
{
String: String
},
responseStatus:
{
errorCode: String,
message: String,
stackTrace: String,
errors:
[
{
errorCode: String,
fieldName: String,
message: String,
meta:
{
String: String
}
}
],
meta:
{
String: String
}
}
}