BokaMera.API.Host

CreateLicense

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

The following routes are available for this service:
POST	/licenses/company	Add new license to a company	Add a new license to the company for the logged in user.

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 BillingMethod
        : BaseModel
    {
        public BillingMethod()
        {
            BillingMethodCountriesRelation = new List<BillingMethodCountriesRelation>{};
        }

        public virtual List<BillingMethodCountriesRelation> BillingMethodCountriesRelation { get; set; }
        [Required]
        public virtual string Name { get; set; }

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

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

    public partial class BillingMethodCountriesRelation
        : BaseModel
    {
        [Required]
        public virtual int BillingMethodId { get; set; }

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

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

    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; }

        [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; }
    }

}

namespace BokaMera.API.ServiceModel.Dtos
{
    public partial class BillingInformationResponse
    {
        public BillingInformationResponse()
        {
            BillingMethodOptions = new List<BillingMethod>{};
        }

        ///<summary>
        ///The company id.
        ///</summary>
        [ApiMember(Description="The company id.")]
        public virtual Guid CompanyId { get; set; }

        ///<summary>
        ///The prefered billing method.
        ///</summary>
        [ApiMember(Description="The prefered billing method.", IsRequired=true)]
        public virtual int BillingMethodId { get; set; }

        ///<summary>
        ///The name that should be printed on the billing information, normally this would be your company name.
        ///</summary>
        [ApiMember(Description="The name that should be printed on the billing information, normally this would be your company name.")]
        public virtual string Name { get; set; }

        ///<summary>
        ///If you want to add the attention to the billing address.
        ///</summary>
        [ApiMember(Description="If you want to add the attention to the billing address.")]
        public virtual string Attention { get; set; }

        ///<summary>
        ///The street for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [ApiMember(Description="The street for the billing adress. This is required when having postal invoice as billing method.")]
        public virtual string Street1 { get; set; }

        ///<summary>
        ///The street for the billing adress.
        ///</summary>
        [ApiMember(Description="The street for the billing adress.")]
        public virtual string Street2 { get; set; }

        ///<summary>
        ///The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [ApiMember(Description="The zip code (postal code) for the billing adress. This is required when having postal invoice as billing method.")]
        public virtual string ZipCode { get; set; }

        ///<summary>
        ///The city for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [ApiMember(Description="The city for the billing adress. This is required when having postal invoice as billing method.")]
        public virtual string City { get; set; }

        ///<summary>
        ///The country for the billing adress. This is required when having postal invoice as billing method.
        ///</summary>
        [ApiMember(Description="The country for the billing adress. This is required when having postal invoice as billing method.")]
        public virtual string CountryId { get; set; }

        ///<summary>
        ///The billing email. This is required when having email invoice as billing method.
        ///</summary>
        [ApiMember(Description="The billing email. This is required when having email invoice as billing method.")]
        public virtual string Email { get; set; }

        ///<summary>
        ///The company global location number.
        ///</summary>
        [ApiMember(Description="The company global location number.")]
        public virtual string GLN { get; set; }

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [ApiMember(Description="You're internal rereference.")]
        public virtual string ReferenceLine1 { get; set; }

        ///<summary>
        ///You're internal rereference.
        ///</summary>
        [ApiMember(Description="You're internal rereference.")]
        public virtual string ReferenceLine2 { get; set; }

        ///<summary>
        ///The billing payment terms in days. This is default 15 days.
        ///</summary>
        [ApiMember(Description="The billing payment terms in days. This is default 15 days.")]
        public virtual int PaymentTermsDays { get; set; }

        ///<summary>
        ///The company vat registration number.
        ///</summary>
        [ApiMember(Description="The company vat registration number.")]
        public virtual string VatRegistrationNumber { get; set; }

        ///<summary>
        ///The billing method options to choose from
        ///</summary>
        [ApiMember(Description="The billing method options to choose from")]
        public virtual List<BillingMethod> BillingMethodOptions { 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; }
    }

