| GET | /licenses/plans/ | Get all license plans | This service is used to get get all license plans that exists. |
|---|
import java.math.*;
import java.util.*;
import net.servicestack.client.*;
import com.google.gson.annotations.*;
import com.google.gson.reflect.*;
public class dtos
{
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
public static class LicensePlanQuery extends QueryDb<LicensePlan, LicensePlanQueryResponse>
{
}
public static class QueryDb<From, Into> extends QueryBase
{
}
@DataContract
public static class QueryBase
{
/**
* Skip over a given number of elements in a sequence and then return the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?skip=10&orderBy=Id</code>
*/
@DataMember(Order=1)
public Integer Skip = null;
/**
* Return a given number of elements in a sequence and then skip over the remainder. Use this when you need paging.<br/><br/><strong>Example:</strong><br/><code>?take=20</code>
*/
@DataMember(Order=2)
public Integer Take = null;
/**
* Comma separated list of fields to order by. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderBy=Id,-Age,FirstName</code>
*/
@DataMember(Order=3)
public String OrderBy = null;
/**
* Comma separated list of fields to order by in descending order. Prefix the field name with a minus if you wan't to invert the sort for that field.<br/><br/><strong>Example:</strong><br/><code>?orderByDesc=Id,-Age,FirstName</code>
*/
@DataMember(Order=4)
public String OrderByDesc = null;
/**
* Include any of the aggregates <code>AVG, COUNT, FIRST, LAST, MAX, MIN, SUM</code> in your result set. The results will be returned in the meta field.<br/><br/><strong>Example:</strong><br/><code>?include=COUNT(*) as Total</code><br/><br/>or multiple fields with<br/><code>?include=Count(*) Total, Min(Age), AVG(Age) AverageAge</code><br/></br>or unique with<br/><code>?include=COUNT(DISTINCT LivingStatus) as UniqueStatus</code>
*/
@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 LicensePlan extends BaseModel implements IBaseModelUpdated, IBaseModelCreated
{
@Ignore()
public VossPlanResponse VossPlan = null;
@Required()
public Integer Id = null;
public UUID VossPlanId = null;
@Required()
public Integer PlanLength = null;
@Required()
public Integer PlanLengthUnitId = null;
@Required()
public String Name = null;
@Required()
public String Description = null;
public Date UpdatedDate = null;
public Date CreatedDate = null;
public VossPlanResponse getVossPlan() { return VossPlan; }
public LicensePlan setVossPlan(VossPlanResponse value) { this.VossPlan = value; return this; }
public Integer getId() { return Id; }
public LicensePlan setId(Integer value) { this.Id = value; return this; }
public UUID getVossPlanId() { return VossPlanId; }
public LicensePlan setVossPlanId(UUID value) { this.VossPlanId = value; return this; }
public Integer getPlanLength() { return PlanLength; }
public LicensePlan setPlanLength(Integer value) { this.PlanLength = value; return this; }
public Integer getPlanLengthUnitId() { return PlanLengthUnitId; }
public LicensePlan setPlanLengthUnitId(Integer value) { this.PlanLengthUnitId = value; return this; }
public String getName() { return Name; }
public LicensePlan setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicensePlan setDescription(String value) { this.Description = value; return this; }
public Date getUpdatedDate() { return UpdatedDate; }
public LicensePlan setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public LicensePlan setCreatedDate(Date value) { this.CreatedDate = value; return this; }
}
public static class BaseModel
{
}
public static class VossPlanResponse
{
public UUID Id = null;
public String Name = null;
public String LengthUnit = null;
public String Length = null;
public UUID getId() { return Id; }
public VossPlanResponse setId(UUID value) { this.Id = value; return this; }
public String getName() { return Name; }
public VossPlanResponse setName(String value) { this.Name = value; return this; }
public String getLengthUnit() { return LengthUnit; }
public VossPlanResponse setLengthUnit(String value) { this.LengthUnit = value; return this; }
public String getLength() { return Length; }
public VossPlanResponse setLength(String value) { this.Length = value; return this; }
}
public static class LicensePlanQueryResponse
{
public Integer Id = null;
public UUID VossPlanId = null;
public String Name = null;
public String Description = null;
public VossPlanResponse VossPlan = null;
public Integer PlanLength = null;
public LengthUnit PlanLengthUnit = null;
public Date UpdatedDate = null;
public Date CreatedDate = null;
public Integer getId() { return Id; }
public LicensePlanQueryResponse setId(Integer value) { this.Id = value; return this; }
public UUID getVossPlanId() { return VossPlanId; }
public LicensePlanQueryResponse setVossPlanId(UUID value) { this.VossPlanId = value; return this; }
public String getName() { return Name; }
public LicensePlanQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicensePlanQueryResponse setDescription(String value) { this.Description = value; return this; }
public VossPlanResponse getVossPlan() { return VossPlan; }
public LicensePlanQueryResponse setVossPlan(VossPlanResponse value) { this.VossPlan = value; return this; }
public Integer getPlanLength() { return PlanLength; }
public LicensePlanQueryResponse setPlanLength(Integer value) { this.PlanLength = value; return this; }
public LengthUnit getPlanLengthUnit() { return PlanLengthUnit; }
public LicensePlanQueryResponse setPlanLengthUnit(LengthUnit value) { this.PlanLengthUnit = value; return this; }
public Date getUpdatedDate() { return UpdatedDate; }
public LicensePlanQueryResponse setUpdatedDate(Date value) { this.UpdatedDate = value; return this; }
public Date getCreatedDate() { return CreatedDate; }
public LicensePlanQueryResponse setCreatedDate(Date value) { this.CreatedDate = value; return this; }
}
public static enum LengthUnit
{
Week(1),
Month(2),
Year(3);
private final int value;
LengthUnit(final int intValue) { value = intValue; }
public int getValue() { return value; }
}
@DataContract
public static class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
public Integer Offset = null;
@DataMember(Order=2)
public Integer Total = null;
@DataMember(Order=3)
public ArrayList<AccessKeyTypeResponse> 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<AccessKeyTypeResponse> setOffset(Integer value) { this.Offset = value; return this; }
public Integer getTotal() { return Total; }
public QueryResponse<AccessKeyTypeResponse> setTotal(Integer value) { this.Total = value; return this; }
public ArrayList<AccessKeyTypeResponse> getResults() { return Results; }
public QueryResponse<AccessKeyTypeResponse> setResults(ArrayList<AccessKeyTypeResponse> value) { this.Results = value; return this; }
public HashMap<String,String> getMeta() { return Meta; }
public QueryResponse<AccessKeyTypeResponse> setMeta(HashMap<String,String> value) { this.Meta = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public QueryResponse<AccessKeyTypeResponse> setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
public static class AccessKeyTypeResponse
{
public Integer Id = null;
public String KeyType = null;
public String Description = null;
public Integer getId() { return Id; }
public AccessKeyTypeResponse setId(Integer value) { this.Id = value; return this; }
public String getKeyType() { return KeyType; }
public AccessKeyTypeResponse setKeyType(String value) { this.KeyType = value; return this; }
public String getDescription() { return Description; }
public AccessKeyTypeResponse setDescription(String value) { this.Description = value; return this; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /licenses/plans/ HTTP/1.1 Host: testapi.bokamera.se Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"Name":"String","Description":"String","VossPlan":{"Name":"String","LengthUnit":"String","Length":"String"},"PlanLength":0,"PlanLengthUnit":"Week"}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}