BokaMera.API.Host

LicenseTypeQuery

The following routes are available for this service:
GET	/licenses/types/	Get all license types	This service is used to get get all license types that exists.

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    """
    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>
    """

    take: Optional[int] = None
    """
    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>
    """

    order_by: Optional[str] = None
    """
    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>
    """

    order_by_desc: Optional[str] = None
    """
    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>
    """

    include: Optional[str] = None
    """
    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>
    """

    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


From = TypeVar('From')
Into = TypeVar('Into')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryDb2(Generic[From, Into], QueryBase, IReturn[QueryResponse[Into]]):
    @staticmethod
    def response_type(): return QueryResponse[Into]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseInformationQueryResponse:
    name: Optional[str] = None
    description: Optional[str] = None
    url: Optional[str] = None
    free_edition: bool = False
    start_edition: bool = False
    pro_edition: bool = False
    smart_edition: bool = False
    enterprise_edition: bool = False
    free_edition_value: Optional[str] = None
    start_edition_value: Optional[str] = None
    pro_edition_value: Optional[str] = None
    smart_edition_value: Optional[str] = None
    enterprise_edition_value: Optional[str] = None
    license_information_type_id: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class BaseModel:
    pass


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseTypeItem(BaseModel):
    # @Ignore()
    name: Optional[str] = None

    # @Ignore()
    license_type: Optional[LicenseType] = None

    # @Required()
    license_types_id: int = 0

    # @Required()
    license_items_id: int = 0

    # @Required()
    number_of_items: int = 0

    id: int = 0
    modified_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Currency(BaseModel):
    # @Required()
    name: Optional[str] = None

    # @Required()
    currency_sign: Optional[str] = None

    # @Required()
    active: bool = False

    modified_date: Optional[datetime.datetime] = None
    # @Required()
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Country(BaseModel):
    # @References(typeof(Currency))
    currency_id: Optional[str] = None

    currency_info: Optional[Currency] = None
    # @Required()
    name: Optional[str] = None

    culture: Optional[str] = None
    time_zone: Optional[str] = None
    modified_date: Optional[datetime.datetime] = None
    # @Required()
    id: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicensePrice(BaseModel):
    # @Ignore()
    country: Optional[Country] = None

    # @Ignore()
    monthly_payment: bool = False

    # @Required()
    license_type_id: int = 0

    # @Required()
    country_id: Optional[str] = None

    # @Required()
    price: int = 0

    modified_date: Optional[datetime.datetime] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseType(BaseModel):
    # @Ignore()
    license_items: Optional[IList[LicenseTypeItem]] = None

    # @Ignore()
    prices: Optional[IList[LicensePrice]] = None

    # @Ignore()
    period_of_notice_days: int = 0

    # @Ignore()
    next_license_option: Optional[LicenseType] = None

    # @Required()
    name: Optional[str] = None

    # @Required()
    description: Optional[str] = None

    # @Required()
    extra_license_option: bool = False

    modified_date: Optional[datetime.datetime] = None
    active: bool = False
    id: int = 0


# @ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class LicenseTypeQuery(QueryDb2[LicenseType, LicenseInformationQueryResponse]):
    # @ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")
    extra_license_option: Optional[bool] = None
    """
    If you want to only select Extra license options
    """


    # @ApiMember(DataType="string", Description="What country you want to list the prices for")
    country_id: Optional[str] = None
    """
    What country you want to list the prices for
    """


    # @ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")
    include_license_items: bool = False
    """
    If you want to include the connected license items
    """


    # @ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")
    include_license_prices: bool = False
    """
    If you want to include the connected licens prices
    """


    response_status: Optional[ResponseStatus] = None
    active: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class AccessKeyTypeResponse:
    id: int = 0
    key_type: Optional[str] = None
    description: Optional[str] = None


AccessKeyTypeResponse = TypeVar('AccessKeyTypeResponse')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[AccessKeyTypeResponse]):
    offset: int = 0
    total: int = 0
    results: Optional[List[AccessKeyTypeResponse]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python LicenseTypeQuery 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/types/ HTTP/1.1 
Host: testapi.bokamera.se 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<QueryResponseOfLicenseInformationQueryResponseWg5EthtI 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:LicenseInformationQueryResponse>
      <d2p1:Description>String</d2p1:Description>
      <d2p1:EnterpriseEdition>false</d2p1:EnterpriseEdition>
      <d2p1:EnterpriseEditionValue>String</d2p1:EnterpriseEditionValue>
      <d2p1:FreeEdition>false</d2p1:FreeEdition>
      <d2p1:FreeEditionValue>String</d2p1:FreeEditionValue>
      <d2p1:LicenseInformationTypeId>0</d2p1:LicenseInformationTypeId>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:ProEdition>false</d2p1:ProEdition>
      <d2p1:ProEditionValue>String</d2p1:ProEditionValue>
      <d2p1:SmartEdition>false</d2p1:SmartEdition>
      <d2p1:SmartEditionValue>String</d2p1:SmartEditionValue>
      <d2p1:StartEdition>false</d2p1:StartEdition>
      <d2p1:StartEditionValue>String</d2p1:StartEditionValue>
      <d2p1:Url i:nil="true" />
    </d2p1:LicenseInformationQueryResponse>
  </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>
</QueryResponseOfLicenseInformationQueryResponseWg5EthtI>