MyApp

<back to all web services

QueryChinookCustomers

Media Store
The following routes are available for this service:
GET/customers
GET/customers/{CustomerId}
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class QueryChinookCustomers : QueryDb<Customers>(), IGet
{
    var customerId:Long? = 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>()
}

open class Customers
{
    var customerId:Long? = null
    @Required()
    var firstName:String? = null

    @Required()
    var lastName:String? = null

    var company:String? = null
    var address:String? = null
    var city:String? = null
    var state:String? = null
    var country:String? = null
    var postalCode:String? = null
    var phone:String? = null
    var fax:String? = null
    @Required()
    var email:String? = null

    var supportRepId:Long? = 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
}

open class Todo
{
    var id:Long? = null
    var text:String? = null
    var isFinished:Boolean? = null
}

Kotlin QueryChinookCustomers DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + 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: blazor-gallery.servicestack.net 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	offset: 0,
	total: 0,
	results: 
	[
		{
			customerId: 0,
			firstName: String,
			lastName: String,
			company: String,
			address: String,
			city: String,
			state: String,
			country: String,
			postalCode: String,
			phone: String,
			fax: String,
			email: String,
			supportRepId: 0
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}