Northwind Web Services

QueryOrders

AutoQuery

The following routes are available for this service:
All Verbs	/query/orders

import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*


open class QueryOrders : QueryDb<Order>()
{
    var freight:BigDecimal? = 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 Order
{
    @DataMember
    var id:Int? = null

    @DataMember
    var customerId:String? = null

    @DataMember
    var employeeId:Int? = null

    @DataMember
    var orderDate:Date? = null

    @DataMember
    var requiredDate:Date? = null

    @DataMember
    var shippedDate:Date? = null

    @DataMember
    var shipVia:Int? = null

    @DataMember
    var freight:BigDecimal? = null

    @DataMember
    var shipName:String? = null

    @DataMember
    var shipAddress:String? = null

    @DataMember
    var shipCity:String? = null

    @DataMember
    var shipRegion:String? = null

    @DataMember
    var shipPostalCode:String? = null

    @DataMember
    var shipCountry: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
}

@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
}

Kotlin QueryOrders 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.

POST /query/orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	freight: 0,
	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: 0,
			customerId: String,
			employeeId: 0,
			orderDate: 0001-01-01,
			requiredDate: 0001-01-01,
			shippedDate: 0001-01-01,
			shipVia: 0,
			freight: 0,
			shipName: String,
			shipAddress: String,
			shipCity: String,
			shipRegion: String,
			shipPostalCode: String,
			shipCountry: String
		}
	],
	meta: 
	{
		String: String
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}