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.*;

public class dtos
{

    public static class GetOrders implements IGet
    {
        public Integer page = null;
        public String customerId = null;
        
        public Integer getPage() { return page; }
        public GetOrders setPage(Integer value) { this.page = value; return this; }
        public String getCustomerId() { return customerId; }
        public GetOrders setCustomerId(String value) { this.customerId = value; return this; }
    }

    @DataContract
    public static class OrdersResponse
    {
        @DataMember
        public ArrayList<CustomerOrder> results = null;

        @DataMember
        public ResponseStatus responseStatus = null;
        
        public ArrayList<CustomerOrder> getResults() { return results; }
        public OrdersResponse setResults(ArrayList<CustomerOrder> value) { this.results = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public OrdersResponse setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class CustomerOrder
    {
        @DataMember
        public Order order = null;

        @DataMember
        public ArrayList<OrderDetail> orderDetails = null;
        
        public Order getOrder() { return order; }
        public CustomerOrder setOrder(Order value) { this.order = value; return this; }
        public ArrayList<OrderDetail> getOrderDetails() { return orderDetails; }
        public CustomerOrder setOrderDetails(ArrayList<OrderDetail> value) { this.orderDetails = value; return this; }
    }

    @DataContract
    public static class Order
    {
        @DataMember
        public Integer id = null;

        @DataMember
        public String customerId = null;

        @DataMember
        public Integer employeeId = null;

        @DataMember
        public Date orderDate = null;

        @DataMember
        public Date requiredDate = null;

        @DataMember
        public Date shippedDate = null;

        @DataMember
        public Integer shipVia = null;

        @DataMember
        public BigDecimal freight = null;

        @DataMember
        public String shipName = null;

        @DataMember
        public String shipAddress = null;

        @DataMember
        public String shipCity = null;

        @DataMember
        public String shipRegion = null;

        @DataMember
        public String shipPostalCode = null;

        @DataMember
        public String shipCountry = null;
        
        public Integer getId() { return id; }
        public Order setId(Integer value) { this.id = value; return this; }
        public String getCustomerId() { return customerId; }
        public Order setCustomerId(String value) { this.customerId = value; return this; }
        public Integer getEmployeeId() { return employeeId; }
        public Order setEmployeeId(Integer value) { this.employeeId = value; return this; }
        public Date getOrderDate() { return orderDate; }
        public Order setOrderDate(Date value) { this.orderDate = value; return this; }
        public Date getRequiredDate() { return requiredDate; }
        public Order setRequiredDate(Date value) { this.requiredDate = value; return this; }
        public Date getShippedDate() { return shippedDate; }
        public Order setShippedDate(Date value) { this.shippedDate = value; return this; }
        public Integer getShipVia() { return shipVia; }
        public Order setShipVia(Integer value) { this.shipVia = value; return this; }
        public BigDecimal getFreight() { return freight; }
        public Order setFreight(BigDecimal value) { this.freight = value; return this; }
        public String getShipName() { return shipName; }
        public Order setShipName(String value) { this.shipName = value; return this; }
        public String getShipAddress() { return shipAddress; }
        public Order setShipAddress(String value) { this.shipAddress = value; return this; }
        public String getShipCity() { return shipCity; }
        public Order setShipCity(String value) { this.shipCity = value; return this; }
        public String getShipRegion() { return shipRegion; }
        public Order setShipRegion(String value) { this.shipRegion = value; return this; }
        public String getShipPostalCode() { return shipPostalCode; }
        public Order setShipPostalCode(String value) { this.shipPostalCode = value; return this; }
        public String getShipCountry() { return shipCountry; }
        public Order setShipCountry(String value) { this.shipCountry = value; return this; }
    }

    @DataContract
    public static class OrderDetail
    {
        @DataMember
        public Integer orderId = null;

        @DataMember
        public Integer productId = null;

        @DataMember
        public BigDecimal unitPrice = null;

        @DataMember
        public Short quantity = null;

        @DataMember
        public Double discount = null;
        
        public Integer getOrderId() { return orderId; }
        public OrderDetail setOrderId(Integer value) { this.orderId = value; return this; }
        public Integer getProductId() { return productId; }
        public OrderDetail setProductId(Integer value) { this.productId = value; return this; }
        public BigDecimal getUnitPrice() { return unitPrice; }
        public OrderDetail setUnitPrice(BigDecimal value) { this.unitPrice = value; return this; }
        public Short getQuantity() { return quantity; }
        public OrderDetail setQuantity(Short value) { this.quantity = value; return this; }
        public Double getDiscount() { return discount; }
        public OrderDetail setDiscount(Double value) { this.discount = value; return this; }
    }

}

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