| 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.*
@ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@ValidateRequest(Validator="IsAuthenticated")
open class SuperAdminCompanyLicenseQuery : 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.")
var CompanyId:UUID? = 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")
var OnlyActiveLicenses:Boolean? = null
/**
* What country you want to list the prices for
*/
@ApiMember(DataType="string", Description="What country you want to list the prices for")
var CountryId:String? = null
/**
* Search by the Meta data information on the license
*/
@ApiMember(DataType="string", Description="Search by the Meta data information on the license")
var MetaData:String? = null
/**
* Id of the license type
*/
@ApiMember(Description="Id of the license type")
var TypeId:Int? = 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")
var IsExtraLicenseOption:Boolean? = 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")
var IncludeLicenseItems:Boolean? = 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")
var IncludeLicensePrices:Boolean? = null
var ResponseStatus:ResponseStatus? = null
}
open class QueryDb<From, Into> : QueryBase()
{
}
@DataContract
open 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)
var Skip:Int? = 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)
var Take:Int? = 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)
var OrderBy:String? = 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)
var OrderByDesc:String? = 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)
var Include:String? = null
@DataMember(Order=6)
var Fields:String? = null
@DataMember(Order=7)
var Meta:HashMap<String,String> = HashMap<String,String>()
}
open class License : BaseModel()
{
var Type:LicenseType? = null
@Required()
var CompanyId:UUID? = null
var Id:Int? = null
@Required()
var TypeId:Int? = null
@Required()
var ValidFrom:Date? = null
@Required()
var ValidTo:Date? = null
@Required()
var Active:Boolean? = null
@Required()
var Updated:Date? = null
@Required()
var Created:Date? = null
var ModifiedDate:Date? = null
var MetaData:String? = null
}
open class BaseModel
{
}
open class LicenseType : BaseModel()
{
@Ignore()
var LicenseItems:IList<LicenseTypeItem>? = null
@Ignore()
var Prices:IList<LicensePrice>? = null
@Ignore()
var PeriodOfNoticeDays:Int? = null
@Ignore()
var NextLicenseOption:LicenseType? = null
@Required()
var Name:String? = null
@Required()
var Description:String? = null
@Required()
var ExtraLicenseOption:Boolean? = null
var ModifiedDate:Date? = null
var Active:Boolean? = null
var Id:Int? = null
}
open class LicenseTypeItem : BaseModel()
{
@Ignore()
var Name:String? = null
@Ignore()
var LicenseType:LicenseType? = null
@Required()
var LicenseTypesId:Int? = null
@Required()
var LicenseItemsId:Int? = null
@Required()
var NumberOfItems:Int? = null
var Id:Int? = null
var ModifiedDate:Date? = null
}
open class LicensePrice : BaseModel()
{
@Ignore()
var Country:Country? = null
@Ignore()
var MonthlyPayment:Boolean? = null
@Required()
var LicenseTypeId:Int? = null
@Required()
var CountryId:String? = null
@Required()
var Price:Int? = null
var ModifiedDate:Date? = null
}
open class Country : BaseModel()
{
@References(Currency.class)
var CurrencyId:String? = null
var CurrencyInfo:Currency? = null
@Required()
var Name:String? = null
var Culture:String? = null
var TimeZone:String? = null
var ModifiedDate:Date? = null
@Required()
var Id:String? = null
}
open class Currency : BaseModel()
{
@Required()
var Name:String? = null
@Required()
var CurrencySign:String? = null
@Required()
var Active:Boolean? = null
var ModifiedDate:Date? = null
@Required()
var Id:String? = null
}
open class CompanyLicenseQueryResponse
{
var Id:Int? = null
var TypeId:Int? = null
var Type:LicenseTypeQueryResponse? = null
var ValidFrom:Date? = null
var ValidTo:Date? = null
var MetaData:String? = null
var Active:Boolean? = null
var Canceled:Boolean? = null
var Updated:Date? = null
var Created:Date? = null
}
open class LicenseTypeQueryResponse
{
/**
* The license type id
*/
@ApiMember(Description="The license type id")
var Id:Int? = null
/**
* The license type name
*/
@ApiMember(Description="The license type name")
var Name:String? = null
/**
* The license type description
*/
@ApiMember(Description="The license type description")
var Description:String? = 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.")
var IsExtraLicenseOption:Boolean? = null
/**
* The period of notice for the license in days.
*/
@ApiMember(Description="The period of notice for the license in days.")
var PeriodOfNoticeDays:Int? = null
/**
* The license items for the license type
*/
@ApiMember(Description="The license items for the license type")
var Items:ArrayList<LicenseItemsResponse> = ArrayList<LicenseItemsResponse>()
/**
* The license prices in each country for the license type
*/
@ApiMember(Description="The license prices in each country for the license type")
var Prices:ArrayList<LicensePrice> = ArrayList<LicensePrice>()
}
open class LicenseItemsResponse
{
var Id:Int? = null
var Name:String? = null
var AllowedItems:Int? = null
}
@DataContract
open class QueryResponse<AccessKeyTypeResponse>
{
@DataMember(Order=1)
var Offset:Int? = null
@DataMember(Order=2)
var Total:Int? = null
@DataMember(Order=3)
var Results:ArrayList<AccessKeyTypeResponse> = ArrayList<AccessKeyTypeResponse>()
@DataMember(Order=4)
var Meta:HashMap<String,String> = HashMap<String,String>()
@DataMember(Order=5)
var ResponseStatus:ResponseStatus? = null
}
open class AccessKeyTypeResponse
{
var Id:Int? = null
var KeyType:String? = null
var Description:String? = null
}
Kotlin SuperAdminCompanyLicenseQuery 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 /superadmin/licenses/company HTTP/1.1 Host: api.bokamera.se Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfCompanyLicenseQueryResponseWg5EthtI 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:CompanyLicenseQueryResponse>
<d2p1:Active>false</d2p1:Active>
<d2p1:Canceled>false</d2p1:Canceled>
<d2p1:Created>0001-01-01T00:00:00</d2p1:Created>
<d2p1:Id>0</d2p1:Id>
<d2p1:MetaData>String</d2p1:MetaData>
<d2p1:Type>
<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:d5p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
<d5p1:LicensePrice>
<d5p1:Country>
<d5p1:Culture>String</d5p1:Culture>
<d5p1:CurrencyId>String</d5p1:CurrencyId>
<d5p1:CurrencyInfo>
<d5p1:Active>false</d5p1:Active>
<d5p1:CurrencySign>String</d5p1:CurrencySign>
<d5p1:Id>String</d5p1:Id>
<d5p1:ModifiedDate xmlns:d9p1="http://schemas.datacontract.org/2004/07/System">
<d9p1:DateTime>0001-01-01T00:00:00Z</d9p1:DateTime>
<d9p1:OffsetMinutes>0</d9p1:OffsetMinutes>
</d5p1:ModifiedDate>
<d5p1:Name>String</d5p1:Name>
</d5p1:CurrencyInfo>
<d5p1:Id>String</d5p1:Id>
<d5p1:ModifiedDate xmlns:d8p1="http://schemas.datacontract.org/2004/07/System">
<d8p1:DateTime>0001-01-01T00:00:00Z</d8p1:DateTime>
<d8p1:OffsetMinutes>0</d8p1:OffsetMinutes>
</d5p1:ModifiedDate>
<d5p1:Name>String</d5p1:Name>
<d5p1:TimeZone>String</d5p1:TimeZone>
</d5p1:Country>
<d5p1:CountryId>String</d5p1:CountryId>
<d5p1:LicenseTypeId>0</d5p1:LicenseTypeId>
<d5p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
<d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
<d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
</d5p1:ModifiedDate>
<d5p1:Price>0</d5p1:Price>
</d5p1:LicensePrice>
</d2p1:Prices>
</d2p1:Type>
<d2p1:TypeId>0</d2p1:TypeId>
<d2p1:Updated>0001-01-01T00:00:00</d2p1:Updated>
<d2p1:ValidFrom>0001-01-01T00:00:00</d2p1:ValidFrom>
<d2p1:ValidTo>0001-01-01T00:00:00</d2p1:ValidTo>
</d2p1:CompanyLicenseQueryResponse>
</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>
</QueryResponseOfCompanyLicenseQueryResponseWg5EthtI>