Required role: | API |
All Verbs | /api/Query/Order |
---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
@AutoQueryViewer(Description="", IconUrl="octicon:database", Title="Order")
public static class FindOrder extends QueryDb<OrderInstance>
{
}
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; }
}
public static class OrderInstance
{
public Integer OrderId = null;
public String OrderNumber = null;
public String OrderCode = null;
public BigDecimal OrderAmount = null;
public Date ReceivedDateTime = null;
public Date CompletedDateTime = null;
public Date RefundedDateTime = null;
public BigDecimal OrderFee = null;
public Integer getOrderId() { return OrderId; }
public OrderInstance setOrderId(Integer value) { this.OrderId = value; return this; }
public String getOrderNumber() { return OrderNumber; }
public OrderInstance setOrderNumber(String value) { this.OrderNumber = value; return this; }
public String getOrderCode() { return OrderCode; }
public OrderInstance setOrderCode(String value) { this.OrderCode = value; return this; }
public BigDecimal getOrderAmount() { return OrderAmount; }
public OrderInstance setOrderAmount(BigDecimal value) { this.OrderAmount = value; return this; }
public Date getReceivedDateTime() { return ReceivedDateTime; }
public OrderInstance setReceivedDateTime(Date value) { this.ReceivedDateTime = value; return this; }
public Date getCompletedDateTime() { return CompletedDateTime; }
public OrderInstance setCompletedDateTime(Date value) { this.CompletedDateTime = value; return this; }
public Date getRefundedDateTime() { return RefundedDateTime; }
public OrderInstance setRefundedDateTime(Date value) { this.RefundedDateTime = value; return this; }
public BigDecimal getOrderFee() { return OrderFee; }
public OrderInstance setOrderFee(BigDecimal value) { this.OrderFee = value; return this; }
}
@DataContract
public static class QueryResponse<T>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<T> 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<T> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<T> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<T> getResults() { return Results; }
public QueryResponse<T> setResults(ArrayList<T> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<T> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<T> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
}
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 /api/Query/Order HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ClubManager.Api.Services.Query">
<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>
</FindOrder>
HTTP/1.1 200 OK Content-Type: application/xml Content-Length: length <QueryResponseOfOrderInstancePEZRWkv_P 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/ClubManager.Api.Services.Query"> <d2p1:OrderInstance> <d2p1:CompletedDateTime>0001-01-01T00:00:00</d2p1:CompletedDateTime> <d2p1:OrderAmount>0</d2p1:OrderAmount> <d2p1:OrderCode>String</d2p1:OrderCode> <d2p1:OrderFee>0</d2p1:OrderFee> <d2p1:OrderId>0</d2p1:OrderId> <d2p1:OrderNumber>String</d2p1:OrderNumber> <d2p1:ReceivedDateTime>0001-01-01T00:00:00</d2p1:ReceivedDateTime> <d2p1:RefundedDateTime>0001-01-01T00:00:00</d2p1:RefundedDateTime> </d2p1:OrderInstance> </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> </QueryResponseOfOrderInstancePEZRWkv_P>