| Requires any of the roles: | bookingsupplier-administrator-write, superadmin |
| 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; }
}
}
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CompanyId: 00000000-0000-0000-0000-000000000000,
TypeId: 0,
MetaData: String,
BillingInformation:
{
BillingMethodId: 0,
Name: String,
Attention: String,
Street1: String,
Street2: String,
ZipCode: String,
City: String,
CountryId: String,
Email: String,
GLN: String,
ReferenceLine1: String,
ReferenceLine2: String,
PaymentTermsDays: 0,
VatRegistrationNumber: String,
BillingMethodOptions:
[
{
BillingMethodCountriesRelation:
[
{
BillingMethodId: 0,
CountryId: String,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00
}
],
Name: String,
Description: String,
ModifiedDate: 0001-01-01T00:00:00.0000000+00:00,
Id: 0
}
]
}
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
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
}