Northwind Web Services

QueryCustomers

AutoQuery

The following routes are available for this service:
All Verbs	/query/customers

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 QueryCustomers extends QueryDb<Customer>
    {
        public ArrayList<String> ids = null;
        public String countryStartsWith = null;
        
        public ArrayList<String> getIds() { return ids; }
        public QueryCustomers setIds(ArrayList<String> value) { this.ids = value; return this; }
        public String getCountryStartsWith() { return countryStartsWith; }
        public QueryCustomers setCountryStartsWith(String value) { this.countryStartsWith = 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 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; }
    }

    @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; }
    }

}

Java QueryCustomers 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 /query/customers HTTP/1.1 
Host: northwind.netcore.io 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<QueryCustomers xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel">
  <Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
  <Take xmlns="http://schemas.servicestack.net/types">0</Take>
  <OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
  <OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
  <Include xmlns="http://schemas.servicestack.net/types">String</Include>
  <Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <CountryStartsWith>String</CountryStartsWith>
  <Ids xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ids>
</QueryCustomers>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfCustomerhtFHNyBe xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
  <Offset>0</Offset>
  <Total>0</Total>
  <Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/Northwind.ServiceModel.Types">
    <d2p1:Customer>
      <d2p1:Address>String</d2p1:Address>
      <d2p1:City>String</d2p1:City>
      <d2p1:CompanyName>String</d2p1:CompanyName>
      <d2p1:ContactName>String</d2p1:ContactName>
      <d2p1:ContactTitle>String</d2p1:ContactTitle>
      <d2p1:Country>String</d2p1:Country>
      <d2p1:Fax>String</d2p1:Fax>
      <d2p1:Id>String</d2p1:Id>
      <d2p1:Phone>String</d2p1:Phone>
      <d2p1:PostalCode>String</d2p1:PostalCode>
      <d2p1:Region>String</d2p1:Region>
    </d2p1:Customer>
  </Results>
  <Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Meta>
  <ResponseStatus>
    <ErrorCode>String</ErrorCode>
    <Message>String</Message>
    <StackTrace>String</StackTrace>
    <Errors>
      <ResponseError>
        <ErrorCode>String</ErrorCode>
        <FieldName>String</FieldName>
        <Message>String</Message>
        <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>
        </Meta>
      </ResponseError>
    </Errors>
    <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>
    </Meta>
  </ResponseStatus>
</QueryResponseOfCustomerhtFHNyBe>