BokaMera.API.Host

SuperAdminCompanyLicenseQuery

**Requires Authentication**
Requires the role:	superadmin

The following routes are available for this service:
GET	/superadmin/licenses/company	Find licenses for the logged in users company	Find licenses for the logged in users company.

using System;
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 License
        : BaseModel
    {
        public virtual LicenseType Type { get; set; }
        [Required]
        public virtual Guid CompanyId { get; set; }

        public virtual int Id { get; set; }
        [Required]
        public virtual int TypeId { get; set; }

        [Required]
        public virtual DateTime ValidFrom { get; set; }

        [Required]
        public virtual DateTime ValidTo { get; set; }

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

        [Required]
        public virtual DateTime Updated { get; set; }

        [Required]
        public virtual DateTime Created { get; set; }

        public virtual DateTimeOffset? ModifiedDate { get; set; }
        public virtual string MetaData { get; set; }
    }

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

        [Ignore]
        public virtual bool MonthlyPayment { 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 partial class LicenseType
        : BaseModel
    {
        [Ignore]
        public virtual IList<LicenseTypeItem> LicenseItems { get; set; }

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

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

        [Ignore]
        public virtual LicenseType 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 int Id { get; set; }
    }

    public partial class LicenseTypeItem
        : BaseModel
    {
        [Ignore]
        public virtual string Name { 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; }
    }

}

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 CompanyLicenseQueryResponse
    {
        public virtual int Id { get; set; }
        public virtual int TypeId { get; set; }
        public virtual LicenseTypeQueryResponse Type { get; set; }
        public virtual DateTime ValidFrom { get; set; }
        public virtual DateTime ValidTo { get; set; }
        public virtual string MetaData { get; set; }
        public virtual bool Active { get; set; }
        public virtual bool Canceled { get; set; }
        public virtual DateTime Updated { get; set; }
        public virtual DateTime Created { get; set; }
    }

    public partial class LicenseItemsResponse
    {
        public virtual int Id { get; set; }
        public virtual string Name { get; set; }
        public virtual int AllowedItems { get; set; }
    }

    public partial class LicenseTypeQueryResponse
    {
        public LicenseTypeQueryResponse()
        {
            Items = new List<LicenseItemsResponse>{};
            Prices = new List<LicensePrice>{};
        }

        ///<summary>
        ///The license type id
        ///</summary>
        [ApiMember(Description="The license type id")]
        public virtual int Id { get; set; }

        ///<summary>
        ///The license type name
        ///</summary>
        [ApiMember(Description="The license type name")]
        public virtual string Name { get; set; }

        ///<summary>
        ///The license type description
        ///</summary>
        [ApiMember(Description="The license type description")]
        public virtual string Description { get; set; }

        ///<summary>
        ///If the license type is not a standard license but instead an extra license option. An example would be sending new letter license.
        ///</summary>
        [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.")]
        public virtual bool IsExtraLicenseOption { get; set; }

        ///<summary>
        ///The period of notice for the license in days.
        ///</summary>
        [ApiMember(Description="The period of notice for the license in days.")]
        public virtual int PeriodOfNoticeDays { get; set; }

        ///<summary>
        ///The license items for the license type
        ///</summary>
        [ApiMember(Description="The license items for the license type")]
        public virtual List<LicenseItemsResponse> Items { get; set; }

        ///<summary>
        ///The license prices in each country for the license type
        ///</summary>
        [ApiMember(Description="The license prices in each country for the license type")]
        public virtual List<LicensePrice> Prices { get; set; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class SuperAdminCompanyLicenseQuery
        : QueryDb<License, CompanyLicenseQueryResponse>
    {
        ///<summary>
        ///The company id, if empty will use the company id for the user you are logged in with.
        ///</summary>
        [ApiMember(Description="The company id, if empty will use the company id for the user you are logged in with.")]
        public virtual Guid? CompanyId { 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 OnlyActiveLicenses { 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>
        ///Search by the Meta data information on the license
        ///</summary>
        [ApiMember(DataType="string", Description="Search by the Meta data information on the license")]
        public virtual string MetaData { get; set; }

        ///<summary>
        ///Id of the license type
        ///</summary>
        [ApiMember(Description="Id of the license type")]
        public virtual int? TypeId { get; set; }

        ///<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? IsExtraLicenseOption { 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 licens prices
        ///</summary>
        [ApiMember(DataType="boolean", Description="If you want to include the connected licens prices", ParameterType="query")]
        public virtual bool IncludeLicensePrices { get; set; }

        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

namespace ServiceStack
{
    [DataContract]
    public partial class QueryBase
    {
        public QueryBase()
        {
            Meta = new Dictionary<string, string>{};
        }

        ///<summary>
        ///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>
        ///</summary>
        [DataMember(Order=1)]
        public virtual int? Skip { get; set; }

        ///<summary>
        ///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>
        ///</summary>
        [DataMember(Order=2)]
        public virtual int? Take { get; set; }

        ///<summary>
        ///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>
        ///</summary>
        [DataMember(Order=3)]
        public virtual string OrderBy { get; set; }

        ///<summary>
        ///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>
        ///</summary>
        [DataMember(Order=4)]
        public virtual string OrderByDesc { get; set; }

        ///<summary>
        ///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>
        ///</summary>
        [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<AccessKeyTypeResponse>
    {
        public QueryResponse()
        {
            Results = new List<AccessKeyTypeResponse>{};
            Meta = new Dictionary<string, string>{};
        }

        [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# SuperAdminCompanyLicenseQuery 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 /superadmin/licenses/company HTTP/1.1 
Host: testapi.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>