| All Verbs | /query/orders |
|---|
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Northwind.ServiceModel;
using Northwind.ServiceModel.Types;
namespace Northwind.ServiceModel
{
public partial class QueryOrders
: QueryDb<Order>
{
public virtual decimal? Freight { get; set; }
}
}
namespace Northwind.ServiceModel.Types
{
[DataContract]
public partial class Customer
{
[DataMember]
public virtual string Id { get; set; }
[DataMember]
public virtual string CompanyName { get; set; }
[DataMember]
public virtual string ContactName { get; set; }
[DataMember]
public virtual string ContactTitle { get; set; }
[DataMember]
public virtual string Address { get; set; }
[DataMember]
public virtual string City { get; set; }
[DataMember]
public virtual string Region { get; set; }
[DataMember]
public virtual string PostalCode { get; set; }
[DataMember]
public virtual string Country { get; set; }
[DataMember]
public virtual string Phone { get; set; }
[DataMember]
public virtual string Fax { get; set; }
}
[DataContract]
public partial class Order
{
[DataMember]
public virtual int Id { get; set; }
[DataMember]
public virtual string CustomerId { get; set; }
[DataMember]
public virtual int EmployeeId { get; set; }
[DataMember]
public virtual DateTime? OrderDate { get; set; }
[DataMember]
public virtual DateTime? RequiredDate { get; set; }
[DataMember]
public virtual DateTime? ShippedDate { get; set; }
[DataMember]
public virtual int? ShipVia { get; set; }
[DataMember]
public virtual decimal Freight { get; set; }
[DataMember]
public virtual string ShipName { get; set; }
[DataMember]
public virtual string ShipAddress { get; set; }
[DataMember]
public virtual string ShipCity { get; set; }
[DataMember]
public virtual string ShipRegion { get; set; }
[DataMember]
public virtual string ShipPostalCode { get; set; }
[DataMember]
public virtual string ShipCountry { get; set; }
}
}
namespace ServiceStack
{
[DataContract]
public partial class QueryBase
{
[DataMember(Order=1)]
public virtual int? Skip { get; set; }
[DataMember(Order=2)]
public virtual int? Take { get; set; }
[DataMember(Order=3)]
public virtual string OrderBy { get; set; }
[DataMember(Order=4)]
public virtual string OrderByDesc { get; set; }
[DataMember(Order=5)]
public virtual string Include { get; set; }
[DataMember(Order=6)]
public virtual string Fields { get; set; }
[DataMember(Order=7)]
public virtual Dictionary<string, string> Meta { get; set; }
}
public partial class QueryDb<T>
: QueryBase
{
}
[DataContract]
public partial class QueryResponse<T>
{
[DataMember(Order=1)]
public virtual int Offset { get; set; }
[DataMember(Order=2)]
public virtual int Total { get; set; }
[DataMember(Order=3)]
public virtual List<Customer> Results { get; set; }
[DataMember(Order=4)]
public virtual Dictionary<string, string> Meta { get; set; }
[DataMember(Order=5)]
public virtual ResponseStatus ResponseStatus { get; set; }
}
}
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: uitestapi.occupass.com
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>