| Requires any of the roles: | bookingsupplier-administrator-write, superadmin, bookingsupplier-administrator-read |
| GET | /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; }
}
[ApiResponse(Description="You were unauthorized to call this service", StatusCode=401)]
[ValidateRequest("IsAuthenticated")]
public partial class CompanyLicenseQuery
: 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; }
}
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; }
}
}
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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
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: testapi.bokamera.se Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"Offset":0,"Total":0,"Results":[{"Id":0,"TypeId":0,"Type":{"Id":0,"Name":"String","Description":"String","IsExtraLicenseOption":false,"PeriodOfNoticeDays":0,"Items":[{"Id":0,"Name":"String","AllowedItems":0}],"Prices":[{"Country":{"CurrencyId":"String","CurrencyInfo":{"Name":"String","CurrencySign":"String","Active":false,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"Name":"String","Culture":"String","TimeZone":"String","ModifiedDate":"0001-01-01T00:00:00.0000000+00:00","Id":"String"},"MonthlyPayment":true,"LicenseTypeId":0,"CountryId":"String","Price":0,"ModifiedDate":"0001-01-01T00:00:00.0000000+00:00"}]},"MetaData":"String","Active":false,"Canceled":false}],"Meta":{"String":"String"},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}