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 net.servicestack.client.*


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

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

    @DataMember
    var responseStatus:ResponseStatus? = null
}

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

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

@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 OrderDetail
{
    @DataMember
    var orderId:Int? = null

    @DataMember
    var productId:Int? = null

    @DataMember
    var unitPrice:BigDecimal? = null

    @DataMember
    var quantity:Short? = null

    @DataMember
    var discount:Double? = null
}

Kotlin GetOrders DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"page":0,"customerId":"String"}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"results":[{"order":{"id":0,"customerId":"String","employeeId":0,"orderDate":"\/Date(-62135596800000-0000)\/","requiredDate":"\/Date(-62135596800000-0000)\/","shippedDate":"\/Date(-62135596800000-0000)\/","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"}}}