BokaMera.API.Host

<back to all web services

LicenseTypeQuery

The following routes are available for this service:
GET/licenses/types/Get all license typesThis service is used to get get all license types that exists.
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)
open class LicenseTypeQuery : QueryDb<LicenseType, LicenseInformationQueryResponse>()
{
    /**
    * 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 ExtraLicenseOption: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

    /**
    * 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
    var Active:Boolean? = 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 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 BaseModel
{
}

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 LicenseInformationQueryResponse
{
    var Name:String? = null
    var Description:String? = null
    var Url:Uri? = null
    var FreeEdition:Boolean? = null
    var StartEdition:Boolean? = null
    var ProEdition:Boolean? = null
    var SmartEdition:Boolean? = null
    var EnterpriseEdition:Boolean? = null
    var FreeEditionValue:String? = null
    var StartEditionValue:String? = null
    var ProEditionValue:String? = null
    var SmartEditionValue:String? = null
    var EnterpriseEditionValue:String? = null
    var LicenseInformationTypeId: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 LicenseTypeQuery DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /licenses/types/ HTTP/1.1 
Host: api.bokamera.se 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length

{"Offset":0,"Total":0,"Results":[{"Name":"String","Description":"String","FreeEdition":false,"StartEdition":false,"ProEdition":false,"SmartEdition":false,"EnterpriseEdition":false,"FreeEditionValue":"String","StartEditionValue":"String","ProEditionValue":"String","SmartEditionValue":"String","EnterpriseEditionValue":"String","LicenseInformationTypeId":0}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}