| GET | /licenses/information/ | Get whats included in each license | This service is used to get to summare of information about whats included in each license. |
|---|
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 LicenseInformationQuery extends QueryDb<LicenseInformation, LicenseTypeQueryResponse>
{
/**
* If you want to include the connected license prices
*/
@ApiMember(DataType="boolean", Description="If you want to include the connected license prices", ParameterType="query")
public Boolean IncludeLicensePrices = null;
public ResponseStatus ResponseStatus = null;
public Boolean isIncludeLicensePrices() { return IncludeLicensePrices; }
public LicenseInformationQuery setIncludeLicensePrices(Boolean value) { this.IncludeLicensePrices = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public LicenseInformationQuery setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
}
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 LicenseInformation extends BaseModel
{
@Ignore()
public IList<LicensePrice> Prices = null;
public Integer Id = null;
public Integer LicenseInformationId = null;
@Required()
public String Name = null;
@Required()
public String Description = null;
public String Url = null;
@Required()
public Boolean FreeEdition = null;
@Required()
public Boolean StartEdition = null;
@Required()
public Boolean ProEdition = null;
public String FreeEditionValue = null;
public String StartEditionValue = null;
public String ProEditionValue = null;
public Boolean PlatinumEdition = null;
public String PlatinumEditionValue = null;
public Date ModifiedDate = null;
public Boolean SmartEdition = null;
public Boolean EnterpriseEdition = null;
public String SmartEditionValue = null;
public String EnterpriseEditionValue = null;
public IList<LicensePrice> getPrices() { return Prices; }
public LicenseInformation setPrices(IList<LicensePrice> value) { this.Prices = value; return this; }
public Integer getId() { return Id; }
public LicenseInformation setId(Integer value) { this.Id = value; return this; }
public Integer getLicenseInformationId() { return LicenseInformationId; }
public LicenseInformation setLicenseInformationId(Integer value) { this.LicenseInformationId = value; return this; }
public String getName() { return Name; }
public LicenseInformation setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicenseInformation setDescription(String value) { this.Description = value; return this; }
public String getUrl() { return Url; }
public LicenseInformation setUrl(String value) { this.Url = value; return this; }
public Boolean isFreeEdition() { return FreeEdition; }
public LicenseInformation setFreeEdition(Boolean value) { this.FreeEdition = value; return this; }
public Boolean isStartEdition() { return StartEdition; }
public LicenseInformation setStartEdition(Boolean value) { this.StartEdition = value; return this; }
public Boolean isProEdition() { return ProEdition; }
public LicenseInformation setProEdition(Boolean value) { this.ProEdition = value; return this; }
public String getFreeEditionValue() { return FreeEditionValue; }
public LicenseInformation setFreeEditionValue(String value) { this.FreeEditionValue = value; return this; }
public String getStartEditionValue() { return StartEditionValue; }
public LicenseInformation setStartEditionValue(String value) { this.StartEditionValue = value; return this; }
public String getProEditionValue() { return ProEditionValue; }
public LicenseInformation setProEditionValue(String value) { this.ProEditionValue = value; return this; }
public Boolean isPlatinumEdition() { return PlatinumEdition; }
public LicenseInformation setPlatinumEdition(Boolean value) { this.PlatinumEdition = value; return this; }
public String getPlatinumEditionValue() { return PlatinumEditionValue; }
public LicenseInformation setPlatinumEditionValue(String value) { this.PlatinumEditionValue = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public LicenseInformation setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public Boolean isSmartEdition() { return SmartEdition; }
public LicenseInformation setSmartEdition(Boolean value) { this.SmartEdition = value; return this; }
public Boolean isEnterpriseEdition() { return EnterpriseEdition; }
public LicenseInformation setEnterpriseEdition(Boolean value) { this.EnterpriseEdition = value; return this; }
public String getSmartEditionValue() { return SmartEditionValue; }
public LicenseInformation setSmartEditionValue(String value) { this.SmartEditionValue = value; return this; }
public String getEnterpriseEditionValue() { return EnterpriseEditionValue; }
public LicenseInformation setEnterpriseEditionValue(String value) { this.EnterpriseEditionValue = value; return this; }
}
public static class BaseModel
{
}
public static class LicensePrice extends BaseModel
{
@Ignore()
public Country Country = null;
@Ignore()
public Boolean MonthlyPayment = null;
@Required()
public Integer LicenseTypeId = null;
@Required()
public String CountryId = null;
@Required()
public Integer Price = null;
public Date ModifiedDate = null;
public Country getCountry() { return Country; }
public LicensePrice setCountry(Country value) { this.Country = value; return this; }
public Boolean isMonthlyPayment() { return MonthlyPayment; }
public LicensePrice setMonthlyPayment(Boolean value) { this.MonthlyPayment = value; return this; }
public Integer getLicenseTypeId() { return LicenseTypeId; }
public LicensePrice setLicenseTypeId(Integer value) { this.LicenseTypeId = value; return this; }
public String getCountryId() { return CountryId; }
public LicensePrice setCountryId(String value) { this.CountryId = value; return this; }
public Integer getPrice() { return Price; }
public LicensePrice setPrice(Integer value) { this.Price = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public LicensePrice setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
public static class Country extends BaseModel
{
@References(Currency.class)
public String CurrencyId = null;
public Currency CurrencyInfo = null;
@Required()
public String Name = null;
public String Culture = null;
public String TimeZone = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getCurrencyId() { return CurrencyId; }
public Country setCurrencyId(String value) { this.CurrencyId = value; return this; }
public Currency getCurrencyInfo() { return CurrencyInfo; }
public Country setCurrencyInfo(Currency value) { this.CurrencyInfo = value; return this; }
public String getName() { return Name; }
public Country setName(String value) { this.Name = value; return this; }
public String getCulture() { return Culture; }
public Country setCulture(String value) { this.Culture = value; return this; }
public String getTimeZone() { return TimeZone; }
public Country setTimeZone(String value) { this.TimeZone = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Country setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Country setId(String value) { this.Id = value; return this; }
}
public static class Currency extends BaseModel
{
@Required()
public String Name = null;
@Required()
public String CurrencySign = null;
@Required()
public Boolean Active = null;
public Date ModifiedDate = null;
@Required()
public String Id = null;
public String getName() { return Name; }
public Currency setName(String value) { this.Name = value; return this; }
public String getCurrencySign() { return CurrencySign; }
public Currency setCurrencySign(String value) { this.CurrencySign = value; return this; }
public Boolean isActive() { return Active; }
public Currency setActive(Boolean value) { this.Active = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public Currency setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getId() { return Id; }
public Currency setId(String value) { this.Id = value; return this; }
}
public static class LicenseTypeQueryResponse
{
/**
* The license type id
*/
@ApiMember(Description="The license type id")
public Integer Id = null;
/**
* The license type name
*/
@ApiMember(Description="The license type name")
public String Name = null;
/**
* The license type description
*/
@ApiMember(Description="The license type description")
public String Description = null;
/**
* If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
*/
@ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.")
public Boolean IsExtraLicenseOption = null;
/**
* The period of notice for the license in days.
*/
@ApiMember(Description="The period of notice for the license in days.")
public Integer PeriodOfNoticeDays = null;
/**
* The license items for the license type
*/
@ApiMember(Description="The license items for the license type")
public ArrayList<LicenseItemsResponse> Items = null;
/**
* The license prices in each country for the license type
*/
@ApiMember(Description="The license prices in each country for the license type")
public ArrayList<LicensePrice> Prices = null;
public Integer getId() { return Id; }
public LicenseTypeQueryResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public LicenseTypeQueryResponse setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicenseTypeQueryResponse setDescription(String value) { this.Description = value; return this; }
public Boolean getIsExtraLicenseOption() { return IsExtraLicenseOption; }
public LicenseTypeQueryResponse setIsExtraLicenseOption(Boolean value) { this.IsExtraLicenseOption = value; return this; }
public Integer getPeriodOfNoticeDays() { return PeriodOfNoticeDays; }
public LicenseTypeQueryResponse setPeriodOfNoticeDays(Integer value) { this.PeriodOfNoticeDays = value; return this; }
public ArrayList<LicenseItemsResponse> getItems() { return Items; }
public LicenseTypeQueryResponse setItems(ArrayList<LicenseItemsResponse> value) { this.Items = value; return this; }
public ArrayList<LicensePrice> getPrices() { return Prices; }
public LicenseTypeQueryResponse setPrices(ArrayList<LicensePrice> value) { this.Prices = value; return this; }
}
public static class LicenseItemsResponse
{
public Integer Id = null;
public String Name = null;
public Integer AllowedItems = null;
public Integer getId() { return Id; }
public LicenseItemsResponse setId(Integer value) { this.Id = value; return this; }
public String getName() { return Name; }
public LicenseItemsResponse setName(String value) { this.Name = value; return this; }
public Integer getAllowedItems() { return AllowedItems; }
public LicenseItemsResponse setAllowedItems(Integer value) { this.AllowedItems = value; return this; }
}
@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; }
}
}
Java LicenseInformationQuery DTOs
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.
GET /licenses/information/ HTTP/1.1 Host: testapi.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfLicenseTypeQueryResponseWg5EthtI 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/BokaMera.API.ServiceModel.Dtos">
<d2p1:LicenseTypeQueryResponse>
<d2p1:Description>String</d2p1:Description>
<d2p1:Id>0</d2p1:Id>
<d2p1:IsExtraLicenseOption>false</d2p1:IsExtraLicenseOption>
<d2p1:Items>
<d2p1:LicenseItemsResponse>
<d2p1:AllowedItems>0</d2p1:AllowedItems>
<d2p1:Id>0</d2p1:Id>
<d2p1:Name>String</d2p1:Name>
</d2p1:LicenseItemsResponse>
</d2p1:Items>
<d2p1:Name>String</d2p1:Name>
<d2p1:PeriodOfNoticeDays>0</d2p1:PeriodOfNoticeDays>
<d2p1:Prices xmlns:d4p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d4p1:LicensePrice>
<d4p1:Country>
<d4p1:Culture>String</d4p1:Culture>
<d4p1:CurrencyId>String</d4p1:CurrencyId>
<d4p1:CurrencyInfo>
<d4p1:Active>false</d4p1:Active>
<d4p1:CurrencySign>String</d4p1:CurrencySign>
<d4p1:Id>String</d4p1:Id>
<d4p1:ModifiedDate xmlns:d8p1="http://schemas.datacontract.org/2004/07/System">
<d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
<d8p1:OffsetMinutes>0</d8p1:OffsetMinutes>
</d4p1:ModifiedDate>
<d4p1:Name>String</d4p1:Name>
</d4p1:CurrencyInfo>
<d4p1:Id>String</d4p1:Id>
<d4p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d4p1:ModifiedDate>
<d4p1:Name>String</d4p1:Name>
<d4p1:TimeZone>String</d4p1:TimeZone>
</d4p1:Country>
<d4p1:CountryId>String</d4p1:CountryId>
<d4p1:LicenseTypeId>0</d4p1:LicenseTypeId>
<d4p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
<d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
<d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
</d4p1:ModifiedDate>
<d4p1:Price>0</d4p1:Price>
</d4p1:LicensePrice>
</d2p1:Prices>
</d2p1:LicenseTypeQueryResponse>
</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>
</QueryResponseOfLicenseTypeQueryResponseWg5EthtI>