ClubManager.Api

<back to all web services

FindOrder

Requires Authentication
Required role:API
The following routes are available for this service:
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; }
    }

}

Java FindOrder DTOs

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

HTTP + CSV

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

{"Skip":0,"Take":0,"OrderBy":"String","OrderByDesc":"String","Include":"String","Fields":"String","Meta":{"String":"String"}}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"OrderId":0,"OrderNumber":"String","OrderCode":"String","OrderAmount":0,"ReceivedDateTime":"0001-01-01T00:00:00.0000000","CompletedDateTime":"0001-01-01T00:00:00.0000000","RefundedDateTime":"0001-01-01T00:00:00.0000000","OrderFee":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}