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.

using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using BokaMera.API.ServiceModel.Dtos;
using BokaMera.API.ServiceModel.Db;

namespace BokaMera.API.ServiceModel.Db
{
    public partial class BaseModel
    {
    }

    public partial class Country
        : BaseModel
    {
        [References(typeof(BokaMera.API.ServiceModel.Db.Currency))]
        public virtual string CurrencyId { get; set; }

        public virtual Currency CurrencyInfo { get; set; }
        [Required]
        public virtual string Name { get; set; }

        public virtual string? Culture { get; set; }
        public virtual string? TimeZone { get; set; }
        public virtual DateTimeOffset? ModifiedDate { get; set; }
        [Required]
        public virtual string Id { get; set; }
    }

    public partial class Currency
        : BaseModel
    {
        [Required]
        public virtual string Name { get; set; }

        [Required]
        public virtual string CurrencySign { get; set; }

        [Required]
        public virtual bool Active { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        [Required]
        public virtual string Id { get; set; }
    }

    public partial class LicensePrice
        : BaseModel
    {
        [Ignore]
        public virtual Country Country { get; set; }

        [Required]
        public virtual int LicenseTypeId { get; set; }

        [Required]
        public virtual string CountryId { get; set; }

        [Required]
        public virtual int Price { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        public virtual int LicensePlanId { get; set; }
    }

    public partial class LicenseTypeItem
        : BaseModel
    {
        [Ignore]
        public virtual string Name { get; set; }

        [Ignore]
        public virtual LicenseTypes LicenseType { get; set; }

        [Required]
        public virtual int LicenseTypesId { get; set; }

        [Required]
        public virtual int LicenseItemsId { get; set; }

        [Required]
        public virtual int NumberOfItems { get; set; }

        public virtual int Id { get; set; }
        public virtual DateTimeOffset? ModifiedDate { get; set; }
    }

    public partial class LicenseTypes
        : BaseModel
    {
        [Ignore]
        public virtual IList<LicenseTypeItem> LicenseItems { get; set; }

        [Ignore]
        public virtual IList<LicensePrice> Prices { get; set; }

        [Ignore]
        public virtual bool IsFree { get; set; }

        [Ignore]
        public virtual int PeriodOfNoticeDays { get; set; }

        [Ignore]
        public virtual LicenseTypes NextLicenseOption { get; set; }

        [Required]
        public virtual string Name { get; set; }

        [Required]
        public virtual string Description { get; set; }

        [Required]
        public virtual bool ExtraLicenseOption { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        public virtual bool Active { get; set; }
        public virtual Guid VossTierId { get; set; }
        public virtual int Id { get; set; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class AccessKeyTypeResponse
    {
        public virtual int Id { get; set; }
        public virtual string KeyType { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class LicenseInformationQueryResponse
    {
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual Uri Url { get; set; }
        public virtual bool FreeEdition { get; set; }
        public virtual bool StartEdition { get; set; }
        public virtual bool ProEdition { get; set; }
        public virtual bool SmartEdition { get; set; }
        public virtual bool EnterpriseEdition { get; set; }
        public virtual string FreeEditionValue { get; set; }
        public virtual string StartEditionValue { get; set; }
        public virtual string ProEditionValue { get; set; }
        public virtual string SmartEditionValue { get; set; }
        public virtual string EnterpriseEditionValue { get; set; }
        public virtual int LicenseInformationTypeId { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    public partial class LicenseTypeQuery
        : QueryDb<LicenseTypes, LicenseInformationQueryResponse>
    {
        ///<summary>
        ///If you want to only select Extra license options
        ///</summary>
        [ApiMember(DataType="boolean", Description="If you want to only select Extra license options", ParameterType="query")]
        public virtual bool? ExtraLicenseOption { get; set; }

        ///<summary>
        ///What country you want to list the prices for
        ///</summary>
        [ApiMember(DataType="string", Description="What country you want to list the prices for")]
        public virtual string CountryId { get; set; }

        ///<summary>
        ///If you want to include the connected license items
        ///</summary>
        [ApiMember(DataType="boolean", Description="If you want to include the connected license items", ParameterType="query")]
        public virtual bool IncludeLicenseItems { get; set; }

        ///<summary>
        ///If you want to include the connected license prices
        ///</summary>
        [ApiMember(DataType="boolean", Description="If you want to include the connected license prices", ParameterType="query")]
        public virtual bool IncludeLicensePrices { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        [DataMember(Order=3)]
        public virtual string? OrderBy { get; set; }

        [DataMember(Order=4)]
        public virtual string? OrderByDesc { get; set; }

        [DataMember(Order=5)]
        public virtual string? Include { get; set; }

        [DataMember(Order=6)]
        public virtual string? Fields { get; set; }

        [DataMember(Order=7)]
        public virtual Dictionary<string, string>? Meta { get; set; }
    }

    public partial class QueryDb<From, Into>
        : QueryBase
    {
    }

    [DataContract]
    public partial class QueryResponse<T>
    {
        [DataMember(Order=1)]
        public virtual int Offset { get; set; }

        [DataMember(Order=2)]
        public virtual int Total { get; set; }

        [DataMember(Order=3)]
        public virtual List<AccessKeyTypeResponse> Results { get; set; } = [];

        [DataMember(Order=4)]
        public virtual Dictionary<string, string>? Meta { get; set; }

        [DataMember(Order=5)]
        public virtual ResponseStatus? ResponseStatus { get; set; }
    }

}

C# 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: api-staging.bookmore.com 
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>