| Requires the role: | superadmin |
| GET | /superadmin/licenses/company | Find licenses for the logged in users company | Find licenses for the logged in users company. |
|---|
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)
@ValidateRequest(Validator="IsAuthenticated")
public static class SuperAdminCompanyLicenseQuery extends QueryDb<License, CompanyLicenseQueryResponse>
{
/**
* The company id, if empty will use the company id for the user you are logged in with.
*/
@ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")
public UUID CompanyId = null;
/**
* If you want to include the connected license items
*/
@ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
public Boolean OnlyActiveLicenses = null;
/**
* What country you want to list the prices for
*/
@ApiMember(DataType="string", Description="What country you want to list the prices for")
public String CountryId = null;
/**
* Search by the Meta data information on the license
*/
@ApiMember(DataType="string", Description="Search by the Meta data information on the license")
public String MetaData = null;
/**
* Id of the license type
*/
@ApiMember(Description="Id of the license type")
public Integer TypeId = null;
/**
* If you want to only select Extra license options
*/
@ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")
public Boolean IsExtraLicenseOption = null;
/**
* If you want to include the connected license items
*/
@ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
public Boolean IncludeLicenseItems = null;
/**
* If you want to include the connected licens prices
*/
@ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")
public Boolean IncludeLicensePrices = null;
public ResponseStatus ResponseStatus = null;
public UUID getCompanyId() { return CompanyId; }
public SuperAdminCompanyLicenseQuery setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Boolean isOnlyActiveLicenses() { return OnlyActiveLicenses; }
public SuperAdminCompanyLicenseQuery setOnlyActiveLicenses(Boolean value) { this.OnlyActiveLicenses = value; return this; }
public String getCountryId() { return CountryId; }
public SuperAdminCompanyLicenseQuery setCountryId(String value) { this.CountryId = value; return this; }
public String getMetaData() { return MetaData; }
public SuperAdminCompanyLicenseQuery setMetaData(String value) { this.MetaData = value; return this; }
public Integer getTypeId() { return TypeId; }
public SuperAdminCompanyLicenseQuery setTypeId(Integer value) { this.TypeId = value; return this; }
public Boolean getIsExtraLicenseOption() { return IsExtraLicenseOption; }
public SuperAdminCompanyLicenseQuery setIsExtraLicenseOption(Boolean value) { this.IsExtraLicenseOption = value; return this; }
public Boolean isIncludeLicenseItems() { return IncludeLicenseItems; }
public SuperAdminCompanyLicenseQuery setIncludeLicenseItems(Boolean value) { this.IncludeLicenseItems = value; return this; }
public Boolean isIncludeLicensePrices() { return IncludeLicensePrices; }
public SuperAdminCompanyLicenseQuery setIncludeLicensePrices(Boolean value) { this.IncludeLicensePrices = value; return this; }
public ResponseStatus getResponseStatus() { return ResponseStatus; }
public SuperAdminCompanyLicenseQuery 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 License extends BaseModel
{
public LicenseType Type = null;
@Required()
public UUID CompanyId = null;
public Integer Id = null;
@Required()
public Integer TypeId = null;
@Required()
public Date ValidFrom = null;
@Required()
public Date ValidTo = null;
@Required()
public Boolean Active = null;
@Required()
public Date Updated = null;
@Required()
public Date Created = null;
public Date ModifiedDate = null;
public String MetaData = null;
public LicenseType getType() { return Type; }
public License setType(LicenseType value) { this.Type = value; return this; }
public UUID getCompanyId() { return CompanyId; }
public License setCompanyId(UUID value) { this.CompanyId = value; return this; }
public Integer getId() { return Id; }
public License setId(Integer value) { this.Id = value; return this; }
public Integer getTypeId() { return TypeId; }
public License setTypeId(Integer value) { this.TypeId = value; return this; }
public Date getValidFrom() { return ValidFrom; }
public License setValidFrom(Date value) { this.ValidFrom = value; return this; }
public Date getValidTo() { return ValidTo; }
public License setValidTo(Date value) { this.ValidTo = value; return this; }
public Boolean isActive() { return Active; }
public License setActive(Boolean value) { this.Active = value; return this; }
public Date getUpdated() { return Updated; }
public License setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public License setCreated(Date value) { this.Created = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public License setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public String getMetaData() { return MetaData; }
public License setMetaData(String value) { this.MetaData = value; return this; }
}
public static class BaseModel
{
}
public static class LicenseType extends BaseModel
{
@Ignore()
public IList<LicenseTypeItem> LicenseItems = null;
@Ignore()
public IList<LicensePrice> Prices = null;
@Ignore()
public Integer PeriodOfNoticeDays = null;
@Ignore()
public LicenseType NextLicenseOption = null;
@Required()
public String Name = null;
@Required()
public String Description = null;
@Required()
public Boolean ExtraLicenseOption = null;
public Date ModifiedDate = null;
public Integer Id = null;
public IList<LicenseTypeItem> getLicenseItems() { return LicenseItems; }
public LicenseType setLicenseItems(IList<LicenseTypeItem> value) { this.LicenseItems = value; return this; }
public IList<LicensePrice> getPrices() { return Prices; }
public LicenseType setPrices(IList<LicensePrice> value) { this.Prices = value; return this; }
public Integer getPeriodOfNoticeDays() { return PeriodOfNoticeDays; }
public LicenseType setPeriodOfNoticeDays(Integer value) { this.PeriodOfNoticeDays = value; return this; }
public LicenseType getNextLicenseOption() { return NextLicenseOption; }
public LicenseType setNextLicenseOption(LicenseType value) { this.NextLicenseOption = value; return this; }
public String getName() { return Name; }
public LicenseType setName(String value) { this.Name = value; return this; }
public String getDescription() { return Description; }
public LicenseType setDescription(String value) { this.Description = value; return this; }
public Boolean isExtraLicenseOption() { return ExtraLicenseOption; }
public LicenseType setExtraLicenseOption(Boolean value) { this.ExtraLicenseOption = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public LicenseType setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
public Integer getId() { return Id; }
public LicenseType setId(Integer value) { this.Id = value; return this; }
}
public static class LicenseTypeItem extends BaseModel
{
@Ignore()
public String Name = null;
@Required()
public Integer LicenseTypesId = null;
@Required()
public Integer LicenseItemsId = null;
@Required()
public Integer NumberOfItems = null;
public Integer Id = null;
public Date ModifiedDate = null;
public String getName() { return Name; }
public LicenseTypeItem setName(String value) { this.Name = value; return this; }
public Integer getLicenseTypesId() { return LicenseTypesId; }
public LicenseTypeItem setLicenseTypesId(Integer value) { this.LicenseTypesId = value; return this; }
public Integer getLicenseItemsId() { return LicenseItemsId; }
public LicenseTypeItem setLicenseItemsId(Integer value) { this.LicenseItemsId = value; return this; }
public Integer getNumberOfItems() { return NumberOfItems; }
public LicenseTypeItem setNumberOfItems(Integer value) { this.NumberOfItems = value; return this; }
public Integer getId() { return Id; }
public LicenseTypeItem setId(Integer value) { this.Id = value; return this; }
public Date getModifiedDate() { return ModifiedDate; }
public LicenseTypeItem setModifiedDate(Date value) { this.ModifiedDate = value; return this; }
}
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 CompanyLicenseQueryResponse
{
public Integer Id = null;
public Integer TypeId = null;
public LicenseTypeQueryResponse Type = null;
public Date ValidFrom = null;
public Date ValidTo = null;
public String MetaData = null;
public Boolean Active = null;
public Boolean Canceled = null;
public Date Updated = null;
public Date Created = null;
public Integer getId() { return Id; }
public CompanyLicenseQueryResponse setId(Integer value) { this.Id = value; return this; }
public Integer getTypeId() { return TypeId; }
public CompanyLicenseQueryResponse setTypeId(Integer value) { this.TypeId = value; return this; }
public LicenseTypeQueryResponse getType() { return Type; }
public CompanyLicenseQueryResponse setType(LicenseTypeQueryResponse value) { this.Type = value; return this; }
public Date getValidFrom() { return ValidFrom; }
public CompanyLicenseQueryResponse setValidFrom(Date value) { this.ValidFrom = value; return this; }
public Date getValidTo() { return ValidTo; }
public CompanyLicenseQueryResponse setValidTo(Date value) { this.ValidTo = value; return this; }
public String getMetaData() { return MetaData; }
public CompanyLicenseQueryResponse setMetaData(String value) { this.MetaData = value; return this; }
public Boolean isActive() { return Active; }
public CompanyLicenseQueryResponse setActive(Boolean value) { this.Active = value; return this; }
public Boolean isCanceled() { return Canceled; }
public CompanyLicenseQueryResponse setCanceled(Boolean value) { this.Canceled = value; return this; }
public Date getUpdated() { return Updated; }
public CompanyLicenseQueryResponse setUpdated(Date value) { this.Updated = value; return this; }
public Date getCreated() { return Created; }
public CompanyLicenseQueryResponse setCreated(Date value) { this.Created = 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 SuperAdminCompanyLicenseQuery DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /superadmin/licenses/company HTTP/1.1 Host: testapi.bokamera.se Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Offset: 0,
Total: 0,
Results:
[
{
Id: 0,
TypeId: 0,
Type:
{
Id: 0,
Name: String,
Description: String,
IsExtraLicenseOption: False,
PeriodOfNoticeDays: 0,
Items:
[
{
Id: 0,
Name: String,
AllowedItems: 0
}
],
Prices:
[
{
Country:
{
CurrencyId: String,
CurrencyInfo:
{
Name: String,
CurrencySign: String,
Active: False,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
Id: String
},
Name: String,
Culture: String,
TimeZone: String,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
Id: String
},
MonthlyPayment: True,
LicenseTypeId: 0,
CountryId: String,
Price: 0,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
}
]
},
MetaData: String,
Active: False,
Canceled: False
}
],
Meta:
{
String: String
},
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}