GET | /todos |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class QueryTodos : QueryData<Todo>()
{
var id:Int? = null
var ids:ArrayList<Long>? = null
var textContains:String? = null
@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>? = null
}
open class QueryData<T> : 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 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>()
}
open class Todo
{
var id:Long? = null
var text:String? = null
var isFinished:Boolean? = null
}
@DataContract
open class QueryResponse<Todo>
{
@DataMember(Order=1)
var offset:Int? = null
@DataMember(Order=2)
var total:Int? = null
@DataMember(Order=3)
var results:ArrayList<Todo> = ArrayList<Todo>()
@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 .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /todos HTTP/1.1 Host: vue-vite-api.jamstacks.net Accept: text/csv
HTTP/1.1 200 OK Content-Type: text/csv Content-Length: length {"offset":0,"total":0,"results":[{"id":0,"text":"String","isFinished":false}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}