BokaMera.API.Host

CompanyLicenseQuery

**Requires Authentication**
Requires any of the roles:	bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read

The following routes are available for this service:
GET	/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 java.io.InputStream
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 CompanyLicenseQuery : 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.")
    open 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")
    open 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")
    open 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")
    open var MetaData:String? = null

    /**
    * Id of the license type
    */
    @ApiMember(Description="Id of the license type")
    open 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")
    open 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")
    open 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")
    open var IncludeLicensePrices:Boolean? = null

    open 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)
    open 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)
    open 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)
    open 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)
    open 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)
    open var Include:String? = null

    @DataMember(Order=6)
    open var Fields:String? = null

    @DataMember(Order=7)
    open var Meta:HashMap<String,String>? = null
}

open class License : BaseModel()
{
    open var Type:LicenseType? = null
    @Required()
    open var CompanyId:UUID? = null

    open var Id:Int? = null
    @Required()
    open var TypeId:Int? = null

    @Required()
    open var ValidFrom:Date? = null

    @Required()
    open var ValidTo:Date? = null

    @Required()
    open var Active:Boolean? = null

    @Required()
    open var Updated:Date? = null

    @Required()
    open var Created:Date? = null

    open var ModifiedDate:Date? = null
    open var MetaData:String? = null
}

open class BaseModel
{
}

open class LicenseType : BaseModel()
{
    @Ignore()
    open var LicenseItems:IList<LicenseTypeItem>? = null

    @Ignore()
    open var Prices:IList<LicensePrice>? = null

    @Ignore()
    open var IsFree:Boolean? = null

    @Ignore()
    open var PeriodOfNoticeDays:Int? = null

    @Ignore()
    open var NextLicenseOption:LicenseType? = null

    @Required()
    open var Name:String? = null

    @Required()
    open var Description:String? = null

    @Required()
    open var ExtraLicenseOption:Boolean? = null

    open var ModifiedDate:Date? = null
    open var Active:Boolean? = null
    open var Id:Int? = null
}

open class LicenseTypeItem : BaseModel()
{
    @Ignore()
    open var Name:String? = null

    @Ignore()
    open var LicenseType:LicenseType? = null

    @Required()
    open var LicenseTypesId:Int? = null

    @Required()
    open var LicenseItemsId:Int? = null

    @Required()
    open var NumberOfItems:Int? = null

    open var Id:Int? = null
    open var ModifiedDate:Date? = null
}

open class LicensePrice : BaseModel()
{
    @Ignore()
    open var Country:Country? = null

    @Ignore()
    open var MonthlyPayment:Boolean? = null

    @Required()
    open var LicenseTypeId:Int? = null

    @Required()
    open var CountryId:String? = null

    @Required()
    open var Price:Int? = null

    open var ModifiedDate:Date? = null
}

open class Country : BaseModel()
{
    @References(Type=Currency::class)
    open var CurrencyId:String? = null

    open var CurrencyInfo:Currency? = null
    @Required()
    open var Name:String? = null

    open var Culture:String? = null
    open var TimeZone:String? = null
    open var ModifiedDate:Date? = null
    @Required()
    open var Id:String? = null
}

open class Currency : BaseModel()
{
    @Required()
    open var Name:String? = null

    @Required()
    open var CurrencySign:String? = null

    @Required()
    open var Active:Boolean? = null

    open var ModifiedDate:Date? = null
    @Required()
    open var Id:String? = null
}

open class CompanyLicenseQueryResponse
{
    open var Id:Int? = null
    open var TypeId:Int? = null
    open var Type:LicenseTypeQueryResponse? = null
    open var ValidFrom:Date? = null
    open var ValidTo:Date? = null
    open var MetaData:String? = null
    open var Active:Boolean? = null
    open var Canceled:Boolean? = null
    open var Updated:Date? = null
    open var Created:Date? = null
}

open class LicenseTypeQueryResponse
{
    /**
    * The license type id
    */
    @ApiMember(Description="The license type id")
    open var Id:Int? = null

    /**
    * The license type name
    */
    @ApiMember(Description="The license type name")
    open var Name:String? = null

    /**
    * The license type description
    */
    @ApiMember(Description="The license type description")
    open var Description:String? = null

    /**
    * If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.
    */
    @ApiMember(Description="If the license type is not a standard license but instead an extra license option. An example would be sending newsletter license.")
    open var IsExtraLicenseOption:Boolean? = null

    /**
    * The period of notice for the license in days.
    */
    @ApiMember(Description="The period of notice for the license in days.")
    open var PeriodOfNoticeDays:Int? = null

    /**
    * The license items for the license type
    */
    @ApiMember(Description="The license items for the license type")
    open 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")
    open var Prices:ArrayList<LicensePrice> = ArrayList<LicensePrice>()
}

open class LicenseItemsResponse
{
    open var Id:Int? = null
    open var Name:String? = null
    open var AllowedItems:Int? = null
}

@DataContract
open class QueryResponse<T>
{
    @DataMember(Order=1)
    open var Offset:Int? = null

    @DataMember(Order=2)
    open var Total:Int? = null

    @DataMember(Order=3)
    open var Results:ArrayList<AccessKeyTypeResponse>? = null

    @DataMember(Order=4)
    open var Meta:HashMap<String,String>? = null

    @DataMember(Order=5)
    open var ResponseStatus:ResponseStatus? = null
}

open class AccessKeyTypeResponse
{
    open var Id:Int? = null
    open var KeyType:String? = null
    open var Description:String? = null
}

Kotlin CompanyLicenseQuery DTOs

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

HTTP + XML

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

GET /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>