Northwind Web Services

<back to all web services

CachedGetOrders

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

public class dtos
{

    public static class CachedGetOrders implements IGet
    {
        public Integer page = null;
        public String customerId = null;
        
        public Integer getPage() { return page; }
        public CachedGetOrders setPage(Integer value) { this.page = value; return this; }
        public String getCustomerId() { return customerId; }
        public CachedGetOrders 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 CachedGetOrders DTOs

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

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /cached/orders HTTP/1.1 
Host: northwind.netcore.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CachedGetOrders xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel">
  <CustomerId>String</CustomerId>
  <Page>0</Page>
</CachedGetOrders>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<OrdersResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel.Types">
    <d2p1:CustomerOrder>
      <d2p1:Order>
        <d2p1:CustomerId>String</d2p1:CustomerId>
        <d2p1:EmployeeId>0</d2p1:EmployeeId>
        <d2p1:Freight>0</d2p1:Freight>
        <d2p1:Id>0</d2p1:Id>
        <d2p1:OrderDate>0001-01-01T00:00:00</d2p1:OrderDate>
        <d2p1:RequiredDate>0001-01-01T00:00:00</d2p1:RequiredDate>
        <d2p1:ShipAddress>String</d2p1:ShipAddress>
        <d2p1:ShipCity>String</d2p1:ShipCity>
        <d2p1:ShipCountry>String</d2p1:ShipCountry>
        <d2p1:ShipName>String</d2p1:ShipName>
        <d2p1:ShipPostalCode>String</d2p1:ShipPostalCode>
        <d2p1:ShipRegion>String</d2p1:ShipRegion>
        <d2p1:ShipVia>0</d2p1:ShipVia>
        <d2p1:ShippedDate>0001-01-01T00:00:00</d2p1:ShippedDate>
      </d2p1:Order>
      <d2p1:OrderDetails>
        <d2p1:OrderDetail>
          <d2p1:Discount>0</d2p1:Discount>
          <d2p1:OrderId>0</d2p1:OrderId>
          <d2p1:ProductId>0</d2p1:ProductId>
          <d2p1:Quantity>0</d2p1:Quantity>
          <d2p1:UnitPrice>0</d2p1:UnitPrice>
        </d2p1:OrderDetail>
      </d2p1:OrderDetails>
    </d2p1:CustomerOrder>
  </Results>
</OrdersResponse>