| Required role: | API |
| All Verbs | /api/Query/Product |
|---|
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="Product")
public static class FindProduct extends QueryDb<ProductInstance>
{
}
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 ProductInstance
{
public Integer ProductId = null;
public String Group = null;
public String Name = null;
public String Description = null;
public BigDecimal Price = null;
public BigDecimal VAT = null;
public BigDecimal TotalPrice = null;
public Integer ProductType = null;
public Boolean Deleted = null;
public Boolean Demo = null;
public Integer UsageCount = null;
public Integer StockLevel = null;
public Integer ReorderFlag = null;
public Boolean VisibleOnline = null;
public Integer getProductId() { return ProductId; }
public ProductInstance setProductId(Integer value) { this.ProductId = value; return this; }
public String getGroup() { return Group; }
public ProductInstance setGroup(String value) { this.Group = value; return this; }
public String getName() { return Name; }
public ProductInstance setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public ProductInstance setDescription(String value) { this.Description = value; return this; }
public BigDecimal getPrice() { return Price; }
public ProductInstance setPrice(BigDecimal value) { this.Price = value; return this; }
public BigDecimal getVat() { return VAT; }
public ProductInstance setVat(BigDecimal value) { this.VAT = value; return this; }
public BigDecimal getTotalPrice() { return TotalPrice; }
public ProductInstance setTotalPrice(BigDecimal value) { this.TotalPrice = value; return this; }
public Integer getProductType() { return ProductType; }
public ProductInstance setProductType(Integer value) { this.ProductType = value; return this; }
public Boolean isDeleted() { return Deleted; }
public ProductInstance setDeleted(Boolean value) { this.Deleted = value; return this; }
public Boolean isDemo() { return Demo; }
public ProductInstance setDemo(Boolean value) { this.Demo = value; return this; }
public Integer getUsageCount() { return UsageCount; }
public ProductInstance setUsageCount(Integer value) { this.UsageCount = value; return this; }
public Integer getStockLevel() { return StockLevel; }
public ProductInstance setStockLevel(Integer value) { this.StockLevel = value; return this; }
public Integer getReorderFlag() { return ReorderFlag; }
public ProductInstance setReorderFlag(Integer value) { this.ReorderFlag = value; return this; }
public Boolean isVisibleOnline() { return VisibleOnline; }
public ProductInstance setVisibleOnline(Boolean value) { this.VisibleOnline = 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/Product HTTP/1.1
Host: api.clubmanagercentral.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<FindProduct 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>
</FindProduct>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfProductInstancePEZRWkv_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:ProductInstance>
<d2p1:Deleted>false</d2p1:Deleted>
<d2p1:Demo>false</d2p1:Demo>
<d2p1:Description>String</d2p1:Description>
<d2p1:Group>String</d2p1:Group>
<d2p1:Name>String</d2p1:Name>
<d2p1:Price>0</d2p1:Price>
<d2p1:ProductId>0</d2p1:ProductId>
<d2p1:ProductType>0</d2p1:ProductType>
<d2p1:ReorderFlag>0</d2p1:ReorderFlag>
<d2p1:StockLevel>0</d2p1:StockLevel>
<d2p1:TotalPrice>0</d2p1:TotalPrice>
<d2p1:UsageCount>0</d2p1:UsageCount>
<d2p1:VAT>0</d2p1:VAT>
<d2p1:VisibleOnline>false</d2p1:VisibleOnline>
</d2p1:ProductInstance>
</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>
</QueryResponseOfProductInstancePEZRWkv_P>