    [ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
    [ValidateRequest("IsAuthenticated")]
    public partial class CreateLicense
        : ICompany
    {
        ///<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>
        ///Id of the license type
        ///</summary>
        [ApiMember(Description="Id of the license type", IsRequired=true)]
        public virtual int? TypeId { get; set; }

        ///<summary>
        ///Any metadata connected to the license. In example for domain license set the requested domain name here.
        ///</summary>
        [ApiMember(Description="Any metadata connected to the license. In example for domain license set the requested domain name here.", IsRequired=true)]
        public virtual string MetaData { get; set; }

        ///<summary>
        ///If you want to update your company billing information. Note, if no billing information is added before, you need to set this.
        ///</summary>
        [ApiMember(Description="If you want to update your company billing information. Note, if no billing information is added before, you need to set this.")]
        public virtual BillingInformationResponse BillingInformation { 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; }
    }

}

C# CreateLicense 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.

POST /licenses/company HTTP/1.1 
Host: api.bokamera.se 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CreateLicense xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <BillingInformation>
    <Attention>String</Attention>
    <BillingMethodId>0</BillingMethodId>
    <BillingMethodOptions xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
      <d3p1:BillingMethod>
        <d3p1:BillingMethodCountriesRelation>
          <d3p1:BillingMethodCountriesRelation>
            <d3p1:BillingMethodId>0</d3p1:BillingMethodId>
            <d3p1:CountryId>String</d3p1:CountryId>
            <d3p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
              <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
              <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
            </d3p1:ModifiedDate>
          </d3p1:BillingMethodCountriesRelation>
        </d3p1:BillingMethodCountriesRelation>
        <d3p1:Description>String</d3p1:Description>
        <d3p1:Id>0</d3p1:Id>
        <d3p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </d3p1:ModifiedDate>
        <d3p1:Name>String</d3p1:Name>
      </d3p1:BillingMethod>
    </BillingMethodOptions>
    <City>String</City>
    <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
    <CountryId>String</CountryId>
    <Email>String</Email>
    <GLN>String</GLN>
    <Name>String</Name>
    <PaymentTermsDays>0</PaymentTermsDays>
    <ReferenceLine1>String</ReferenceLine1>
    <ReferenceLine2>String</ReferenceLine2>
    <Street1>String</Street1>
    <Street2>String</Street2>
    <VatRegistrationNumber>String</VatRegistrationNumber>
    <ZipCode>String</ZipCode>
  </BillingInformation>
  <CompanyId>00000000-0000-0000-0000-000000000000</CompanyId>
  <MetaData>String</MetaData>
  <TypeId>0</TypeId>
</CreateLicense>

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

<CompanyLicenseQueryResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Dtos">
  <Active>false</Active>
  <Canceled>false</Canceled>
  <Created>0001-01-01T00:00:00</Created>
  <Id>0</Id>
  <MetaData>String</MetaData>
  <Type>
    <Description>String</Description>
    <Id>0</Id>
    <IsExtraLicenseOption>false</IsExtraLicenseOption>
    <Items>
      <LicenseItemsResponse>
        <AllowedItems>0</AllowedItems>
        <Id>0</Id>
        <Name>String</Name>
      </LicenseItemsResponse>
    </Items>
    <Name>String</Name>
    <PeriodOfNoticeDays>0</PeriodOfNoticeDays>
    <Prices xmlns:d3p1="http://schemas.datacontract.org/2004/07/BokaMera.API.ServiceModel.Db">
      <d3p1:LicensePrice>
        <d3p1:Country>
          <d3p1:Culture>String</d3p1:Culture>
          <d3p1:CurrencyId>String</d3p1:CurrencyId>
          <d3p1:CurrencyInfo>
            <d3p1:Active>false</d3p1:Active>
            <d3p1:CurrencySign>String</d3p1:CurrencySign>
            <d3p1:Id>String</d3p1:Id>
            <d3p1:ModifiedDate xmlns:d7p1="http://schemas.datacontract.org/2004/07/System">
              <d7p1:DateTime>0001-01-01T00:00:00Z</d7p1:DateTime>
              <d7p1:OffsetMinutes>0</d7p1:OffsetMinutes>
            </d3p1:ModifiedDate>
            <d3p1:Name>String</d3p1:Name>
          </d3p1:CurrencyInfo>
          <d3p1:Id>String</d3p1:Id>
          <d3p1:ModifiedDate xmlns:d6p1="http://schemas.datacontract.org/2004/07/System">
            <d6p1:DateTime>0001-01-01T00:00:00Z</d6p1:DateTime>
            <d6p1:OffsetMinutes>0</d6p1:OffsetMinutes>
          </d3p1:ModifiedDate>
          <d3p1:Name>String</d3p1:Name>
          <d3p1:TimeZone>String</d3p1:TimeZone>
        </d3p1:Country>
        <d3p1:CountryId>String</d3p1:CountryId>
        <d3p1:LicenseTypeId>0</d3p1:LicenseTypeId>
        <d3p1:ModifiedDate xmlns:d5p1="http://schemas.datacontract.org/2004/07/System">
          <d5p1:DateTime>0001-01-01T00:00:00Z</d5p1:DateTime>
          <d5p1:OffsetMinutes>0</d5p1:OffsetMinutes>
        </d3p1:ModifiedDate>
        <d3p1:Price>0</d3p1:Price>
      </d3p1:LicensePrice>
    </Prices>
  </Type>
  <TypeId>0</TypeId>
  <Updated>0001-01-01T00:00:00</Updated>
  <ValidFrom>0001-01-01T00:00:00</ValidFrom>
  <ValidTo>0001-01-01T00:00:00</ValidTo>
</CompanyLicenseQueryResponse>