Northwind Web Services

<back to all 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.*;

public class dtos
{

    public static class QueryOrders extends QueryDb<Order>
    {
        public BigDecimal freight = null;
        
        public BigDecimal getFreight() { return freight; }
        public QueryOrders setFreight(BigDecimal value) { this.freight = value; return this; }
    }

    public static class QueryDb<T> extends QueryBase
    {
        
    }

    @DataContract
    public static class QueryBase
    {
        @DataMember(Order=1)
        public Integer skip = null;

        @DataMember(Order=2)
        public Integer take = null;

        @DataMember(Order=3)
        public String orderBy = null;

        @DataMember(Order=4)
        public String orderByDesc = null;

        @DataMember(Order=5)
        public String include = null;

        @DataMember(Order=6)
        public String fields = null;

        @DataMember(Order=7)
        public HashMap<String,String> meta = null;
        
        public Integer getSkip() { return skip; }
        public QueryBase setSkip(Integer value) { this.skip = value; return this; }
        public Integer getTake() { return take; }
        public QueryBase setTake(Integer value) { this.take = value; return this; }
        public String getOrderBy() { return orderBy; }
        public QueryBase setOrderBy(String value) { this.orderBy = value; return this; }
        public String getOrderByDesc() { return orderByDesc; }
        public QueryBase setOrderByDesc(String value) { this.orderByDesc = value; return this; }
        public String getInclude() { return include; }
        public QueryBase setInclude(String value) { this.include = value; return this; }
        public String getFields() { return fields; }
        public QueryBase setFields(String value) { this.fields = value; return this; }
        public HashMap<String,String> getMeta() { return meta; }
        public QueryBase setMeta(HashMap<String,String> value) { this.meta = 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 QueryResponse<Customer>
    {
        @DataMember(Order=1)
        public Integer offset = null;

        @DataMember(Order=2)
        public Integer total = null;

        @DataMember(Order=3)
        public ArrayList<Customer> results = null;

        @DataMember(Order=4)
        public HashMap<String,String> meta = null;

        @DataMember(Order=5)
        public ResponseStatus responseStatus = null;
        
        public Integer getOffset() { return offset; }
        public QueryResponse<Customer> setOffset(Integer value) { this.offset = value; return this; }
        public Integer getTotal() { return total; }
        public QueryResponse<Customer> setTotal(Integer value) { this.total = value; return this; }
        public ArrayList<Customer> getResults() { return results; }
        public QueryResponse<Customer> setResults(ArrayList<Customer> value) { this.results = value; return this; }
        public HashMap<String,String> getMeta() { return meta; }
        public QueryResponse<Customer> setMeta(HashMap<String,String> value) { this.meta = value; return this; }
        public ResponseStatus getResponseStatus() { return responseStatus; }
        public QueryResponse<Customer> setResponseStatus(ResponseStatus value) { this.responseStatus = value; return this; }
    }

    @DataContract
    public static class Customer
    {
        @DataMember
        public String id = null;

        @DataMember
        public String companyName = null;

        @DataMember
        public String contactName = null;

        @DataMember
        public String contactTitle = null;

        @DataMember
        public String address = null;

        @DataMember
        public String city = null;

        @DataMember
        public String region = null;

        @DataMember
        public String postalCode = null;

        @DataMember
        public String country = null;

        @DataMember
        public String phone = null;

        @DataMember
        public String fax = null;
        
        public String getId() { return id; }
        public Customer setId(String value) { this.id = value; return this; }
        public String getCompanyName() { return companyName; }
        public Customer setCompanyName(String value) { this.companyName = value; return this; }
        public String getContactName() { return contactName; }
        public Customer setContactName(String value) { this.contactName = value; return this; }
        public String getContactTitle() { return contactTitle; }
        public Customer setContactTitle(String value) { this.contactTitle = value; return this; }
        public String getAddress() { return address; }
        public Customer setAddress(String value) { this.address = value; return this; }
        public String getCity() { return city; }
        public Customer setCity(String value) { this.city = value; return this; }
        public String getRegion() { return region; }
        public Customer setRegion(String value) { this.region = value; return this; }
        public String getPostalCode() { return postalCode; }
        public Customer setPostalCode(String value) { this.postalCode = value; return this; }
        public String getCountry() { return country; }
        public Customer setCountry(String value) { this.country = value; return this; }
        public String getPhone() { return phone; }
        public Customer setPhone(String value) { this.phone = value; return this; }
        public String getFax() { return fax; }
        public Customer setFax(String value) { this.fax = value; return this; }
    }

}

Java QueryOrders DTOs

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

HTTP + OTHER

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/x-vcard
Content-Type: text/x-vcard
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/x-vcard
Content-Length: length

{"offset":0,"total":0,"results":[{"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"}],"meta":{"String":"String"},"responseStatus":{"errorCode":"String","message":"String","stackTrace":"String","errors":[{"errorCode":"String","fieldName":"String","message":"String","meta":{"String":"String"}}],"meta":{"String":"String"}}}