All Verbs | /query/orders |
---|
import java.math.*
import java.util.*
import net.servicestack.client.*
import com.google.gson.annotations.*
import com.google.gson.reflect.*
open class QueryOrders : QueryDb<Order>()
{
var freight:BigDecimal? = null
}
open class QueryDb<T> : QueryBase()
{
}
@DataContract
open class QueryBase
{
@DataMember(Order=1)
var skip:Int? = null
@DataMember(Order=2)
var take:Int? = null
@DataMember(Order=3)
var orderBy:String? = null
@DataMember(Order=4)
var orderByDesc:String? = null
@DataMember(Order=5)
var include:String? = null
@DataMember(Order=6)
var fields:String? = null
@DataMember(Order=7)
var meta:HashMap<String,String> = HashMap<String,String>()
}
@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 QueryResponse<Customer>
{
@DataMember(Order=1)
var offset:Int? = null
@DataMember(Order=2)
var total:Int? = null
@DataMember(Order=3)
var results:ArrayList<Customer> = ArrayList<Customer>()
@DataMember(Order=4)
var meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var responseStatus:ResponseStatus? = null
}
@DataContract
open class Customer
{
@DataMember
var id:String? = null
@DataMember
var companyName:String? = null
@DataMember
var contactName:String? = null
@DataMember
var contactTitle:String? = null
@DataMember
var address:String? = null
@DataMember
var city:String? = null
@DataMember
var region:String? = null
@DataMember
var postalCode:String? = null
@DataMember
var country:String? = null
@DataMember
var phone:String? = null
@DataMember
var fax:String? = null
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
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: application/xml
Content-Type: application/xml
Content-Length: length
<QueryOrders 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>
<Freight>0</Freight>
</QueryOrders>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfOrderhtFHNyBe 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: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> </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> </QueryResponseOfOrderhtFHNyBe>