Northwind Web Services

<back to all web services

GetOrders

Orders
The following routes are available for this service:
All Verbs/orders
All Verbs/orders/page/{Page}
All Verbs/customers/{CustomerId}/orders
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class GetOrders : IGet
{
    open var page:Int? = null
    open var customerId:String? = null
}

@DataContract
open class OrdersResponse
{
    @DataMember
    open var results:ArrayList<CustomerOrder> = ArrayList<CustomerOrder>()

    @DataMember
    open var responseStatus:ResponseStatus? = null
}

@DataContract
open class CustomerOrder
{
    @DataMember
    open var order:Order? = null

    @DataMember
    open var orderDetails:ArrayList<OrderDetail> = ArrayList<OrderDetail>()
}

@DataContract
open class Order
{
    @DataMember
    open var id:Int? = null

    @DataMember
    open var customerId:String? = null

    @DataMember
    open var employeeId:Int? = null

    @DataMember
    open var orderDate:Date? = null

    @DataMember
    open var requiredDate:Date? = null

    @DataMember
    open var shippedDate:Date? = null

    @DataMember
    open var shipVia:Int? = null

    @DataMember
    open var freight:BigDecimal? = null

    @DataMember
    open var shipName:String? = null

    @DataMember
    open var shipAddress:String? = null

    @DataMember
    open var shipCity:String? = null

    @DataMember
    open var shipRegion:String? = null

    @DataMember
    open var shipPostalCode:String? = null

    @DataMember
    open var shipCountry:String? = null
}

@DataContract
open class OrderDetail
{
    @DataMember
    open var orderId:Int? = null

    @DataMember
    open var productId:Int? = null

    @DataMember
    open var unitPrice:BigDecimal? = null

    @DataMember
    open var quantity:Short? = null

    @DataMember
    open var discount:Double? = null
}

Kotlin GetOrders 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 /orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	page: 0,
	customerId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	results: 
	[
		{
			order: 
			{
				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
			},
			orderDetails: 
			[
				{
					orderId: 0,
					productId: 0,
					unitPrice: 0,
					quantity: 0,
					discount: 0
				}
			]
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}